$root.$sessions.POSTGRESQL

Parent: $root.$sessions

Properties Methods 

Properties

Object specific 
$backendpidThe process ID of the backend server process handling this connection
$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
$cannotifyWhile kTrue, the $notify() method is enabled. While kFalse, notifications are queued.
$char38touuidIf kTrue, Omnis character fields of length 38 are mapped to UUID
$char39tooidIf kTrue, Omnis character fields of length 39 are mapped to OID
$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
$databaseName 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
$defaultdateisemptyIf kTrue, fetched datetimes matching $defaultdate are treated as empty values
$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
$infinitydatesIf kTrue, the date value '31 Dec 9999 23:59:59' maps to the special date value 'infinity'
$listenernameRegisters a name for the $listen session (appears in the pg_stat_activity system table).
$logontimeoutNumber of seconds before a connection attempt times out
$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
$maxvarcharThe maximum size above which Omnis Character types are mapped to text
$numericprecisionThe precision used when mapping the Omnis number (dp) type to 'numeric'
$odbpskPre-shared key for use with databridge encryption
$optionsAllows additional logon parameters to be specified
$pipelinemodeIf kTrue, manual transactions are dispatched using pipeline mode. Requires libpq API v14 and later.
$portThe port number for the TCP/IP connection
$programnameRegisters a name for the session (appears in the pg_stat_activity system table)
$protocolversionVersion of the protocol in use
$quotedidentifierIf kTrue, table instances and session methods will generate quoted column & table name identifiers, thus preserving mixed-case names and names
$readonlyIf kTrue, manual transactions are read-only
$schemaThe schema name to be used when qualifying table names
$sequencetointIf kTrue, the Omnis Sequence type is mapped to INTEGER instead of SERIAL
$serializableIf kTrue, manual transactions will use Serializable isolation level
$serviceService name to use for additional connection parameters
$socketThe file descriptor number of the connection socket to the server.
$timezoneThe time zone to be used when $usetimezone is kTrue
$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)
$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
$usetimezoneIf kTrue, date/time time zone delimiters are used
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 
$addcustomtypeCreates a custom datatype mapping for the specified field size
$cancelRequests that the server abandon processing of the current command(s)
$clearcustomtypesClears the internal list of custom character types
$connectstatusReturns the status of the current connection
$escapebinaryEscapes binary data for use as a quoted literal value within an SQL statement
$getsslReturns kTrue if the connection is using SSL and optionally, info about the connection. Requires an SSL-enabled client library
$listenListens for the specified notification channel name and calls obj.$notify() when triggered
$lobcloseCloses the specified large object
$lobcreateCreates a new large object, optionally using the specified OID
$lobexportExports the specified large object from the database into a local file
$lobimportImports the contents of a local file into a new large object, optionally using the specified OID
$lobopenOpens an existing large object for reading or writing
$lobreadReads data from an existing large object
$lobseekChanges the current read/write position for the specified large object
$lobtellObtains the current read/write position for the specified large object
$lobtruncateResizes a large object to the specified length
$lobunlinkUnlinks the specified large object from the database
$lobwriteWrites data to an existing large object
$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

POSTGRESQL 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

POSTGRESQL statement object
$notifyCalled from a listener thread when the specified notification channel is triggered
$parameterstatusReturns the current value of a server parameter setting
$pipelineresultsFetches results of pipelined commands
$resetResets the current connection to the database server
$transactionstatusReturns the current transaction status
$unlistenRemoves the specified notification channel from the listener queue
Standard$begin $clear $coltext $commit $createnames $definelistorrow $insertnames $logoff $logon $makeschema $nextnativeerror $rollback $rpcdefine $selectnames $updatenames $wherenames