CosmosDbKeyEscape クラス

  • リファレンス
パッケージ:
com.microsoft.bot.azure
Maven 成果物:
com.microsoft.bot:bot-azure:4.14.3
  • java.lang.Object
    • com.microsoft.bot.azure.CosmosDbKeyEscape

public final class CosmosDbKeyEscape

CosmosDB キーをエスケープするためのヘルパー クラス。

フィールドの概要

修飾子と型 フィールドと説明
static final java.lang.Integer MAX_KEY_LENGTH

以前のライブラリのキーの最大長は 255 でした。

メソッドの概要

修飾子と型 メソッドと説明
static java.lang.String escapeKey(String key)

キーを、Cosmos DB で安全に使用できる DocumentID に変換します。
static java.lang.String escapeKey(String key, String suffix, Boolean compatibilityMode)

キーを、Cosmos DB で安全に使用できる DocumentID に変換します。

メソッドの継承元: java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

フィールドの詳細

MAX_KEY_LENGTH

public static final Integer MAX_KEY_LENGTH

以前のライブラリのキーの最大長は 255 でした。 制限は 1023 になりました。 このライブラリでは、下位互換性の既定値は 255 のままです。 この動作をオーバーライドし、長い制限を使用して CosmosDbPartitionedStorageOptions.CompatibilityMode を false に設定します。 https://docs.microsoft.com/en-us/azure/cosmos-db/concepts-limits\#per-item-limits.

メソッドの詳細

escapeKey

public static String escapeKey(String key)

キーを、Cosmos DB で安全に使用できる DocumentID に変換します。

パラメーター:

key - エスケープするキー。

戻り値:

CosmosDB で安全に使用できるエスケープされたキー。

escapeKey

public static String escapeKey(String key, String suffix, Boolean compatibilityMode)

キーを、Cosmos DB で安全に使用できる DocumentID に変換します。

パラメーター:

key - エスケープするキー。
suffix - すべての行キーの末尾に追加する文字列。
compatibilityMode - 互換性モードで実行していて、以前の CosmosDb の最大キー長 255 をサポートするためにキーを切り捨てる必要がある場合は True。 この動作は、CosmosDbPartitionedStorage.compatibilityMode を false に設定することでオーバーライドできます。 *

戻り値:

CosmosDB で安全に使用できるエスケープされたキー。

適用対象