Listar (ReadFeed) Documentos

Artigo
08/05/2023

Executar um GET no recurso de documentos de uma determinada coleção, ou seja, o caminho de URI docs, retorna uma lista de documentos na coleção. O ReadFeed pode ser usado para recuperar todos os documentos ou apenas as alterações incrementais em documentos dentro da coleção.

Solicitação

Método	URI da solicitação	Descrição
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Observe que é `{databaseaccount}` o nome da conta do Azure Cosmos DB criada em sua assinatura. O `{db-id}` valor é id do banco de dados e 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. Os cabeçalhos de resposta importantes para o ReadFeed Document são os seguintes:

Cabeçalho	Obrigatório	Type	Descrição
`x-ms-max-item-count`	Opcional	Número	Um inteiro que indica o número máximo de itens a serem retornados por página.
`x-ms-continuation`	Opcional	String	Um token de cadeia de caracteres retornado para consultas e operações de feed de leitura se houver mais resultados a serem lidos. Os clientes podem recuperar a próxima página de resultados reenviando a solicitação com o cabeçalho de solicitação x-ms-continuation definido como esse valor.
`x-ms-consistency-level`	Opcional	String	Esta é a substituição de nível consistente. Os valores válidos são: Strong, Bounded, Session ou Eventual (na ordem do mais forte para o mais fraco). A substituição deve ser a mesma ou mais fraca do que o nível de consistência configurado da conta.
`x-ms-session-token`	Opcional	String	Um token de cadeia de caracteres usado com consistência no nível da sessão. Os clientes devem ecoar o valor de leitura mais recente desse cabeçalho durante solicitações de leitura para consistência de sessão.
`A-IM`	Opcional	String	Deve ser definido `Incremental feed`como ou omitido de outra forma. Disponível na versão `2016-07-11` da API REST em diante.
`If-None-Match`	Opcional	String	Nenhum cabeçalho: retorna todas as alterações desde o início (criação de coleção) "*": retorna todas as novas alterações para dados na coleção <etag>: se definido como uma ETag de coleção, retorna todas as alterações feitas desde esse carimbo de data/hora lógico. Disponível na versão `2016-07-11` da API REST em diante.
`x-ms-documentdb-partitionkeyrangeid`	Opcional	String	A ID de intervalo de chaves de partição de leitura de dados. Disponível na versão `2016-07-11` da API REST em diante.

Corpo

Nenhum.

Resposta

Retorna uma matriz de documentos armazenados dentro 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. Os cabeçalhos de resposta importantes são:

parâmetro Tipo Descrição

x-ms-continuation String Retorna um token para buscar resultados adicionais da operação. O cliente pode reenviar a solicitação com o x-ms-continuation request cabeçalho que contém esse valor para retomar a execução.

x-ms-request-charge Número O número de unidades de solicitação consumidas pela operação.

parâmetro	Tipo	Descrição
`x-ms-continuation`	String	Retorna um token para buscar resultados adicionais da operação. O cliente pode reenviar a solicitação com o `x-ms-continuation request` cabeçalho que contém esse valor para retomar a execução.
`x-ms-request-charge`	Número	O número de unidades de solicitação consumidas pela operação.
`etag`	String	O número de sequência lógica (LSN) do último documento retornado na resposta. O ReadDocumentFeed incremental pode ser retomado por meio do reenvio desse valor em If-None-Match.

etag

String

O número de sequência lógica (LSN) do último documento retornado na resposta.

O ReadDocumentFeed incremental pode ser retomado por meio do reenvio desse valor em If-None-Match.

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.
400 Solicitação Inválida	A substituição definida em x-ms-consistency-level é mais forte do que uma definida durante a criação da conta. Por exemplo, se o nível de consistência for Sessão, a substituição não poderá ser Forte ou Limitada.

Corpo

Propriedade	Descrição
`_rid`	Essa é a ID de recursos gerada pelo sistema para a coleção onde residem os documentos.
`_count`	Esse é o número de documentos retornados pela operação de lista.
`Documents`	A matriz de documentos retornada pela operação.

Propriedades do Documento

Propriedade	Descrição
`id`	Esse é o nome exclusivo que identifica o documento, ou seja, nenhum documento pode compartilhar o mesmo `id`. O `id` não deve exceder 255 caracteres.
<custom>	Qualquer JSON definido pelo usuário.
`_rid`	Essa é 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. Ela é usada internamente para posicionamento e navegação do recurso de documento.
`_ts`	Essa é uma propriedade gerada pelo sistema. Especifica o último carimbo de data/hora atualizado do recurso. O valor é um carimbo de data/hora.
`_self`	Essa é uma propriedade gerada pelo sistema. É o URI endereçável exclusivo do recurso.
`_etag`	Essa é uma propriedade gerada pelo sistema que especifica o recurso `etag` necessário para o controle de simultaneidade otimista.
`_attachments`	Esta é uma propriedade gerada adequadamente que especifica o caminho endereçável para o recurso de anexos.

{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}

Exemplo

GET https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs HTTP/1.1  
x-ms-max-item-count: 10  
x-ms-documentdb-query-enablecrosspartition: False  
x-ms-date: Tue, 29 Mar 2016 02:03:06 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dlmte5%2bJR8gIvDubFWZ0W2cgec22LcFAkZgDZxqOBsOI%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  
Cookie: x-ms-session-token#0=772; x-ms-session-token=772

HTTP/1.1 200 Ok  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Content-Location: https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Sun, 27 Mar 2016 22:39:13.369 GMT  
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;  
x-ms-resource-usage: documentSize=0;documentsSize=2;collectionSize=2;  
x-ms-item-count: 2  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/testdb/colls/testcoll  
x-ms-content-path: d9RzAJRFKgw=  
x-ms-request-charge: 1  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: 46e2e9a5-4917-4ff6-9be5-6f206c38bb6b  
x-ms-session-token: 0:772  
Set-Cookie: x-ms-session-token#0=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
Set-Cookie: x-ms-session-token=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
x-ms-gatewayversion: version=1.6.52.5  
Date: Tue, 29 Mar 2016 02:03:07 GMT  
  
{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}

Compartilhar via

Listar (ReadFeed) Documentos

Solicitação

Cabeçalhos

Corpo

Resposta

Cabeçalhos

Códigos de status

Corpo

Exemplo

Consulte Também

Recursos adicionais