移動先

• リクエスト
• レスポンス
• 例

トランザクション設定の取得

get

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

指定されたデータベースのトランザクション設定を返します。

リクエスト

パス・パラメータ

• applicationName(required): string

  アプリケーション名。

• databaseName(required): string

  データベース名。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json
• application/xml

200 レスポンス

OK

トランザクションの設定が正常に返されました。

本体()

ルート・スキーマ : transactions

型: object

ソースの表示

• commitBlocks: integer(int64)

  明示的なコミットが実行される前(計算およびグリッド更新の間)に更新されたデータ・ブロックの数。committedAccessがfalseの場合に適用できます。

• commitRows: integer(int64)

  明示的なコミットが実行される前(データ・ロードの間)に処理された、入力ファイルの行の数。committedAccessがfalseの場合に適用できます。

• committedAccess: boolean

  trueの場合は、分離レベルをコミット済アクセスに設定します。つまり、一度に1つのトランザクションでのみデータ・ブロックを更新でき、Essbaseで、トランザクションおよびコミット操作が実行されるまですべてのデータ・ブロックに対する読取りロックおよび書込みロックが保持されます。その場合でも、concurrencyPreImageAccessが有効になっていれば、ユーザー(またはトランザクション)はその最後のコミット・ポイントでデータに読取り専用でアクセスできます。デフォルトはfalseです。

• concurrencyPreImageAccess: boolean

  trueの場合、キューブがコミット済モードなら、ユーザー(またはその他のトランザクション)は、その最後のコミット・ポイントでデータに読取り専用でアクセスできます(つまり、同時トランザクションの期間はデータ・ブロックがロックされる可能性がある)。committedAccessが有効になっている場合、デフォルトはtrueです。

• concurrencyWaitSeconds: integer(int32)

  ロック・タイムアウト間隔。データベースがコミット済モードの場合にブロックがロック解除されるまでの秒数。割り当てられた時間内に付与できないトランザクション・リクエストが行われた場合、トランザクションは、ロックを付与できるようになるまでロール・バックされます。committedAccessが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 レスポンス

不正なリクエスト

トランザクション設定の取得に失敗しました。アプリケーション名またはデータベース名が正しくない可能性があります。

500 レスポンス

サーバーの内部エラーです。

先頭に戻る

例

次の例では、ブロック・ストレージ・キューブのトランザクション設定を取得する方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

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%

レスポンス本体の例

{
  "transactions": {
    "committedAccess": false,
    "concurrencyWaitSeconds": 20,
    "concurrencyPreImageAccess": true,
    "commitBlocks": 3000,
    "commitRows": 0
  }
}

先頭に戻る