Hämta en samling
Om du utför en GET på en specifik samlingsresurs hämtas egenskaperna för samlingen.
Anteckning
Dessa API-referensartiklar visar hur du skapar resurser med hjälp av Azure Cosmos DB-dataplans-API:et. Med API:et för dataplanet kan du konfigurera grundläggande alternativ, till exempel indexeringsprincip, partitionsnycklar ungefär som du kan med Cosmos DB-SDK:er. Om du behöver fullständigt funktionsstöd för alla Azure Cosmos DB-resurser rekommenderar vi att du använder Cosmos DB-resursprovidern.
Förfrågan
| Metod | URI för förfrågan | Beskrivning |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} | {databaseaccount} är namnet på det Azure Cosmos DB-konto som skapats under din prenumeration. Värdet {db-id} är det användargenererade namnet/ID:t för databasen, inte det systemgenererade ID:t (rid). Värdet {coll-id} är namnet på samlingen. |
Sidhuvuden
Se Vanliga REST-begärandehuvuden för Azure Cosmos DB för rubriker som används av alla Cosmos DB-begäranden.
Brödtext
Inga.
Svarsåtgärder
Hämta samling returnerar brödtexten i samlingen enligt beständighet i Cosmos DB tillsammans med svarshuvuden som rapporterar kvoten och användningen av samlingen.
Sidhuvuden
Se Vanliga REST-svarshuvuden för Azure Cosmos DB för rubriker som returneras av alla Cosmos DB-svar.
Statuskoder
I följande tabell visas vanliga statuskoder som returneras av den här åtgärden. En fullständig lista över statuskoder finns i HTTP-statuskoder.
| HTTP-statuskod | Beskrivning |
|---|---|
| 200 Ok | Åtgärden lyckades. |
| 404 – Hittades inte | Samlingen är inte längre en resurs, det vill sa att samlingen har tagits bort. |
Brödtext
| Egenskap | Beskrivning |
|---|---|
| id | Det är det unika namnet som identifierar den nya samlingen. |
| _Bli | Det är en systemgenererad egenskap. Resurs-ID :t (_rid) är en unik identifierare som också är hierarkisk per resursstacken i resursmodellen. Den används internt för placering och navigering av behörighetsresursen. |
| _Ts | Det är en systemgenererad egenskap. Den anger den senast uppdaterade tidsstämpeln för resursen. Värdet är en tidsstämpel. |
| _Själv | Det är en systemgenererad egenskap. Det är den unika adresserbara URI:n för resursen. |
| _Etag | Det är en systemgenererad egenskap som representerar resursetaggen som krävs för optimistisk samtidighetskontroll. |
| _Doc | Det är en systemgenererad egenskap som anger dokumentresursens adresserbara sökväg. |
| _sprocs | Det är en systemgenererad egenskap som anger den adresserbara sökvägen för resursen för lagrade procedurer (sprocs). |
| _Utlösare | Det är en systemgenererad egenskap som anger den adresserbara sökvägen för utlösarresursen. |
| _udfs | Det är en systemgenererad egenskap som anger den adresserbara sökvägen för den användardefinierade funktionsresursen (udfs). |
| _Konflikter | Det är en systemgenererad egenskap som anger den adresserbara sökvägen för konfliktresursen. Om en konflikt uppstår under en åtgärd på en resurs i en samling kan användarna inspektera de resurser som står i konflikt genom att utföra en GET på URI-sökvägen för konflikter. |
| indexingPolicy | Det är indexeringsprincipinställningarna för samlingen. |
Egenskaper under indexeringsprincip
| Egenskap | Beskrivning |
|---|---|
| automatiskt | Anger om automatisk indexering är på eller av. Standardvärdet är True, vilket innebär att alla dokument indexeras. Om värdet anges till False tillåts manuell konfiguration av indexeringssökvägar. |
| indexingMode | Indexeringsläget är konsekvent som standard. Det innebär att indexering sker synkront under infogning, ersättning eller borttagning av dokument. Om du vill att indexeringen ska ske asynkront anger du indexeringsläget till uppskjutet. |
| includedPaths | Matrisen som innehåller dokumentsökvägar som ska indexeras. Som standard ingår två sökvägar: sökvägen/som anger att alla dokumentsökvägar indexeras och den _ts sökvägen, som indexerar för en jämförelse av tidsstämpelintervall. Inom elementet i matrisen. |
Egenskaper under Inkluderad sökväg
| Egenskap | Beskrivning |
|---|---|
| Sökvägen | Sökväg som indexeringsbeteendet gäller för. Indexsökvägar börjar med roten (/) och slutar vanligtvis med jokertecknet (?), vilket anger att det finns flera möjliga värden för prefixet. Om du till exempel vill visa SELECT * FROM Families F WHERE F.familyName = "Andersen" måste du inkludera en indexsökväg för /familyName/? i samlingens indexprincip. Indexsökvägar kan också använda operatorn * jokertecken för att ange beteendet för sökvägar rekursivt under prefixet . Till exempel kan /payload/* användas för att undanta allt under nyttolastegenskapen från indexering. |
| Datatyp | Det är den datatyp som indexeringsbeteendet tillämpas på. Kan vara String, Number, Point, Polygon eller LineString. Booleska värden och nullvärden indexeras automatiskt |
| Typ | Typ av index. Hash-index är användbara för likhetsjämförelser medan Intervallindex är användbara för likhet, intervalljämförelser och sortering. Rumsliga index är användbara för rumsliga frågor. |
| Precision | Indexets precision. Kan antingen anges till -1 för maximal precision eller mellan 1–8 för Tal och 1–100 för Sträng. Gäller inte för datatyperna Point, Polygon och LineString . |
Egenskaper under partitionsnyckel
| Egenskap | Beskrivning |
|---|---|
| Sökvägar | En matris med sökvägar som använder vilka data i samlingen som kan partitioneras. Sökvägar får inte innehålla jokertecken eller avslutande snedstreck. JSON-egenskapen "AccountNumber" anges till exempel som "/AccountNumber". Matrisen får bara innehålla ett enda värde. |
| Typ | Algoritmen som används för partitionering. Endast hash stöds. |
{
"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/"
}
Exempel
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/"
}