Azure Cosmos DB での階層パーティションキー

[アーティクル]
09/13/2023

適用対象: NoSQL

Azure Cosmos DB では水平スケーリングをサポートするために、パーティションキーに基づいて論理パーティションと物理パーティション全体にデータを分散します。階層パーティションキーまたは "サブパーティション分割" を使用すると、パーティションキーに対して最大 3 レベルの階層を構成して、データ分散をさらに最適化し、より高いレベルのスケーリングを実現できます。

現在、合成キーを使用している場合や、パーティションキーが 20 GB を超える可能性があるシナリオがある場合は、サブパーティション分割が役立ちます。この機能を使用する場合、論理パーティションキーのプレフィックスは 20 GB、および 1 秒あたり 10,000 要求ユニット (RU/秒) を超える可能性があります。プレフィックスによるクエリは、データを保持するパーティションのサブセットに効率的にルーティングされます。

階層パーティションキーを選択する

マルチテナントアプリケーションがある場合は、階層パーティションキーを使用することをお勧めします。階層パーティションを使用すると、論理パーティションキーの制限である 20 GB を超えるスケーリングが可能になります。現在のパーティションキーまたは単一のパーティションキーが頻繁に 20 GB に達する場合、ワークロードには階層パーティションが最適です。

階層パーティションキーを選択する場合は、次の一般的なパーティション分割の概念を念頭に置いておくことが重要です。

すべてのコンテナーで、階層パーティションキーの完全なパスの各レベルが ("最初のレベル" から) 以下を満たす必要があります。
- カーディナリティが高いこと。 階層パーティションの最初のキー、2 番目のキー、3 番目のキー (該当する場合) のすべてに広範囲の値を指定できる必要があります。
- 要求ユニット (RU) の消費とデータストレージをすべての論理パーティションに均等に分散すること。 この分散により、物理パーティション全体でも RU の消費とストレージの分散が保証されます。
読み取り負荷の高い大規模なワークロードの場合は、クエリに頻繁に表示される階層パーティションキーを選択することをお勧めします。たとえば、マルチテナントアプリケーションで特定のユーザーセッションをフィルター処理するためにクエリを頻繁に実行するワークロードでは、TenantId、UserId、SessionId の階層パーティションキーをその順序で利用できます。フィルターの述語にパーティションキーを含めることで、クエリ呼び出しを関係する物理パーティションにだけ効率的にルーティングできます。読み取り負荷の高いワークロードでのパーティションキー選択の詳細については、「パーティション分割の概要」に関するページを参照してください。

ユースケースの例

各テナントのユーザーのイベント情報を格納するマルチテナントシナリオがあるとします。このイベント情報には、サインイン、クリックストリーム、支払いイベントなどのイベント発生が含まれる場合がありますが、これらに限定されるものではありません。

実際のシナリオでは、一部のテナントは数千人のユーザーを抱える大規模なものになりますが、他の多くのテナントは少数のユーザーを抱える小規模なものです。 /TenantId によるパーティション分割では、1 つの論理パーティションで Azure Cosmos DB の 20 GB のストレージ制限を超える可能性があります。 /UserId によるパーティション分割では、テナント上のすべてのクエリがクロスパーティションになります。どちらの方法にも重大な欠点があります。

TenantId と UserId を組み合わせた合成パーティションキーを使用すると、アプリケーションが複雑になります。さらに、テナントの合成パーティションキークエリは、すべてのユーザーが事前にわかっていて指定されていない限り、クロスパーティションのままです。

階層パーティションキーを使用すると、最初に TenantId でパーティション分割し、次に UserId でパーティション分割できます。 TenantId と UserId の組み合わせによって生成されるパーティションが 20 GB を超えることが予想される場合は、さらに下位の別のレベル (SessionId など) にパーティション分割することもできます。全体的な深さは 3 つのレベルを超えることはできません。物理パーティションの記憶域が 50 GB を超えると、Azure Cosmos DB は物理パーティションを自動的に分割して、データの約半分が 1 つの物理パーティションに、半分がもう 1 つの物理パーティションに格納されるようにします。実質的に、サブパーティション分割とは、単一の TenantId 値が 20 GB のデータを超えることができ、TenantId のデータが複数の物理パーティションにまたがる可能性があることを意味します。

