$root.$sessions.ODBC

Parent: $root.$sessions

Properties Methods 

Properties

Object specific 
$batchsizeThe number of rows to retrieve simultaneously. Statement objects inherit this value. $batchsize is not supported by all databases in which case it reverts to 1
$bytesreceivedThe number of bytes received through the session object since logon. Assigning to this property resets the value to zero
$bytessentThe number of bytes sent through the session object since logon. Assigning to this property resets the value to zero
$codepageThe code page used to interpret non-Unicode character data. A kUniType... constant that identifies an 8 bit character set (not kUniTypeUTF8)
kUniTypeAnsiArabic kUniTypeAnsiBaltic kUniTypeAnsiCentralEuropean kUniTypeAnsiCyrillic kUniTypeAnsiGreek kUniTypeAnsiHebrew kUniTypeAnsiLatin1 kUniTypeAnsiThai kUniTypeAnsiTurkish kUniTypeAnsiVietnamese kUniTypeAuto kUniTypeBinary kUniTypeCharacter kUniTypeISO8859_1 kUniTypeISO8859_10 kUniTypeISO8859_11 kUniTypeISO8859_13 kUniTypeISO8859_14 kUniTypeISO8859_15 kUniTypeISO8859_16 kUniTypeISO8859_2 kUniTypeISO8859_3 kUniTypeISO8859_4 kUniTypeISO8859_5 kUniTypeISO8859_6 kUniTypeISO8859_7 kUniTypeISO8859_8 kUniTypeISO8859_9 kUniTypeNativeCharacters kUniTypeOEM kUniTypeUTF16 kUniTypeUTF16BE kUniTypeUTF16LE kUniTypeUTF32 kUniTypeUTF32BE kUniTypeUTF32LE kUniTypeUTF8
$commitdelayThe delay (in milliseconds) between each $commit() retry
$commitretriesThe number of times a $commit() operation will retry before failing
$cursorsensitivityWhether cursors are sensitive to changes made by other cursors within the current transaction
$datesecdpThe number of decimal places used for SQL Server date columns
$dbmsnameName of the session database
$dbmsversionVersion of the session database
$debugfileIf assigned, the DAM writes debug information to the specified file. Set $debuglevel to enable/disable logging
$debuglevelSpecifies the level of debug information that will be written to $debugfile. Values 1-4 specify increasing amounts of debug information. Zero disables logging
$debugsizeThe maximum size of $debugfile generated before automatic truncation occurs. Assigning zero disables truncation
$defaultdatabaseThe default database to connect to at logon
$defaultschemaThe default schema associated with the current user. SQL Server 2005 only
$drivernameName of the session driver
$driverodbcversionODBC version of the session driver
$driverversionVersion of the session driver
$encodingThe Unicode encoding used by the database. A kSessionEncoding... constant (read-only)
kSessionEncodingAnsi kSessionEncodingUtf16 kSessionEncodingUtf32 kSessionEncodingUtf8
$fetch64bitintsIf kTrue, 64-bit integers are fetched into Omnis 64-bit Integer fields. If kFalse, they are fetched as 32-bit Integers and truncated accordingly
$fetchnumericascharIf kTrue, NUMERIC/DECIMAL columns are defined & fetched as character values
$infoaserrorIf kTrue, informational & warning messages are treated as errors. If kFalse, the DAM tries to ignore and carry on
$isolationlevelThe current transaction isolation level in use by the session
$isolationoptionsA kODBCIsolation... bitmask representing the isolation levels supported by the driver
$logontimeoutTimeout in seconds for logon
$maxresultsetsizeThe maximum size of a result set. Statement objects inherit this value. When a $fetch(kFetchAll) exceeds this value, the result set is trunacted and kFetchMemoryExceeded is returned
$modeA kODBCMode... value used for non-standard ODBC connections
$multipleresultsetskTrue if the data source supports multiple result sets
$multipletransactionskTrue if the driver supports more than one active transaction at the same time
$nationaltowcharIf true, Omnis National fields are mapped to wide character types and Omnis Character fields are mapped to 8-bit types
$nativewarncodeInformation or warning code generated by the last operation
$nativewarntextInformation or warning message generated by the last operation
$odbencryptWhen kTrue, ODBC Bridge connections use end-to-end encryption. Improved performance can be obtained by disabling encryption
$programnameThe name to be registered at the server for this session
$querytimeoutTimeout in seconds for a query
$quotedidentifierIf kTrue, table instances and session methods will generate quoted column & table name identifiers, thus preserving mixed-case names and names
$rpcsupportIf true,the connection supports procedures (RPCs)
$savefileWhen $usefiledsn is kTrue, invokes the SAVEFILE connection attribute which writes updated connection details back to the File DSN
$timezoneThe local timezone offset relative to GMT
$trackslowqueriesQueries running longer than the amount of seconds specified in this property will be reported as a slow running query to the trace log. Defaults to 0 (off)
$trustedconnectionEnable/Disable logon using a server trusted connection
kODBCIgnoreTrusted kODBCNotTrusted kODBCUseTrusted
$txncapabilityThe command types supported by SQL statements inside transactions
$unicodeIf kTrue, Unicode data types/mappings are used with character data. If kFalse, the DAM reverts to ANSI behaviour and the DAM will attempt to map any Unicode characters to the specified $codepage
$usefiledsnThe hostname specified at logon will be a file DSN
$uselogonpromptPrompt for missing logon information
$useprogramnameRegister $programname at logon
$usequalifiersTreat table names as 'owner.table'
$usescaleIf kTrue, Omnis number dp columns are bound using a precision of 15 + the dp value. If kFalse, number dp columns are bound using a precision of 15. Also affects $createnames()
$usetimezoneIf kTrue, $timezone will be applied to values inserted and fetched from TIME & TIMESTAMP columns
$usevarcharmaxIf kTrue, Character columns > 4000 map to VARCHAR(MAX) / NVARCHAR(MAX) dependent on the value of $unicode. If kFalse, they map to TEXT / NTEXT. Assumes the connection is to MS SQL Server
Standard$allowstransactions $apiversion $autobegintran $blobsize $charmap $commitmode $damname $defaultdate $emptydateisnull $errorcode $errortext $hostname $ident $lobchunksize $lobthreshold $maptable $name $nativeerrorcode $nativeerrorpending $nativeerrortext $password $rollbackmode $sessionobject $sessionobjref $sqldecimalseparator $sqlstripspaces $sqlthousandseparator $state $transactionmode $username $version

Methods

Object specific 
$configdsnAdds, modifies or removes the specified ODBC DSN
$getdatasourcesRetrieves a list of ODBC DSNs of the specified type
$getdriversRetrieves a list of installed ODBC drivers
$getinfoRetrieves information about the specified ODBC DSN or Driver
$getoptionRetrieves the specified ODBC configuration attribute
$newstatement$newstatement([cStatementname]) Creates and returns a new dynamic instance of a statement object for the session; typically used to return a new statement object to an object variable with no subtype specified

ODBC statement object
$newstatementref$newstatementref([cStatementname]) Creates and returns a new dynamic instance of a statement object for the session,to be used with an Object reference variable;typically used to return a new statement to an object reference variable

ODBC statement object
$setinfoAdds or modifies information for the specified ODBC DSN or Driver
$setoptionSets the specified ODBC configuration option
Standard$begin $clear $coltext $commit $createnames $definelistorrow $insertnames $logoff $logon $makeschema $nextnativeerror $rollback $rpcdefine $selectnames $updatenames $wherenames