Jump to

• Request
• Response
• Examples

Get Transaction Settings

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/transactions

Returns transaction settings of the specified database.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Transaction settings returned successfully.

Body ()

Root Schema : transactions

Type: object

Show Source

• commitBlocks(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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.

{
    "type":"object",
    "properties":{
        "committedAccess":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, 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 <b>false</b>.</p>"
        },
        "concurrencyWaitSeconds":{
            "type":"integer",
            "description":"<p>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 <b>true</b>.</p>",
            "format":"int32"
        },
        "concurrencyPreImageAccess":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, 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 <b>true</b>, when committedAccess is enabled.</p>"
        },
        "commitBlocks":{
            "type":"integer",
            "description":"<p>The number of data blocks updated before an explicit commit is performed (during calculation and grid updates). Applicable when committedAccess is <b>false</b>.</p>",
            "format":"int64"
        },
        "commitRows":{
            "type":"integer",
            "description":"<p>The number of rows of the input file processed before an explicit commit is performed (during data load). Applicable when committedAccess is <b>false</b>.</p>",
            "format":"int64"
        }
    },
    "xml":{
        "name":"transactions"
    }
}

400 Response

Bad Request

Failed to get the transaction settings. The application or database name may be incorrect.

500 Response

Internal Server Error.

Back to Top

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
  }
}

Back to Top