7.8. シャードキーの作成

PUT /1/(tenantId)/buckets/object/(bucketName)/shardkey

オブジェクトバケットにシャードキーを作成する

Request Headers:  

• X-Application-Id -- アプリケーションID(必須)
• X-Application-Key -- アプリケーションキー(必須)
• X-Session-Token -- セッショントークン(オプション)
• Content-Type -- "application/json"

Parameters:

• bucketName (string) -- バケット名

Request JSON Object:  

• keys (array) -- シャードキー
• boolean (unique) -- ユニーク制約

Status Codes:

• 200 OK -- 正常に登録した
• 400 Bad Request -- パラメータ不正、すでにシャードキーが設定されている、対応するインデックスがない
• 401 Unauthorized -- 認証エラー
• 403 Forbidden -- 権限エラー
• 404 Not Found -- 指定したバケットが存在しない

リクエストボディの例

シャードキーは以下のように JSON で指定する。

{
    "keys": [
        { "name": "key1", "type": 1 }
    ],
    "unique": false
}

この例では key1 を昇順でシャードキーを設定している。 シャードキーにはインデックスのように降順(-1)を指定することはできない。

ユニーク制約を指定する場合は unique に true を指定すること。

複合キーを使用する場合の例を示す。

{
    "keys": [
        { "name": "key1", "type": 1 },
        { "name": "key2", "type": 1 }
    ],
    "unique": false
}

注意事項

• 対象バケットに対する admin 権限が必要である。
• バケットに対してシャードキーを設定することができるのは1回だけである。
• シャードキーに対応するインデックスを事前に作成しておかなければならない。
• シャードキーには降順(-1)を指定することはできない。

注意

本APIはβ版である。