Objeck Documentation

All Bundles

Bundle ODBC database access layer. Connection manages database sessions; Statement and ParameterStatement execute SQL queries; ResultSet iterates over rows and extracts typed column values. Compile with -lib odbc.

ResultSet

ODBC result set

Operations

Close
GetBigInt
GetBit
GetBlob
GetColumnInfo
GetDate
GetDouble
GetInt
GetLastError
GetReal
GetSmallInt
GetTimestamp
GetVarchar
IsNull
Next

Close #

Closes a result set

method : public : Close() ~ Nil

GetBigInt #

Gets a big integer value

method : public : GetBigInt(column:Int) ~ Int

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Int	big integer value

GetBigInt #

Gets a big integer value

method : public : GetBigInt(column:String) ~ Int

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Int	big integer value

GetBit #

Gets a bit value

method : public : GetBit(column:Int) ~ Bool

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Bool	bit value

GetBit #

Gets a bit value

method : public : GetBit(column:String) ~ Bool

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Bool	bit value

GetBlob #

Gets a blob value

method : public : GetBlob(column:Int, buffer:Byte[]) ~ Nil

Parameters

Name	Type	Description
column	Int	column ID
buffer	Byte	buffer to write into

GetBlob #

Gets a blob value

method : public : GetBlob(column:String, buffer:Byte[]) ~ Nil

Parameters

Name	Type	Description
column	String	column name
buffer	Byte	buffer to write into

GetColumnInfo #

Get the metadata for a given column

method : public : GetColumnInfo() ~ ColumnInfo[]

Return

Type	Description
ColumnInfo	column metadata

GetDate #

Gets a date value

method : public : GetDate(column:Int) ~ Database.ODBC.Date

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Date	date value

GetDate #

Gets a date value

method : public : GetDate(column:String) ~ Database.ODBC.Date

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Date	date value

GetDouble #

Gets a double value

method : public : GetDouble(column:Int) ~ Float

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Float	double value

GetDouble #

Gets a double value

method : public : GetDouble(column:String) ~ Float

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Float	double value

GetInt #

Gets an integer value

method : public : GetInt(column:Int) ~ Int

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Int	integer value

Example

conn := Database.ODBC.Connection->New("mydsn", "user", "pass");
rs := conn->Select("SELECT id, age FROM users");
while(rs->Next()) {
  age := rs->GetInt(2); # column 2 = age
  "age={$age}"->PrintLine();
};
rs->Close();
conn->Close();

GetInt #

Gets an integer value

method : public : GetInt(column:String) ~ Int

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Int	integer value

GetLastError #

Gets the last error message from the result set statement.

method : public : GetLastError() ~ String

Return

Type	Description
String	error message string, or empty if no error

GetReal #

Gets a real value

method : public : GetReal(column:Int) ~ Float

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Float	real value

GetReal #

Gets a real value

method : public : GetReal(column:String) ~ Float

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Float	real value

GetSmallInt #

Gets a small integer value

method : public : GetSmallInt(column:Int) ~ Int

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Int	small integer value

GetSmallInt #

Gets a small integer value

method : public : GetSmallInt(column:String) ~ Int

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Int	small integer value

GetTimestamp #

Gets a timestamp value

method : public : GetTimestamp(column:Int) ~ Timestamp

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
Timestamp	timestamp value

GetTimestamp #

Gets a timestamp value

method : public : GetTimestamp(column:String) ~ Timestamp

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
Timestamp	timestamp value

GetVarchar #

Gets a varchar value

method : public : GetVarchar(column:Int) ~ String

Parameters

Name	Type	Description
column	Int	column ID

Return

Type	Description
String	varchar value

Example

conn := Database.ODBC.Connection->New("mydsn", "user", "pass");
rs := conn->Select("SELECT name FROM users");
while(rs->Next()) {
  name := rs->GetVarchar(1); # read column 1 as string
  if(name <> Nil) { name->PrintLine(); };
};
rs->Close();
conn->Close();

GetVarchar #

Gets a varchar value

method : public : GetVarchar(column:String) ~ String

Parameters

Name	Type	Description
column	String	column name

Return

Type	Description
String	varchar value

IsNull #

Checks to see if the value fetched is NUL. This method should be called after a value is fetched using GetX(column).

method : public : IsNull() ~ Bool

Return

Type	Description
Bool	true if NIL, false otherwise

Next #

Moves the cursor to the next row in the result set

method : public : Next() ~ Bool

Return

Type	Description
Bool	true if cursor was moved, false otherwise

Example

conn := Database.ODBC.Connection->New("mydsn", "user", "pass");
rs := conn->Select("SELECT name FROM users");
while(rs->Next()) { # advance row by row
  rs->GetVarchar("name")->PrintLine();
};
rs->Close();
conn->Close();