Koleksiyon Alma

  • Makale

Belirli bir koleksiyon kaynağında GET gerçekleştirmek, koleksiyonun özelliklerini alır.

Not

Bu API başvuru makalelerinde Azure Cosmos DB veri düzlemi API'sini kullanarak kaynak oluşturma adımları gösterilmektedir. Veri düzlemi API'siyle dizin oluşturma ilkesi, bölüm anahtarları gibi cosmos DB SDK'ları gibi temel seçenekleri yapılandırabilirsiniz. Tüm Azure Cosmos DB kaynakları için tam özellik desteğine ihtiyacınız varsa Cosmos DB Kaynak Sağlayıcısı'nı kullanmanızı öneririz.

İstek

Yöntem İstek URI'si Açıklama
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} {databaseaccount}, aboneliğiniz altında oluşturulan Azure Cosmos DB hesabının adıdır. {db-id} değeri, sistem tarafından oluşturulan kimlik (rid) değil, veritabanının kullanıcı tarafından oluşturulan adı/kimliğidir. {coll-id} değeri koleksiyonun adıdır.

Üst Bilgiler

Tüm Cosmos DB istekleri tarafından kullanılan üst bilgiler için bkz. Yaygın Azure Cosmos DB REST isteği üst bilgileri.

Gövde

Yok.

Yanıt

Get Collection, cosmos DB'de kalıcı olarak koleksiyonun gövdesini ve koleksiyonun kotasını ve kullanımını bildiren yanıt üst bilgilerini döndürür.

Üst Bilgiler

Tüm Cosmos DB yanıtları tarafından döndürülen üst bilgiler için bkz. Genel Azure Cosmos DB REST yanıt üst bilgileri.

Durum kodları

Aşağıdaki tabloda bu işlem tarafından döndürülen genel durum kodları listelenmektedir. Durum kodlarının tam listesi için bkz. HTTP Durum Kodları.

HTTP durum kodu Açıklama
200 Tamam İşlem başarılı oldu.
404 Bulunamadı Koleksiyon artık bir kaynak değil, yani koleksiyon silindi.

Gövde

Özellik Açıklama
id Yeni koleksiyonu tanımlayan benzersiz addır.
_Kurtulmak Sistem tarafından oluşturulan bir özelliktir. Kaynak kimliği (_rid), kaynak modelinde kaynak yığını başına da hiyerarşik olan benzersiz bir tanımlayıcıdır. İzin kaynağının yerleşimi ve gezintisi için dahili olarak kullanılır.
_Ts Sistem tarafından oluşturulan bir özelliktir. Kaynağın son güncelleştirilmiş zaman damgasını belirtir. Değer bir zaman damgasıdır.
_Kendini Sistem tarafından oluşturulan bir özelliktir. Kaynak için benzersiz adreslenebilir URI'dir.
_Etag İyimser eşzamanlılık denetimi için gereken kaynak etag'ini temsil eden sistem tarafından oluşturulan bir özelliktir.
_Doktor Belge kaynağının adreslenebilir yolunu belirten sistem tarafından oluşturulan bir özelliktir.
_sprocs Saklı yordamlar (sprocs) kaynağının adreslenebilir yolunu belirten sistem tarafından oluşturulan bir özelliktir.
_Tetikleyiciler Tetikleyiciler kaynağının adreslenebilir yolunu belirten sistem tarafından oluşturulan bir özelliktir.
_udfs Kullanıcı tanımlı işlevler (udfs) kaynağının adreslenebilir yolunu belirten sistem tarafından oluşturulan bir özelliktir.
_Çakışma Çakışma kaynağının adreslenebilir yolunu belirten sistem tarafından oluşturulan bir özelliktir. Bir koleksiyondaki bir kaynak üzerinde yapılan işlem sırasında, çakışma oluşursa, kullanıcılar çakışmalar URI yolunda bir GET gerçekleştirerek çakışan kaynakları inceleyebilir.
indexingPolicy Koleksiyon için dizin oluşturma ilkesi ayarlarıdır.

Dizin Oluşturma İlkesi altındaki özellikler

Özellik Açıklama
otomatik Otomatik dizin oluşturmanın açık mı yoksa kapalı mı olduğunu gösterir. Varsayılan değer True olduğundan tüm belgeler dizine eklenir. Değerin False olarak ayarlanması dizin oluşturma yollarının el ile yapılandırılmasına olanak tanır.
indexingMode Dizin oluşturma modu varsayılan olarak Tutarlı'dır. Bu, dizin oluşturmanın belgelerin eklenmesi, değiştirilmesi veya silinmesi sırasında zaman uyumlu olarak gerçekleştiği anlamına gelir. Dizin oluşturmanın zaman uyumsuz olarak gerçekleşmesi için dizin oluşturma modunu gecikmeli olarak ayarlayın.
includedPaths Dizine eklenecek belge yollarını içeren dizi. Varsayılan olarak, iki yol eklenir: tüm belge yollarının dizine alındığını belirten / yolu ve zaman damgası aralığı karşılaştırması için dizin oluşturan _ts yolu.

Dizideki öğesi içinde.

Eklenen Yol altındaki özellikler

Özellik Açıklama
Yolu Dizin oluşturma davranışının uygulandığı yol. Dizin yolları kök (/) ile başlar ve genellikle ön ek için birden çok olası değer olduğunu belirten soru işareti (?) joker işleciyle biter. Örneğin, SELECT * FROM Families F WHERE F.familyName = "Andersen" hizmeti vermek için /familyName/? için bir dizin yolu eklemeniz gerekir. öğesini seçin.

Dizin yolları, ön ek altında özyinelemeli olarak yolların davranışını belirtmek için * joker karakter işlecini de kullanabilir. Örneğin, /payload/* payload özelliğinin altındaki her şeyi dizin oluşturmanın dışında tutmak için kullanılabilir.
Datatype Dizin oluşturma davranışının uygulandığı veri türüdür. Dize, Sayı, Nokta, Çokgen veya LineString olabilir. Boole değerleri ve null değerleri otomatik olarak dizine eklenir
Tür Dizin türü. Karma dizinler eşitlik karşılaştırmaları için, Aralık dizinleri ise eşitlik, aralık karşılaştırmaları ve sıralama için yararlıdır. Uzamsal dizinler uzamsal sorgular için yararlıdır.
Hassas Dizinin duyarlığı. Maksimum duyarlık için -1 olarak veya Sayı için 1-8 arasında ve Dize için 1-100 olarak ayarlanabilir. Point, Polygon ve LineString veri türleri için geçerli değildir.

Bölüm Anahtarı altındaki özellikler

Özellik Açıklama
Yol Koleksiyondaki hangi verilerin bölümlenebileceğini kullanan bir yol dizisi. Yollar joker karakter veya sondaki eğik çizgi içermemelidir. Örneğin, "AccountNumber" JSON özelliği "/AccountNumber" olarak belirtilir. Dizi yalnızca tek bir değer içermelidir.
Tür Bölümleme için kullanılan algoritma. Yalnızca Karma desteklenir. 
{  
  "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/"  
}

Örnek

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/"  
}

Ayrıca Bkz.