一般設定の取得
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings
指定されたデータベースの一般設定を返します。 expand
パラメータを使用して、追加の設定グループを拡張できます。 expand
がnoneの場合、追加の設定グループのリンクが返されます。
要求
- applicationName: string
アプリケーション名
- databaseName: string
データベース名
- expand(optional): string
none
を使用して、他のグループ化された設定へのリンクとともに、一般設定のみを表示します。 その他の拡張オプションは次のとおりです:startup
(ブロック・ストレージ・キューブのみ)calculation
(ブロック・ストレージのみ)buffers
caches
(ブロック・ストレージのみ)transactions
(ブロック・ストレージのみ)compression
(集約ストレージのみ)all
デフォルト値:none
許可される値:[ "none", "startup", "calculation", "buffers", "caches", "transactions", "compression", "all" ]
レスポンス
- application/json
- application/xml
200 レスポンス
OK
一般データベース設定が正常に返されました。拡張設定を取得するためのリンクがあります。
object
- dataRetrievalBufferSize(optional): integer(int64)
取得リクエストごとに割り当てられた取得バッファ・サイズ
- dataRetrievalSortBufferSize(optional): integer(int64)
取得リクエストごとに割り当てられた取得ソート・バッファ・サイズ
object
- cacheMemoryLocking(optional): boolean
非推奨、直接I/Oとの組合せ
- dataCacheCurrentValue(optional): integer(int64)
データ・キャッシュのランタイム・サイズ(KB)
- dataCacheSetting(optional): integer(int64)
現在有効なデータ・キャッシュ・サイズ設定値(KB)
- dataFileCacheCurrentValue(optional): integer(int64)
キューブで現在使用されているランタイム・データ・ファイル・キャッシュ・サイズ(KB)。 データ・ファイル・キャッシュ・サイズを変更した後、新しいデータ・ファイル・キャッシュ・サイズを有効にするには、キューブを停止して再起動する必要があります。
- dataFileCacheSetting(optional): integer(int64)
現在有効なデータ・ファイル・キャッシュ・サイズ設定値
- indexCacheCurrentValue(optional): integer(int64)
索引キャッシュのランタイム・サイズ(KB)
- indexCacheSetting(optional): integer(int64)
現在有効な索引キャッシュ・サイズ(KB)設定値
- indexPageCurrentValue(optional): integer(int32)
索引ページのランタイム・サイズ(KB)
- indexPageSetting(optional): integer(int32)
現在有効な索引ページ・サイズ設定(KB)
object
- aggregateMissingValues(optional): boolean
trueの場合、#MISSING値を通常のキューブ連結とともに集計します。 デフォルトはfalseです(欠落している値は集計されません)。
- createBlocksOnEquations(optional): boolean
定数割当て計算式でデータ・ブロックを強制的に作成します(疎ディメンションに対してのみ有効)。 trueの場合、ブロックが作成されます。
- twoPassCalculation(optional): boolean
完全計算の実行時に2パス計算を強制します(2パス計算が有効な場合はtrue)
array
- Array of: object CompressionSettings
異なるディメンションが圧縮ディメンションとして仮定的に使用される、集約ストレージ・キューブの推定圧縮統計。 これらの見積りは、最適な圧縮ディメンションの選択に役立ちます。
object
- description(optional): string
キューブの一般摘要
- queryTracking(optional): boolean
問合せデータの収集が有効かどうか。 集約ストレージ・キューブにのみ適用されます。 trueの場合、問合せトラッキングが有効になり、問合せベースのビューの最適化に使用できます。
object
- allowUsersToStartDatabase(optional): boolean
直接、またはキューブの起動を必要とするリクエストの結果として、ユーザーによるキューブの起動を有効または無効にします。 デフォルトはtrueです。
- startDatabaseWhenApplicationStarts(optional): boolean
アプリケーションの起動時にキューブを自動的に起動します。 デフォルトはtrueです。 allowUsersToStartDatabaseがtrueでもある場合にのみ適用可能です。
object
- commitBlocks(optional): integer(int64)
明示的なコミットが実行されるまでに更新されるデータ・ブロックの数(計算およびグリッドの更新時)。 committedAccessがfalseの場合に適用されます。
- commitRows(optional): integer(int64)
明示的なコミットが実行される前に(データ・ロード中に)処理された入力ファイルの行数。 committedAccessがfalseの場合に適用されます。
- committedAccess(optional): boolean
trueの場合、分離レベルをコミット済アクセスに設定します。つまり、データ・ブロックを更新できるのは一度に1つのトランザクションのみであり、Essbaseはトランザクションおよびコミット操作が実行されるまですべてのデータ・ブロックの読取り/書込みロックを保持します。 concurrencyPreImageAccessが有効になっている場合でも、ユーザー(またはトランザクション)は最後のコミット・ポイントでデータに読取り専用アクセスできます。 デフォルトはfalseです。
- concurrencyPreImageAccess(optional): boolean
trueの場合、キューブがコミット・モードのときに、最後のコミット・ポイントでのデータへの読取り専用アクセスをユーザー(または他のトランザクション)に許可します(つまり、同時トランザクション中はデータ・ブロックがロックされる可能性があります)。 committedAccessが有効な場合、デフォルトはtrueです。
- concurrencyWaitSeconds(optional): integer(int32)
ロック・タイムアウト間隔。データベースがコミット・モードのときにブロックがロック解除されるまで待機する秒数。 割り当てられた時間内に付与できないトランザクション・リクエストが行われた場合、ロックが付与されるまでトランザクションはロールバックされます。 committedAccessがtrueの場合にのみ適用されます。
object
異なるディメンションが圧縮ディメンションとして仮定的に使用される、集約ストレージ・キューブの推定圧縮統計。 これらの見積りは、最適な圧縮ディメンションの選択に役立ちます。
- averageBundleFill(optional): number(double)
集約ストレージ・キューブにのみ適用されます。 圧縮ディメンション・バンドル当たりの推定平均値数。 平均バンドル充填率が高い圧縮ディメンションを選択すると、キューブの圧縮率が向上します。
- averageValueLength(optional): number(double)
値の格納に必要な推定平均バイト数。 平均値の長さが短いディメンションほど、キューブの圧縮率が向上します。
- dimensionName(optional): string
圧縮統計を見積もるために、ディメンション名は集約ストレージ圧縮ディメンションと仮定的にみなされます。
- isCompression(optional): boolean
これが集約ストレージ圧縮ディメンションかどうか。 デフォルトでは、圧縮ディメンションは勘定科目ディメンションです。 集約ストレージ・キューブには、圧縮ディメンションを1つのみ含めることができます。
- level0MB(optional): number(double)
圧縮されたキューブの推定サイズ(メガバイト)。 予想されるlevel-0サイズが小さい場合は、このディメンションを選択すると圧縮率が向上することを示します。 圧縮ディメンションがないシナリオ(なし)を除き、すべての見積りではすべてのページが圧縮されているとみなされます。 圧縮されたページには、圧縮されていないページには追加のオーバーヘッドが必要なため、一部のディメンションの見積りlevel-0データベース・サイズはなしの値より大きくなる場合があります。
- storedLevel0Members(optional): number(double)
保管されているレベル0のメンバーの数。 多数のストアド・レベル0メンバーを含む集約ストレージ圧縮ディメンションは、最適に実行されません。 動的に計算されるディメンションと同様に、圧縮ディメンションからの上位レベルの取得は一般的に遅くなります。
400 レスポンス
不正なリクエスト
データベース設定の取得に失敗しました。 アプリケーション名またはデータベース名が正しくない可能性があります。
500 レスポンス
内部サーバー・エラー。
例
次の例では、cURLを使用してWindowsシェル・スクリプトからREST APIにアクセスし、キューブの一般設定および起動設定を取得する方法を示します。
コール元のユーザーIDおよびパスワードは、properties.bat
で値が設定される変数です。
cURLコマンドを含むスクリプト
call properties.bat
curl -X GET "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/settings?expand=startup"
-H "accept: application/json"
-u %User%:%Password
レスポンス本体の例
{
"general": {
"description": "",
"queryTracking": false
},
"startup": {
"allowUsersToStartDatabase": true,
"startDatabaseWhenApplicationStarts": true
},
"links": [
{
"rel": "calculation",
"href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/settings/calculation",
"method": "GET"
},
{
"rel": "buffers",
"href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/settings/buffers",
"method": "GET"
},
{
"rel": "caches",
"href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/settings/caches",
"method": "GET"
},
{
"rel": "transactions",
"href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/settings/transactions",
"method": "GET"
},
{
"rel": "edit",
"href": "https://192.0.2.1:443/essbase/rest/v1/applications/Sample/databases/Basic/settings",
"method": "PATCH"
}
]
}