Standard DAM Session Properties

The properties listed here are standard properties of DAM session objects. DAM sessions which have a standard property only include the property name in their property table - please use the entry here to read about the property.

$allowstransactionskTrue if the DBMS supports manual transactions (read-only)
$apiversionThe version of the client api that the DAM was built with
$autobegintranIndicates whether SQL transactions are automatically started on commit/rollback. Read-only
$blobsizeDefault binary object size used by $createnames() and $coltext() when creating table columns from Omnis binary fields
$charmapDenotes the character set used for mapping non-Unicode character data; a kSessionCharMap... constant. Note: this property is deprecated and is superseded by $codepage
kSessionCharMapNative kSessionCharMapOmnis kSessionCharMapTable
$commitmodeThe session commit mode. A kSessionCommit... constant that specifies what happens to prepared statements and cursors on commit
kSessionCommitClose kSessionCommitDelete kSessionCommitPreserve
$damnameThe name of the DAM object (read-only)
$defaultdateDefault date used for DateTime values. Used to substitute missing date parts into database columns where these would otherwise cause insertion errors
$emptydateisnullIf kTrue, empty datetimes are treated as NULL values for INSERTs and UPDATEs. If kFalse, $defaultdate is used
$errorcodeOmnis internal error code generated by last session command
kDAMFileOpenFailed kDAMFileReadFailed kDAMInternalError kDAMInvalidFileName kDAMInvalidIndexType kDAMInvalidMapType kDAMInvalidTableType kDAMInvalidTranMode kDAMNativeErrorFailed kDAMNoClientLibrary kDAMNoError kDAMNoPendingError kDAMNotSerialised kDAMNotUnicode kDAMParameterError kDAMParameterNumError kDAMParameterTypeError kDAMServerMethodFailed kDAMServerPropertyFailed kDAMSqlError kDAMUnknownError kDAMWrongOmnisVersion kSessionBeginFailed kSessionBindMarkerFailed kSessionClearFailed kSessionColTextFailed kSessionCommitFailed kSessionInvalidSQLSeparator kSessionLobChunkSizeOutOfRange kSessionLobThresholdOutOfRange kSessionLogoffFailed kSessionLogonFailed kSessionNewStatementFailed kSessionNoDriverManager kSessionNoMapTable kSessionNotLoggedOn kSessionNoTranSupport kSessionNotTranManual kSessionRegisterFailed kSessionRollbackFailed kSessionRpcDefineFailed kSessionRpcNotDefined kSessionSetCharMapFailed kSessionSetMapTableFailed kSessionSetTranModeFailed kSessionUsesAutoBegin kStatementBindInputVarFailed kStatementBindResultColFailed kStatementBufferAllocationFailed kStatementClearFailed kStatementCloseFailed kStatementDescribeFailed kStatementDropFailed kStatementExecDirectFailed kStatementExecuteFailed kStatementFetchFailed kStatementFetchMemoryExceeded kStatementHasNoSession kStatementInputVarFailed kStatementInsertRowFailed kStatementNoFetchList kStatementNoFilename kStatementNoResults kStatementNotPrepared kStatementPrepareFailed kStatementResultColFailed kStatementReturnedInfo kStatementRpcGetParamValuesError kStatementRpcPrepareParamsError kStatementSendInputVarFailed kStatementSendResultVarFailed kStatementServerColumnsFailed kStatementServerIndexesFailed kStatementServerResultsFailed kStatementServerRpcParametersFailed kStatementServerRpcProceduresFailed kStatementServerTablesFailed
$errortextOmnis error text generated by last session command
$hostnameDatabase name or alias used for connection. $hostname might be an IP-address or machine name. For ODBC, Oracle and Sybase it should be the name of a pre-defined DSN
$lobchunksizeThe size of each chunk used to send large character and binary data (binary values larger in size than $lobthreshold)
$lobthresholdThreshold at which large character and binary data is chunked. Binary values of size <= $lobthreshold are fetched as a single chunk
$maptableFile name (minus the .in/.out extension) defining the 8-bit character mapping tables to be used with non-Unicode character data
$nativeerrorcodeDatabase-specific native error code generated by the last session command
$nativeerrorpendingkTrue if further native errors are available for the session. Read-only
$nativeerrortextDatabase-specific native error text generated by the last session command
$passwordPassword used to authenticate connection
$rollbackmodeThe session rollback mode. A kSessionRollback... constant that specifies what happens to prepared statements and cursors on rollback
kSessionRollbackClose kSessionRollbackDelete kSessionRollbackPreserve
$sqldecimalseparatorDecimal separator used by server. Omnis numbers are output using this deciaml point character (not the current $separators dpch character)
$sqlstripspacesDenotes whether character data fetched from the database has trailing spaces stripped
$sqlthousandseparatorThousand separator used by server. (No longer used since most databases do not support/display a thousands separator)
$stateThe session state. A kSessionState... constant that indicates the current state of the session
kSessionStateLoggedOff kSessionStateLoggedOn
$transactionmodeThe transaction mode. A kSessionTran... constant that specifies the transaction mode for the session
kSessionTranAutomatic kSessionTranManual kSessionTranServer
$usernameUser name used to authenticate the connection
$versionThe version of the database that the session is connected to