コレクションの取得
特定のコレクション リソースに対して GET を実行すると、コレクションのプロパティを取得できます。
注意
これらの API リファレンス記事では、Azure Cosmos DB データ プレーン API を使用してリソースを作成する方法について説明します。 データ プレーン API を使用すると、Cosmos DB SDK と同様に、インデックス作成ポリシー、パーティション キーなどの基本的なオプションを構成できます。 すべての Azure Cosmos DB リソースの完全な機能サポートが必要な場合は、 Cosmos DB リソース プロバイダーを使用することをお勧めします。
Request
| Method | 要求 URI | 説明 |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} | {databaseaccount} は、サブスクリプションの下に作成された Azure Cosmos DB アカウントの名前です。 {db-id} 値は、システムによって生成された ID (rid) ではなく、データベースのユーザーによって生成された名前/ID です。 {coll-id} 値はコレクションの名前です。 |
ヘッダー
すべての Cosmos DB 要求 で使用されるヘッダーについては、「共通の Azure Cosmos DB REST 要求ヘッダー」を参照してください。
本文
なし。
[応答]
Get Collection は、コレクションのクォータと使用状況を報告する応答ヘッダーと共に、Cosmos DB に永続化されているコレクションの本文を返します。
ヘッダー
すべての Cosmos DB 応答によって返されるヘッダーについては、「 共通の Azure Cosmos DB REST 応答ヘッダー 」を参照してください。
状態コード
次の表に、この操作で返される一般的なステータス コードを示します。 状態コードの完全な一覧については、「 HTTP 状態コード」を参照してください。
| HTTP 状態コード | 説明 |
|---|---|
| 200 Ok | 操作に成功しました。 |
| 404 見つかりません | コレクションはリソースではなく、つまりコレクションが削除されました。 |
Body
| プロパティ | 説明 |
|---|---|
| id | これは、新しいコレクションを識別する一意の名前です。 |
| _解消 | これは、システムによって生成されるプロパティです。 リソース ID (_rid) は、リソース モデル上のリソース スタックごとに階層化された一意識別子です。 アクセス許可リソースの配置およびナビゲーションのために内部的に使用されます。 |
| _Ts | これは、システムによって生成されるプロパティです。 リソースの最終更新タイムスタンプを示します。 値は、タイムスタンプです。 |
| _自己 | これは、システムによって生成されるプロパティです。 リソースの一意のアドレス指定が可能な URI です。 |
| _Etag | これは、オプティミスティック コンカレンシー制御に必要なリソース etag を表すシステム生成プロパティです。 |
| _ドキュメント | ドキュメント リソースのアドレス指定可能パスを指定するシステム生成プロパティです。 |
| _Sprocs | ストアド プロシージャ (sprocs) リソースのアドレス指定可能パスを指定するシステム生成プロパティです。 |
| _トリガー | トリガー リソースのアドレス指定可能パスを指定するシステム生成プロパティです。 |
| _Udf | これは、ユーザー定義関数 (udfs) リソースのアドレス指定可能パスを指定するシステム生成プロパティです。 |
| _競合 | 競合するリソースのアドレス指定可能パスを指定するシステム生成プロパティです。 コレクション内のリソースに対する操作で競合が発生した場合は、ユーザーが競合の URI パスに GET を実行して、競合しているリソースを検査することができます。 |
| indexingPolicy | コレクションのインデックス作成ポリシー設定です。 |
[インデックス作成ポリシー] のプロパティ
| プロパティ | Description |
|---|---|
| 自動 | 自動インデックス作成が有効か無効かを示します。 既定値は True であるため、すべてのドキュメントにインデックスが作成されます。 値を False に設定すると、インデックス作成パスの手動構成が可能になります。 |
| indexingMode | 既定では、インデックス作成モードは [一貫性] です。 つまり、インデックス作成は、ドキュメントの挿入、置換、または削除中に同期的に行われます。 非同期的にインデックスを作成するには、インデックス作成モードを [遅延] に設定します。 |
| includedPaths | インデックスが作成されるドキュメントのパスを含む配列。 既定では、2 つのパスが含まれます。すべてのドキュメント パスにインデックスを作成することを指定する / パスと、タイムスタンプ範囲比較のインデックスを作成する_ts パスです。 配列内の 要素内。 |
[インクルード パス] のプロパティ
| プロパティ | 説明 |
|---|---|
| path | インデックス作成の動作が適用されるパス。 インデックス パスはルート (/) で始まり、通常は疑問符 (?) ワイルドカード演算子で終わり、プレフィックスに複数の値が指定可能であることを示します。 たとえば、SELECT * FROM Families F WHERE F.familyName = "Andersen" を処理するには、コレクションのインデックス ポリシーに /familyName/? の インデックスのパスを含める必要があります。 インデックスのパスは * ワイルドカード演算子を使用して、プレフィックスの後ろに続くパスの動作を再帰的に指定することもできます。 たとえば、/payload/* を使用して、ペイロード プロパティの下に属するものをすべてインデックス作成から除外できます。 |
| dataType | インデックス作成の動作が適用されるデータ型です。 String、Number、Point、Polygon、LineString のいずれかを指定できます。 ブール値と null 値は自動的にインデックスが作成されます |
| kind | インデックスの種類です。 ハッシュ インデックスは等値比較に役立ちますが、 Range インデックスは等値、範囲比較、並べ替えに役立ちます。 空間 インデックスは、空間クエリに役立ちます。 |
| 有効桁数 (precision) | インデックスの有効桁数。 最大有効桁数の場合は -1、 数値の場合は 1 から 8、 文字列の場合は 1 から 100 に設定できます。 Point、Polygon、LineString のデータ型には適用されません。 |
[パーティション キー] のプロパティ
| プロパティ | Description |
|---|---|
| パス | コレクション内のデータをパーティション分割できるパスの配列。 パスには、ワイルドカードまたは末尾のスラッシュを含めてはなりません。 たとえば、JSON プロパティ "AccountNumber" は "/AccountNumber" として指定されます。 配列には 1 つの値のみを含む必要があります。 |
| kind | パーティション分割に使用されるアルゴリズム。 Hash のみがサポートされています。 |
{
"id": "testcoll",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "String",
"precision": -1
},
{
"kind": "Range",
"dataType": "Number",
"precision": -1
}
]
}
],
"excludedPaths": []
},
"partitionKey": {
"paths": [
"/AccountNumber"
],
"kind": "Hash"
},
"_rid": "1tAvAP4XWww=",
"_ts": 1459198933,
"_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",
"_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}
例
GET https://querydemo.documents.azure.com/dbs/testdb/colls HTTP/1.1
x-ms-offer-throughput: 1000
x-ms-date: Mon, 28 Mar 2016 21:02:12 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dP8r7%2fEZnOxv2wQr2smp4G1tCH9PkOkIZscHqsqdn6y4%3d
Cache-Control: no-cache
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0
x-ms-version: 2015-12-16
Accept: application/json
Host: querydemo.documents.azure.com
Content-Length: 235
Expect: 100-continue
HTTP/1.1 201 Created
Cache-Control: no-store, no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Mon, 28 Mar 2016 20:10:13.601 GMT
etag: "00005600-0000-0000-0000-56f99bd50000"
collection-partition-index: 0
collection-service-index: 24
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/testdb
x-ms-quorum-acked-lsn: 6
x-ms-current-write-quorum: 3
x-ms-current-replica-set-size: 4
x-ms-request-charge: 4.95
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: fbc3f36d-15d5-45fa-8f19-8579945451f8
x-ms-session-token: 0:7
Set-Cookie: x-ms-session-token#0=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=
Set-Cookie: x-ms-session-token=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=
x-ms-gatewayversion: version=1.6.52.5
Date: Mon, 28 Mar 2016 21:02:13 GMT
{
"id": "testcoll",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "String",
"precision": -1
},
{
"kind": "Range",
"dataType": "Number",
"precision": -1
}
]
}
],
"excludedPaths": []
},
"partitionKey": {
"paths": [
"/AccountNumber"
],
"kind": "Hash"
},
"_rid": "1tAvAP4XWww=",
"_ts": 1459198933,
"_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",
"_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}