TenantId または TenantId と UserId の両方を指定するクエリは、関連するデータを含む物理パーティションのサブセットにのみ効率的にルーティングされます。完全またはプレフィックスのサブパーティション分割されたパーティションキーパスを指定することで、完全なファンアウトクエリを効率的に回避できます。たとえば、コンテナーに 1000 個の物理パーティションがあり、特定の TenantId 値がそのうちの 5 つにしかない場合、クエリは少数の関連する物理パーティションにのみルーティングされます。

階層内で項目 ID を使用する

コンテナーに、有効な値が広範囲にわたるプロパティがある場合は、そのプロパティは階層の最後のレベルのパーティションキーとして最適な選択肢となりえます。この種類のプロパティの 1 つの考えられる例が項目 ID です。 "項目 ID" のシステムプロパティは、コンテナー内のすべての項目に存在します。項目 ID を別のレベルとして追加すると、20 GB という論理パーティションキーの制限を超えるスケーリングが確実に可能となります。キーの最初のレベル、または最初のレベルと 2 番目のレベルでこの制限を超えてスケーリングできます。

たとえば、TenantId と UserId でパーティション分割されたマルチテナントワークロード用のコンテナーがあるとします。 TenantId と UserId のの組み合わせだけでは 20 GB を超える可能性がある場合は、3 つのレベルのキーを使用してパーティション分割することをお勧めします。ここで、3 番目のレベルのキーはカーディナリティが高いものを使用します。このシナリオの一例は、3 番目のレベルのキーが、必然的にカーディナリティが高い GUID である場合です。 TenantId と UserId、および GUID の組み合わせが 20 GB を超える可能性は低いので、TenantId と UserId の組み合わせを実質的に 20 GB を超えてスケーリングすることができます。

項目 ID をパーティションキーとして使用する方法の詳細については、「パーティション分割の概要」に関するページを参照してください。

はじめに

重要

階層パーティションキーを使うコンテナーの操作は、次の SDK バージョンでのみサポートされています。階層パーティションキーを持つ新しいコンテナーを作成し、データに対して作成、読み取り、更新、削除 (CRUD) の操作、またはクエリ操作を実行するには、サポートされている SDK を使用する必要があります。現在サポートされていない SDK またはコネクタを使用する場合は、コミュニティフォーラムで要求を提出してください。

サポートされている各 SDK の最新のプレビューバージョンを確認してください。

SDK	サポートされているバージョン	パッケージマネージャーのリンク
.NET SDK v3	>= 3.33.0	https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.33.0/
Java SDK v4	>= 4.42.0	https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos/CHANGELOG.md#4420-2023-03-17/
JavaScript SDK v4	4.0.0	https://www.npmjs.com/package/@azure/cosmos/
Python SDK	>= 4.6.0	https://pypi.org/project/azure-cosmos/4.6.0/

階層パーティションキーを使用してコンテナーを作成する

まず、最大 3 レベルまでのサブパーティション分割のキーパスの事前定義されたリストを使用して、新しいコンテナーを作成します。

次のいずれかのオプションを使用して、新しいコンテナーを作成します。

Azure portal
SDK
Azure Resource Manager テンプレート
Cosmos DB エミュレーター

Azure portal

コンテナーを作成して階層パーティションキーを指定する最も簡単な方法は、Azure portal を使用することです。

Azure portal にサインインします。
既存の Azure Cosmos DB for NoSQL アカウントページに移動します。
左側のメニューで、[データエクスプローラー] を選択します。
データエクスプローラーで、[新しいコンテナー] オプションを選択します。
新しいコンテナーの [パーティションキー] には /TenantId と入力します。残りのフィールドには、シナリオに適した値を入力します。

Note

ここでは、例として /TenantId を使用します。独自のコンテナーに階層パーティションキーを実装する場合は、最初のレベルには任意のキーを指定できます。
[階層パーティションキーの追加] を 2 回選択します。
サブパーティション分割の 2 番目と 3 番目の層では、/UserId と /SessionId をそれぞれ入力します。
[OK] を選択してコンテナーを作成します。

