Obter uma coleção
Execução de GET em um recurso de coleção específico recupera as propriedades da coleção.
Observação
Esses artigos de referência de API mostram como criar recursos usando a API do plano de dados do Azure Cosmos DB. Com a API do plano de dados, você pode configurar opções básicas, como a política de indexação, chaves de partição da mesma forma que você pode com os SDKs do Cosmos DB. Se você precisar de suporte completo a recursos para todos os recursos do Azure Cosmos DB, recomendamos usar o Provedor de Recursos do Cosmos DB.
Solicitação
| Método | URI da solicitação | Descrição |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} | O {databaseaccount} é o nome da conta do Azure Cosmos DB criada em sua assinatura. O valor {db-id} é o nome/ID gerado pelo usuário do banco de dados, não a ID gerada pelo sistema (rid). O valor de {coll-id} é o nome da coleção. |
Cabeçalhos
Confira Cabeçalhos comuns de solicitação REST do Azure Cosmos DB para cabeçalhos usados por todas as solicitações do Cosmos DB.
Corpo
Nenhum.
Resposta
Get Collection retorna o corpo da coleção, conforme persistido no Cosmos DB, juntamente com cabeçalhos de resposta que relatam a cota e o uso da coleção.
Cabeçalhos
Confira Cabeçalhos comuns de resposta REST do Azure Cosmos DB para cabeçalhos retornados por todas as respostas do Cosmos DB.
Códigos de status
A tabela a seguir lista os códigos de status comuns retornados por esta operação. Para obter uma lista completa de códigos de status, consulte Códigos de status HTTP.
| Código de status HTTP | Descrição |
|---|---|
| 200 Ok | A operação foi bem-sucedida. |
| 404 Não Encontrado | A coleção não é mais um recurso, ou seja, a coleção foi excluída. |
Corpo
| Propriedade | Descrição |
|---|---|
| id | É o nome exclusivo que identifica a nova coleção. |
| _Livrar | É uma propriedade gerada pelo sistema. A ID do recurso (_rid) é um identificador exclusivo que também é hierárquico de acordo com a pilha de recursos no modelo de recurso. É usada internamente para posicionamento e navegação do recurso de permissão. |
| _Ts | É uma propriedade gerada pelo sistema. Especifica o último carimbo de data/hora atualizado do recurso. O valor é um carimbo de data/hora. |
| _Auto | É uma propriedade gerada pelo sistema. É o URI endereçável exclusivo do recurso. |
| _Etag | É uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista. |
| _Doc | É uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso de documentos. |
| _sprocs | É uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso de procedimentos armazenados (sprocs). |
| _Gatilhos | É uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso de gatilhos. |
| _Udfs | É uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso udfs (funções definidas pelo usuário). |
| _Conflitos | É uma propriedade gerada pelo sistema que especifica o caminho endereçável do recurso de conflitos. Durante uma operação em um recurso dentro de uma coleção, se ocorrer um conflito, os usuários podem inspecionar os recursos conflitantes executando um GET no caminho do URI de conflitos. |
| indexingPolicy | São as configurações de política de indexação para coleção. |
Propriedades em Política de Indexação
| Propriedade | Descrição |
|---|---|
| Automático | Indica se a indexação automática está ativada ou desativada. O valor padrão é True, portanto, todos os documentos são indexados. Definir o valor como False permitiria a configuração manual dos caminhos de indexação. |
| indexingMode | Por padrão, o modo de indexação é Consistente. Isso significa que a indexação ocorre de forma síncrona durante a inserção, substituição ou exclusão de documentos. Para que a indexação ocorra de modo assíncrono, defina o modo de indexação para lento. |
| includedPaths | A matriz que contém os caminhos dos documentos a serem indexados. Por padrão, dois caminhos são incluídos: o /path, que especifica que todos os caminhos do documento sejam indexados e o caminho _ts, que indexa para uma comparação de intervalo de carimbo de data/hora. Dentro do elemento na matriz. |
Propriedades em Caminho Incluído
| Propriedade | Descrição |
|---|---|
| path | Caminho ao qual o comportamento de indexação se aplica. Os caminhos de índice começam com a raiz (/) e normalmente terminam com o operador curinga de ponto de interrogação (?), indicando que há vários valores possíveis para o prefixo. Por exemplo, para servir SELECT * FROM Families F WHERE F.familyName = "Andersen", você deve incluir um caminho de índice para /familyName/? na política de índice da coleção. Os caminhos de índice também podem usar o operador curinga * para especificar o comportamento de caminhos recursivamente no prefixo. Por exemplo, /payload/* pode ser usado para excluir tudo na propriedade de conteúdo da indexação. |
| dataType | É o tipo de dados ao qual o comportamento de indexação é aplicado. Pode ser String, Number, Point, Polygon ou LineString. Boolianos e nulos são indexados automaticamente |
| kind | O tipo do índice. Índices de hash são úteis para comparações de igualdade, enquanto índices de intervalo são úteis para igualdade, comparações de intervalo e classificação. Índices espaciais são úteis para consultas espaciais. |
| precisão | A precisão do índice. Pode ser definido como -1 para precisão máxima ou entre 1-8 para Número e 1-100 para Cadeia de Caracteres. Não aplicável aos tipos de dados Point, Polygon e LineString . |
Propriedades em Chave de Partição
| Propriedade | Descrição |
|---|---|
| caminhos | Uma matriz de caminhos usando quais dados dentro da coleção podem ser particionados. Os caminhos não devem conter um curinga ou uma barra à direita. Por exemplo, a propriedade JSON "AccountNumber" é especificada como "/AccountNumber". A matriz deve conter apenas um único valor. |
| kind | O algoritmo usado para particionamento. Há suporte apenas para 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/"
}
Exemplo
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/"
}