1. REST API for Oracle Essbase
  2. Tasks
  3. Database Settings and Statistics

Get General Settings

get

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

Returns general settings of the specified database. Additional groups of settings can be expanded using the expand parameter. If expand is none, links are returned for the additional groups of settings.

Request

Path Parameters
Query Parameters

  • Use none to show only general settings, with links for other grouped settings. Other expansion options available:

    • startup (block storage cubes only)
    • calculation (block storage only)
    • buffers
    • caches (block storage only)
    • transactions (block storage only)
    • compression (aggregate storage only)
    • all

    Default Value: none
    Allowed Values: [ "none", "startup", "calculation", "buffers", "caches", "transactions", "compression", "all" ]
Back to Top

Response

Supported Media Types

200 Response

OK

General database settings returned successfully, with links to get expanded settings.

Body ()
Root Schema : settings
Type: object
Show Source
Nested Schema : buffers
Type: object
Show Source
Nested Schema : caches
Type: object
Show Source
Nested Schema : calculation
Type: object
Show Source
Nested Schema : compression
Type: array
Show Source
  • CompressionSettings

    Estimated compression statistics for an aggregate storage cube, with different dimensions hypothetically used as the compression dimension. These estimates can help you choose the best compression dimension.

Nested Schema : general
Type: object
Show Source

  • General description of the cube

  • Whether collection of query data is enabled. Applies only to aggregate storage cubes. If true, query tracking is enabled, and can be used for query-based view optimization.

Nested Schema : startup
Type: object
Show Source
Nested Schema : transactions
Type: object
Show Source

  • The number of data blocks updated before an explicit commit is performed (during calculation and grid updates). Applicable when committedAccess is false.

  • The number of rows of the input file processed before an explicit commit is performed (during data load). Applicable when committedAccess is false.

  • 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.

  • 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.

  • 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.

Nested Schema : CompressionSettings
Type: object

Estimated compression statistics for an aggregate storage cube, with different dimensions hypothetically used as the compression dimension. These estimates can help you choose the best compression dimension.

Show Source

  • Applies to aggregate storage cubes only. Estimated average number of values per compression dimension bundle. Choosing a compression dimension that has a higher average bundle fill means that the cube compresses better.

  • Estimated average number of bytes required to store a value. Dimensions with a smaller average value length compress the cube better.

  • Dimension name hypothetically considered to be the aggregate storage compression dimension, for purposes of estimating compression statistics.

  • Whether this is an aggregate storage compression dimension. By default, the compression dimension is the Accounts dimension. There can be only one compression dimension in an aggregate storage cube.

  • Estimated size of the compressed cube, in megabytes. A smaller expected level-0 size indicates that choosing this dimension enables better compression. Except for the scenario in which there is no compression dimension (None), all estimates assume that all pages are compressed. Since compressed pages require additional overhead that uncompressed pages do not, the estimated level-0 database size for some dimensions may be larger than the value for None.

  • Number of stored level 0 members. Aggregate storage compression dimensions with a large number of stored level 0 members do not perform optimally. As with any dynamically calculated dimension, upper-level retrievals from compression dimensions generally are slower.

400 Response

Bad Request

Failed to get database 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 general and startup settings for a 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?expand=startup&links=none" -H "accept: application/json"-u %User%:%Password%

Example of Response Body

{
  "general": {
    "description": "",
    "queryTracking": false
  },
  "startup": {
    "allowUsersToStartDatabase": true,
    "startDatabaseWhenApplicationStarts": true
  },
  "links": [ ]
}
Back to Top