SDK

SDK を使用して新しいコンテナーを作成する場合は、サブパーティション分割のキーパスの一覧を最大 3 レベルまで定義します。新しいコンテナーのプロパティを構成するときは、サブパーティション分割のキーの一覧を使用します。

// List of partition keys, in hierarchical order. You can have up to three levels of keys.
List<string> subpartitionKeyPaths = new List<string> { 
    "/TenantId",
    "/UserId",
    "/SessionId"
};

// Create a container properties object
ContainerProperties containerProperties = new ContainerProperties(
    id: "<container-name>",
    partitionKeyPaths: subpartitionKeyPaths
);

// Create a container that's subpartitioned by TenantId > UserId > SessionId
Container container = await database.CreateContainerIfNotExistsAsync(containerProperties, throughput: 400);

// List of partition keys, in hierarchical order. You can have up to three levels of keys.
List<String> subpartitionKeyPaths = new ArrayList<String>();
subpartitionKeyPaths.add("/TenantId");
subpartitionKeyPaths.add("/UserId");
subpartitionKeyPaths.add("/SessionId");

//Create a partition key definition object with Kind ("MultiHash") and Version V2
PartitionKeyDefinition subpartitionKeyDefinition = new PartitionKeyDefinition();
subpartitionKeyDefinition.setPaths(subpartitionKeyPaths);
subpartitionKeyDefinition.setKind(PartitionKind.MULTI_HASH);
subpartitionKeyDefinition.setVersion(PartitionKeyDefinitionVersion.V2);

// Create a container properties object
CosmosContainerProperties containerProperties = new CosmosContainerProperties("<container-name>", subpartitionKeyDefinition);

// Create a throughput properties object
ThroughputProperties throughputProperties = ThroughputProperties.createManualThroughput(400);

// Create a container that's subpartitioned by TenantId > UserId > SessionId
Mono<CosmosContainerResponse> container = database.createContainerIfNotExists(containerProperties, throughputProperties);

const containerDefinition = {
  id: "Test Database",
  partitionKey: {
    paths: ["/name", "/address/zip"],
    version: PartitionKeyDefinitionVersion.V2,
    kind: PartitionKeyKind.MultiHash,
  },
}
const { container } = await database.containers.createIfNotExists(containerDefinition);
console.log(container.id);

container = database.create_container(
        id=container_name, partition_key=PartitionKey(path=["/tenantId", "/userId", "/sessionId"], kind="MultiHash")
    )

Azure Resource Manager のテンプレート

サブパーティション分割されたコンテナー用の Azure Resource Manager のテンプレートは、標準のコンテナーのものとほぼ同一です。唯一の重要な違いは、パスの properties/partitionKey 値です。 Azure Cosmos DB リソース用の Azure Resource Manager テンプレートの作成の詳細については、「Azure Cosmos DB の Azure Resource Manager テンプレートリファレンス」を参照してください。

次の表の値を使用して partitionKey オブジェクトを構成し、サブパーティション分割されたコンテナーを作成します。

パス	値
`paths`	階層パーティションキーの一覧 (最大 3 レベルの深さ)
`kind`	`MultiHash`
`version`	`2`

パーティションキー定義の例

たとえば、TenantId>UserId>SessionId で構成される階層パーティションキーがあるとします。 partitionKey オブジェクトは、paths プロパティの 3 つの値すべて、MultiHash の kind 値、および 2 のversion値を含むように構成されます。

Bicep
JSON

partitionKey: {
  paths: [
    '/TenantId'
    '/UserId'
    '/SessionId'
  ]
  kind: 'MultiHash'
  version: 2
}

"partitionKey": {
    "paths": [
        "/TenantId",
        "/UserId",
        "/SessionId"
    ],
    "kind": "MultiHash",
    "version": 2
}

partitionKey オブジェクトの詳細については、「ContainerPartitionKey の仕様」を参照してください。

Cosmos DB エミュレーター

