Get Transaction Settings
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/transactions
Returns transaction settings of the specified database.
Request
-
applicationName(required): string
Application name.
-
databaseName(required): string
Database name.
Response
- application/json
- application/xml
200 Response
OK
Transaction settings returned successfully.
object
-
commitBlocks:
integer(int64)
The number of data blocks updated before an explicit commit is performed (during calculation and grid updates). Applicable when committedAccess is false.
-
commitRows:
integer(int64)
The number of rows of the input file processed before an explicit commit is performed (during data load). Applicable when committedAccess is false.
-
committedAccess:
boolean
If true, sets the isolation level to committed access, meaning that only one transaction at a time can update data blocks, and Essbase holds read/write locks on all data blocks until the transaction and the commit operations are performed. If concurrencyPreImageAccess is enabled, users (or transactions) can still have read-only access to data at its last commit point. The default is false.
-
concurrencyPreImageAccess:
boolean
If true, allow users (or other transactions) read-only access to data at its last commit point when the cube is in committed mode (meaning that data blocks may be locked for the duration of a concurrent transaction). The default is true, when committedAccess is enabled.
-
concurrencyWaitSeconds:
integer(int32)
Lock timeout interval; number of seconds to wait for blocks to be unlocked when the database is in committed mode. If a transaction request is made that cannot be granted in the allotted time, the transaction is rolled back until a lock can be granted. Applicable only when committedAccess is true.
400 Response
Bad Request
Failed to get the transaction settings. The application or database name may be incorrect.
500 Response
Internal Server Error.
Examples
The following example shows how to get transaction settings for a block storage cube.
This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat
.
Script with cURL Command
call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/settings/transactions" -H "accept: application/json" -u %User%:%Password%
Example of Response Body
{
"transactions": {
"committedAccess": false,
"concurrencyWaitSeconds": 20,
"concurrencyPreImageAccess": true,
"commitBlocks": 3000,
"commitRows": 0
}
}