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

Get Compression Settings

get

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

Returns compression settings of the specified database.

Request

Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK

Compression settings retrieved successfully.

Body ()
Root 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 the compression 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 compression 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/ASOSamp/databases/Basic/settings/compression" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "compression": [
    {
      "dimensionName": "<No Compression Dimension>",
      "isCompression": false,
      "storedLevel0Members": 0,
      "averageBundleFill": 1,
      "averageValueLength": 8,
      "level0MB": 19.071334838867188
    },
    {
      "dimensionName": "Measures",
      "isCompression": true,
      "storedLevel0Members": 5,
      "averageBundleFill": 4.011231448054553,
      "averageValueLength": 2.418,
      "level0MB": 6.448018309020995
    },
    {
      "dimensionName": "Years",
      "isCompression": false,
      "storedLevel0Members": 2,
      "averageBundleFill": 1.0060362173038229,
      "averageValueLength": 2.22,
      "level0MB": 16.863827831268313
    },
    {
      "dimensionName": "Time",
      "isCompression": false,
      "storedLevel0Members": 12,
      "averageBundleFill": 1.0836081053886284,
      "averageValueLength": 2.23,
      "level0MB": 15.857951142338342
    },
    {
      "dimensionName": "Transaction Type",
      "isCompression": false,
      "storedLevel0Members": 3,
      "averageBundleFill": 1.002004008016032,
      "averageValueLength": 2.22,
      "level0MB": 16.921041835784912
    },
    {
      "dimensionName": "Payment Type",
      "isCompression": false,
      "storedLevel0Members": 4,
      "averageBundleFill": 1.0111223458038423,
      "averageValueLength": 2.22,
      "level0MB": 16.79231032562256
    },
    {
      "dimensionName": "Promotions",
      "isCompression": false,
      "storedLevel0Members": 5,
      "averageBundleFill": 1.0015022533800702,
      "averageValueLength": 2.22,
      "level0MB": 16.928193586349487
    },
    {
      "dimensionName": "Age",
      "isCompression": false,
      "storedLevel0Members": 9,
      "averageBundleFill": 1.0167768174885612,
      "averageValueLength": 2.22,
      "level0MB": 16.713641069412233
    },
    {
      "dimensionName": "Income Level",
      "isCompression": false,
      "storedLevel0Members": 6,
      "averageBundleFill": 1.010611419909045,
      "averageValueLength": 2.22,
      "level0MB": 16.799462076187133
    },
    {
      "dimensionName": "Products",
      "isCompression": false,
      "storedLevel0Members": 25,
      "averageBundleFill": 1.0429341213280028,
      "averageValueLength": 2.232,
      "level0MB": 16.375124876022337
    },
    {
      "dimensionName": "Stores",
      "isCompression": false,
      "storedLevel0Members": 239,
      "averageBundleFill": 1,
      "averageValueLength": 2.22,
      "level0MB": 16.949648838043213
    },
    {
      "dimensionName": "Geography",
      "isCompression": false,
      "storedLevel0Members": 9398,
      "averageBundleFill": 1.0310164103445314,
      "averageValueLength": 2.23,
      "level0MB": 16.531271430015565
    }
  ]
}
Back to Top