Azure Cosmos DB 用の最新バージョンのローカルエミュレーターを使用して、サブパーティション分割機能をテストできます。エミュレーターでサブパーティション分割を有効にするには、/EnablePreview フラグを使用してインストールディレクトリからエミュレーターを起動します。

.\CosmosDB.Emulator.exe /EnablePreview

警告

エミュレーターは現在、ポータルとしてすべての階層パーティションキー機能をサポートしているわけではありません。エミュレーターでは現在、次の機能はサポートされていません。

データエクスプローラーを使用して階層パーティションキーを持つコンテナーを作成する
データエクスプローラーを使用して階層パーティションキーを使用して項目に移動して操作する

詳細については、「Azure Cosmos DB エミュレーター」を参照してください。

SDK を使用して階層パーティションキーを持つコンテナーを操作する

階層パーティションキーを持つコンテナーがある場合、上で指定したバージョンの .NET または Java SDK を使用してそのコンテナーに対して操作やクエリを実行します。

コンテナーに項目を追加する

階層パーティションキーが有効になっているコンテナーに新しい項目を追加するには、2 つのオプションがあります。

自動抽出
パスを手動で指定する

自動抽出

パーティションキー値が設定されたオブジェクトを渡すと、SDK は完全なパーティションキーパスを自動的に抽出できます。

// Create a new item
UserSession item = new UserSession()
{
    id = "f7da01b0-090b-41d2-8416-dacae09fbb4a",
    TenantId = "Microsoft",
    UserId = "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b",
    SessionId = "0000-11-0000-1111"
};

// Pass in the object, and the SDK automatically extracts the full partition key path
ItemResponse<UserSession> createResponse = await container.CreateItemAsync(item);

// Create a new item
UserSession item = new UserSession();
item.setId("f7da01b0-090b-41d2-8416-dacae09fbb4a");
item.setTenantId("Microsoft");
item.setUserId("8411f20f-be3e-416a-a3e7-dcd5a3c1f28b");
item.setSessionId("0000-11-0000-1111");
   
// Pass in the object, and the SDK automatically extracts the full partition key path
Mono<CosmosItemResponse<UserSession>> createResponse = container.createItem(item);

 // Create a new item
const item: UserSession = {
    Id: 'f7da01b0-090b-41d2-8416-dacae09fbb4a',
    TenantId: 'Microsoft',
    UserId: '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b',
    SessionId: '0000-11-0000-1111'
}

// Pass in the object, and the SDK automatically extracts the full partition key path
const { resource: document } = await = container.items.create(item);

# specify values for all fields on partition key path
item_definition = {'id': 'f7da01b0-090b-41d2-8416-dacae09fbb4a',
                        'tenantId': 'Microsoft',
                        'userId': '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b',
                        'sessionId': '0000-11-0000-1111'}

item = container.create_item(body=item_definition)

パスを手動で指定する

SDK の PartitionKeyBuilder クラスは、以前に定義した階層パーティションキーパスの値を構築できます。サブパーティション分割が有効になっているコンテナーに新しい項目を追加する場合は、このクラスを使用します。

ヒント

大規模な場合は、SDK がオブジェクトからパスを抽出できる場合でも、完全なパーティションキーパスを指定するとパフォーマンスが改善されることがあります。

// Create a new item object
PaymentEvent item = new PaymentEvent()
{
    id = Guid.NewGuid().ToString(),
    TenantId = "Microsoft",
    UserId = "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b",
    SessionId = "0000-11-0000-1111"
};

// Specify the full partition key path when creating the item
PartitionKey partitionKey = new PartitionKeyBuilder()
            .Add(item.TenantId)
            .Add(item.UserId)
            .Add(item.SessionId)
            .Build();

// Create the item in the container
ItemResponse<PaymentEvent> createResponse = await container.CreateItemAsync(item, partitionKey);

// Create a new item object
UserSession item = new UserSession();
item.setTenantId("Microsoft");
item.setUserId("8411f20f-be3e-416a-a3e7-dcd5a3c1f28b");
item.setSessionId("0000-11-0000-1111");
item.setId(UUID.randomUUID().toString());

