/
DB_TRANS_OPEN

DB_TRANS_OPEN

DB_TRANS_OPEN action

Function

The action establishes a new Connection to a database.

Declaration

DB_TRANS_OPEN dbObjIdent, handleIdent_Int, retCodeIdent_Int [TIMEOUT timeoutSec_Int]

Parameters

dbObjIdent

in

Reference to an object of Database type.

handleIdent_Int

out

Identifier - the unique number (handle) of a Connection.

retCodeIdent_Int

out

Return code identifier.

timeoutSec_Int

in

Identifier - command timeout in seconds.

Return code

The value of the parameter transHandle_Int. See the table of error codes. It is possible to get extended error information.
Note: The maximum number of connections configured on the Database object can be limited by the Maximum connections parameter, with a value of 0 disabling the limitation. If the D2000 DBManager process consumes all connections, subsequent calls to DB_TRANS_OPEN attempting to establish a connection will return the error DBM_MAX_CONNECTIONS in the variable _ERR_NR_TRANS_EX.

Description

Identifier for a number (handle) of the Connection, is used for: 

 Return code describes the action success (__ERR_NO_ERROR).

If the timeoutSec_Int parameter is set to a non-zero value, all commands executed within this transaction that take longer will be aborted, and the extended error information will return the USER_EXPIR_TIME error in the _ERR_NR_TRANS_EX variable. At the same time, the value in the AbortCnt column in the SV._System_DBMDbPerf system structure is incremented.
This behavior is currently implemented only for the PostgreSQL database.

Note: Canceling a command is implemented by the PostgreSQL function pg_cancel_backend. After canceling a command, the transaction is still usable.

Related pages:

Script actions