Pobieranie kolekcji
Wykonanie operacji GET dla określonego zasobu kolekcji pobiera właściwości kolekcji.
Uwaga
W tych artykułach referencyjnych interfejsu API pokazano, jak tworzyć zasoby przy użyciu interfejsu API płaszczyzny danych usługi Azure Cosmos DB. Za pomocą interfejsu API płaszczyzny danych można skonfigurować podstawowe opcje, takie jak zasady indeksowania, klucze partycji, podobnie jak w przypadku zestawów SDK usługi Cosmos DB. Jeśli potrzebujesz pełnej obsługi funkcji dla wszystkich zasobów usługi Azure Cosmos DB, zalecamy użycie dostawcy zasobów usługi Cosmos DB.
Żądanie
| Metoda | Identyfikator URI żądania | Opis |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} | {databaseaccount} to nazwa konta usługi Azure Cosmos DB utworzonego w ramach subskrypcji. Wartość {db-id} to wygenerowana przez użytkownika nazwa/identyfikator bazy danych, a nie identyfikator wygenerowany przez system (rid). Wartość {coll-id} jest nazwą kolekcji. |
Nagłówki
Zobacz Typowe nagłówki żądań REST usługi Azure Cosmos DB dla nagłówków , które są używane przez wszystkie żądania usługi Cosmos DB.
Treść
Brak.
Reakcja
Polecenie Get Collection zwraca treść kolekcji utrwalonej w usłudze Cosmos DB wraz z nagłówkami odpowiedzi, które zgłaszają limit przydziału i użycie kolekcji.
Nagłówki
Zobacz Typowe nagłówki odpowiedzi REST usługi Azure Cosmos DB dla nagłówków zwracanych przez wszystkie odpowiedzi usługi Cosmos DB.
Kody stanu
W poniższej tabeli wymieniono typowe kody stanu zwracane przez tę operację. Aby uzyskać pełną listę kodów stanu, zobacz Kody stanu HTTP.
| Kod stanu HTTP | Opis |
|---|---|
| 200 OK | Operacja zakończyła się pomyślnie. |
| 404 — Nie znaleziono | Kolekcja nie jest już zasobem, czyli kolekcja została usunięta. |
Treść
| Właściwość | Opis |
|---|---|
| id | Jest to unikatowa nazwa identyfikująca nową kolekcję. |
| _Rid | Jest to właściwość wygenerowana przez system. Identyfikator zasobu (_rid) jest unikatowym identyfikatorem, który jest również hierarchiczny dla stosu zasobów w modelu zasobów. Jest on używany wewnętrznie do umieszczania i nawigacji zasobu uprawnień. |
| _Ts | Jest to właściwość wygenerowana przez system. Określa ostatni zaktualizowany znacznik czasu zasobu. Wartość jest znacznikiem czasu. |
| _Własny | Jest to właściwość wygenerowana przez system. Jest to unikatowy adresowy identyfikator URI zasobu. |
| _Etag | Jest to właściwość wygenerowana przez system reprezentująca tag zasobu wymagany do optymistycznej kontroli współbieżności. |
| _Dok | Jest to właściwość wygenerowana przez system, która określa adresową ścieżkę zasobu dokumentów. |
| _sprocs | Jest to właściwość wygenerowana przez system, która określa adresową ścieżkę zasobu procedur składowanych (sprocs). |
| _Wyzwalaczy | Jest to właściwość wygenerowana przez system, która określa adresową ścieżkę zasobu wyzwalaczy. |
| _Udfs | Jest to właściwość wygenerowana przez system, która określa adresową ścieżkę zasobu funkcji zdefiniowanych przez użytkownika (udfs). |
| _Konflikty | Jest to właściwość wygenerowana przez system, która określa adresową ścieżkę zasobu konfliktów. Podczas operacji na zasobie w kolekcji, jeśli wystąpi konflikt, użytkownicy mogą sprawdzić zasoby powodujące konflikt, wykonując get na ścieżce identyfikatora URI konfliktów. |
| indexingPolicy | Są to ustawienia zasad indeksowania dla kolekcji. |
Właściwości w obszarze Zasady indeksowania
| Właściwość | Opis |
|---|---|
| Automatyczne | Wskazuje, czy automatyczne indeksowanie jest włączone, czy wyłączone. Wartość domyślna to True, dlatego wszystkie dokumenty są indeksowane. Ustawienie wartości false spowoduje ręczne skonfigurowanie ścieżek indeksowania. |
| indexingMode | Domyślnie tryb indeksowania jest spójny. Oznacza to, że indeksowanie odbywa się synchronicznie podczas wstawiania, zastępowania lub usuwania dokumentów. Aby indeksowanie miało miejsce asynchronicznie, ustaw tryb indeksowania na leniwy. |
| includedPaths | Tablica zawierająca ścieżki dokumentów do indeksowania. Domyślnie dołączane są dwie ścieżki: / ścieżka, która określa, że wszystkie ścieżki dokumentu mają być indeksowane, oraz ścieżkę _ts, która indeksuje dla porównania zakresu sygnatur czasowych. Wewnątrz elementu w tablicy. |
Właściwości w obszarze Dołączona ścieżka
| Właściwość | Opis |
|---|---|
| Ścieżka | Ścieżka, do której ma zastosowanie zachowanie indeksowania. Ścieżki indeksu zaczynają się od katalogu głównego (/) i zwykle kończą się operatorem wieloznacznymi znaku zapytania (?), co oznacza, że istnieje wiele możliwych wartości prefiksu. Aby na przykład służyć SELECT * FROM Families F WHERE F.familyName = "Andersen", musisz dołączyć ścieżkę indeksu dla /familyName/? w zasadach indeksu kolekcji. Ścieżki indeksów mogą również używać operatora symboli wieloznacznych * do określania zachowania ścieżek rekursywnie pod prefiksem. Na przykład /payload/* może służyć do wykluczania wszystkiego pod właściwością ładunku z indeksowania. |
| Datatype | Jest to typ danych, dla którego jest stosowane zachowanie indeksowania. Może to być ciąg, liczba, punkt, wielokąt lub ciąg liniowy. Wartości logiczne i null są automatycznie indeksowane |
| Rodzaju | Typ indeksu. Indeksy skrótów są przydatne w przypadku porównań równości, podczas gdy indeksy zakresu są przydatne w przypadku równości, porównań zakresów i sortowania. Indeksy przestrzenne są przydatne w przypadku zapytań przestrzennych. |
| Precyzji | Precyzja indeksu. Można ustawić wartość -1 dla maksymalnej dokładności lub od 1 do 8 dla wartości Liczba i 1–100 dla ciągu. Nie dotyczy typów danych Point, Polygon i LineString . |
Właściwości w obszarze Klucz partycji
| Właściwość | Opis |
|---|---|
| Ścieżki | Tablica ścieżek, przy użyciu których można partycjonować dane w kolekcji. Ścieżki nie mogą zawierać symbolu wieloznakowego ani ukośnika końcowego. Na przykład właściwość JSON "AccountNumber" jest określona jako "/AccountNumber". Tablica musi zawierać tylko jedną wartość. |
| Rodzaju | Algorytm używany do partycjonowania. Obsługiwane jest tylko skróty . |
{
"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/"
}
Przykład
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/"
}