// Specify the full partition key path when creating the item
PartitionKey partitionKey = new PartitionKeyBuilder()
            .add(item.getTenantId())
            .add(item.getUserId())
            .add(item.getSessionId())
            .build();
       
// Create the item in the container     
Mono<CosmosItemResponse<UserSession>> createResponse = container.createItem(item, partitionKey);

const item: UserSession = {
    Id: 'f7da01b0-090b-41d2-8416-dacae09fbb4a',
    TenantId: 'Microsoft',
    UserId: '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b',
    SessionId: '0000-11-0000-1111'
}

// Specify the full partition key path when creating the item
const partitionKey: PartitionKey = new PartitionKeyBuilder()
    .addValue(item.TenantId)
    .addValue(item.UserId)
    .addValue(item.SessionId)
    .build();

// Create the item in the container
const { resource: document } = await container.items.create(item, partitionKey);

Python の場合は、パーティションキーパス内のすべてのフィールドの値が項目定義で指定されていることを確認してください。

# specify values for all fields on partition key path
item_definition = {'id': 'f7da01b0-090b-41d2-8416-dacae09fbb4a',
                        'tenantId': 'Microsoft',
                        'userId': '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b',
                        'sessionId': '0000-11-0000-1111'}

item = container.create_item(body=item_definition)

項目のキー/値参照 (ポイント読み取り) を実行する

キー/値の参照 (ポイント読み取り) は、サブパーティション分割されていないコンテナーと同様の方法で実行されます。たとえば、TenantId>UserId>SessionId から成る階層パーティションキーがあるとします。アイテムの一意識別子は GUID です。これは、一意のドキュメントトランザクション識別子として機能する文字列として表されます。単一の項目に対してポイント読み取りを実行するには、項目の id プロパティと、パスの 3 つのコンポーネントすべてを含むパーティションキーの完全な値を渡します。

// Store the unique identifier
string id = "f7da01b0-090b-41d2-8416-dacae09fbb4a";

// Build the full partition key path
PartitionKey partitionKey = new PartitionKeyBuilder()
    .Add("Microsoft") //TenantId
    .Add("8411f20f-be3e-416a-a3e7-dcd5a3c1f28b") //UserId
    .Add("0000-11-0000-1111") //SessionId
    .Build();

// Perform a point read
ItemResponse<UserSession> readResponse = await container.ReadItemAsync<UserSession>(
    id,
    partitionKey
);

// Store the unique identifier
String id = "f7da01b0-090b-41d2-8416-dacae09fbb4a"; 

// Build the full partition key path
PartitionKey partitionKey = new PartitionKeyBuilder()
    .add("Microsoft") //TenantId
    .add("8411f20f-be3e-416a-a3e7-dcd5a3c1f28b") //UserId
    .add("0000-11-0000-1111") //SessionId
    .build();
    
// Perform a point read
Mono<CosmosItemResponse<UserSession>> readResponse = container.readItem(id, partitionKey, UserSession.class);

// Store the unique identifier
const id = "f7da01b0-090b-41d2-8416-dacae09fbb4a";

// Build the full partition key path
const partitionKey: PartitionKey = new PartitionKeyBuilder()
    .addValue(item.TenantId)
    .addValue(item.UserId)
    .addValue(item.SessionId)
    .build();

// Perform a point read
const { resource: document } = await container.item(id, partitionKey).read();

item_id = "f7da01b0-090b-41d2-8416-dacae09fbb4a"
pk = ["Microsoft", "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b", "0000-11-0000-1111"]
container.read_item(item=item_id, partition_key=pk)

クエリの実行

サブパーティション分割されたコンテナーでクエリを実行するために使用する SDK コードは、サブパーティション分割されていないコンテナーでクエリを実行する場合と同一です。

クエリで WHERE フィルター内またはキー階層のプレフィックス内のパーティションキーのすべての値が指定されると、SDK は対応する物理パーティションにクエリを自動的にルーティングします。階層の "中間" のみを提供するクエリは、クロスパーティションクエリです。

たとえば、TenantId>UserId>SessionId で構成される階層パーティションキーを考えてみましょう。クエリのフィルターのコンポーネントは、クエリが単一パーティションクエリ、ターゲットクロスパーティションクエリ、またはファンアウトクエリであるかどうかを判断します。

クエリ	ルーティング
`SELECT * FROM c WHERE c.TenantId = 'Microsoft' AND c.UserId = '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b' AND c.SessionId = '0000-11-0000-1111'`	`TenantId`、`UserId`、および `SessionId` の指定した値のデータを含む単一の論理パーティションと物理パーティションにルーティングされます。
`SELECT * FROM c WHERE c.TenantId = 'Microsoft' AND c.UserId = '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b'`	指定した値 `TenantId`、`UserId` のデータを含む論理パーティションと物理パーティションのターゲットサブセットにのみルーティングされます。このクエリは、テナント内の特定のユーザーのデータを返すターゲットクロスパーティションクエリです。
`SELECT * FROM c WHERE c.TenantId = 'Microsoft'`	指定した値 `TenantId` のデータを含む論理パーティションと物理パーティションのターゲットサブセットにのみルーティングされます。このクエリは、テナント内のすべてのユーザーのデータを返すターゲットクロスパーティションクエリです。
`SELECT * FROM c WHERE c.UserId = '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b'`	すべての物理パーティションにルーティングされ、その結果、ファンアウトクロスパーティションクエリが発生します。
`SELECT * FROM c WHERE c.SessionId = '0000-11-0000-1111'`	すべての物理パーティションにルーティングされ、その結果、ファンアウトクロスパーティションクエリが発生します。

サブパーティション分割コンテナーでの単一パーティションクエリ

すべてのサブパーティション分割レベルを含むクエリを実行する例を次に示します。このクエリは実質的に単一パーティションクエリになります。

// Define a single-partition query that specifies the full partition key path
QueryDefinition query = new QueryDefinition(
    "SELECT * FROM c WHERE c.TenantId = @tenant-id AND c.UserId = @user-id AND c.SessionId = @session-id")
    .WithParameter("@tenant-id", "Microsoft")
    .WithParameter("@user-id", "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b")
    .WithParameter("@session-id", "0000-11-0000-1111");

// Retrieve an iterator for the result set
using FeedIterator<PaymentEvent> results = container.GetItemQueryIterator<PaymentEvent>(query);

while (results.HasMoreResults)
{
    FeedResponse<UserSession> resultsPage = await resultSet.ReadNextAsync();
    foreach(UserSession result in resultsPage)
    {
        // Process result
    }
}

// Define a single-partition query that specifies the full partition key path
String query = String.format(
    "SELECT * FROM c WHERE c.TenantId = '%s' AND c.UserId = '%s' AND c.SessionId = '%s'",
    "Microsoft",
    "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b",
    "0000-11-0000-1111"
);

// Retrieve an iterator for the result set
CosmosPagedFlux<UserSession> pagedResponse = container.queryItems(
    query, options, UserSession.class);

pagedResponse.byPage().flatMap(fluxResponse -> {
    for (UserSession result : page.getResults()) {
        // Process result
    }
    return Flux.empty();
}).blockLast();

// Define a single-partition query that specifies the full partition key path
const query: string = "SELECT * FROM c WHERE c.TenantId = 'Microsoft' AND c.UserId = '8411f20f-be3e-416a-a3e7-dcd5a3c1f28b' AND c.SessionId = '0000-11-0000-1111'";

// Retrieve an iterator for the result set
const queryIterator = container.items.query(query);

while (queryIterator.hasMoreResults()) {
    const { resources: results } = await queryIterator.fetchNext();
    // Process result
}

pk = ["Microsoft", "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b", "0000-11-0000-1111"]
items = list(container.query_items(
    query="SELECT * FROM r WHERE r.tenantId=@tenant_id and r.userId=@user_id and r.sessionId=@session_id",
    parameters=[
        {"name": "@tenant_id", "value": pk[0]},
        {"name": "@user_id", "value": pk[1]},
        {"name": "@session_id", "value": pk[2]}
    ]
))

サブパーティション分割コンテナーでのターゲットマルチパーティションクエリ

サブパーティション分割のレベルのサブセットを含むクエリの例を次に示します。このクエリは事実上、対象となるマルチパーティションクエリになります。

// Define a targeted cross-partition query specifying prefix path[s]
QueryDefinition query = new QueryDefinition(
    "SELECT * FROM c WHERE c.TenantId = @tenant-id")
    .WithParameter("@tenant-id", "Microsoft")

// Retrieve an iterator for the result set
using FeedIterator<PaymentEvent> results = container.GetItemQueryIterator<PaymentEvent>(query);

while (results.HasMoreResults)
{
    FeedResponse<UserSession> resultsPage = await resultSet.ReadNextAsync();
    foreach(UserSession result in resultsPage)
    {
        // Process result
    }
}

// Define a targeted cross-partition query specifying prefix path[s]
String query = String.format(
    "SELECT * FROM c WHERE c.TenantId = '%s'",
    "Microsoft"
);

// Retrieve an iterator for the result set
CosmosPagedFlux<UserSession> pagedResponse = container.queryItems(
    query, options, UserSession.class);

pagedResponse.byPage().flatMap(fluxResponse -> {
    for (UserSession result : page.getResults()) {
        // Process result
    }
    return Flux.empty();
}).blockLast();

// Define a targeted cross-partition query specifying prefix path[s]
const query: string = "SELECT * FROM c WHERE c.TenantId = 'Microsoft'";

// Retrieve an iterator for the result set
const queryIterator = container.items.query(query);

while (queryIterator.hasMoreResults()) {
    const { resources: results } = await queryIterator.fetchNext();
    // Process result
}

pk = ["Microsoft", "8411f20f-be3e-416a-a3e7-dcd5a3c1f28b", "0000-11-0000-1111"]
# enable_cross_partition_query should be set to True as the container is partitioned
items = list(container.query_items(
    query="SELECT * FROM r WHERE r.tenantId=@tenant_id and r.userId=@user_id",
    parameters=[
        {"name": "@tenant_id", "value": pk[0]},
        {"name": "@user_id", "value": pk[1]}
    ],
    enable_cross_partition_query=True
))

制限事項と既知の問題

階層パーティションキーを使用するコンテナーの操作は、.NET v3、Java v4 SDK、および、JavaScript SDK のプレビューバージョンでのみサポートされています。階層パーティションキーを持つ新しいコンテナーを作成し、データに対して CRUD 操作またはクエリ操作を実行するには、サポートされている SDK を使用する必要があります。 Python を含む他の SDK のサポートは現在利用できません。
さまざまな Azure Cosmos DB コネクタには制限があります (例えば、Azure Data Factory)。
階層パーティションキーの深さは、最大 3 層までのみ指定できます。
階層パーティションキーは現在、新しいコンテナーでのみ有効にすることができます。コンテナーの作成時にパーティションキーパスを設定する必要があり、後で変更することはできません。既存のコンテナーで階層パーティションを使用するには、階層パーティションキーが設定された新しいコンテナーを作成し、コンテナーコピージョブを使用してデータを移動します。
階層パーティションキーは、NoSQL 用 API アカウントでのみサポートされています。 MongoDB 用 API および Cassandra 用 API は現在サポートされていません。
階層型パーティションキーは、現在、アクセス許可機能ではサポートされていません。階層パーティションキーパスの部分的なプレフィックスにアクセス許可を割り当てることはできません。アクセス許可は、論理パーティションキーパス全体にのみ割り当てることができます。たとえば、TenantId - >UserId でパーティション分割した場合、TenantId の特定の値に対するアクセス許可を割り当てることはできません。ただし、TenantId と "UserId" の両方の値を指定する場合は、パーティションキーのアクセス許可を割り当てることができます。

次のステップ

階層パーティションキーに関する FAQ を参照する。
Azure Cosmos DB でのパーティション分割の詳細を確認する。
Azure Cosmos DB で Azure Resource Manager テンプレートを使用するの詳細を確認する。

Azure Cosmos DB での階層パーティション キー

階層パーティション キーを選択する

ユース ケースの例