Partilhar via

Listar (ReadFeed) Documentos

  • Artigo

Executar um GET no recurso de documentos de uma coleção específica, ou seja, o caminho do URI do docs devolve uma lista de documentos na coleção. O ReadFeed pode ser utilizado para obter todos os documentos ou apenas as alterações incrementais aos documentos na coleção.

Pedir

Método URI do pedido Descrição
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs Tenha em atenção que é {databaseaccount} o nome da conta do Azure Cosmos DB criada na sua subscrição. O {db-id} valor é id da base de dados e o valor {coll-id} é o nome da coleção.

Cabeçalhos

Veja Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests (Cabeçalhos de pedido REST do Azure Cosmos DB comuns para cabeçalhos que são utilizados por todos os pedidos do Cosmos DB). Os cabeçalhos de resposta importantes do Documento ReadFeed são os seguintes:

Cabeçalho Necessário Tipo Description
x-ms-max-item-count Opcional Número Um número inteiro que indica o número máximo de itens a devolver por página.
x-ms-continuation Opcional String Um token de cadeia devolvido para consultas e operações de feed de leitura se existirem mais resultados a ler. Os clientes podem obter a página seguinte dos resultados ao submeter novamente o pedido com o cabeçalho do pedido x-ms-continuation definido para este valor.
x-ms-consistency-level Opcional String Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Vinculado, Sessão ou Eventual (por ordem do mais forte para o mais fraco). A substituição tem de ser igual ou mais fraca do que o nível de consistência configurado da conta.
x-ms-session-token Opcional String Um token de cadeia utilizado com consistência ao nível da sessão. Os clientes têm de ecoar o valor de leitura mais recente deste cabeçalho durante os pedidos de leitura para consistência da sessão.
A-IM Opcional String Tem de ser definido como Incremental feed, ou omitido de outra forma. Disponível a partir da versão 2016-07-11 da API REST.
If-None-Match Opcional String

Sem cabeçalho: devolve todas as alterações desde o início (criação da coleção)

"*": devolve todas as novas alterações aos dados na coleção

<etag>: se definido como um ETag de coleção, devolve todas as alterações efetuadas desde esse carimbo de data/hora lógico.

Disponível a partir da versão 2016-07-11 da API REST.
x-ms-documentdb-partitionkeyrangeid Opcional String O ID do intervalo de chaves de partição para ler dados. Disponível a partir da versão 2016-07-11 da API REST.

Corpo

Nenhum.

Resposta

Devolve uma matriz de documentos armazenados na coleção.

Cabeçalhos

Veja Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses (Cabeçalhos de resposta REST do Azure Cosmos DB comuns para cabeçalhos devolvidos por todas as respostas do Cosmos DB). Os cabeçalhos de resposta importantes são:

Cabeçalho Tipo Description
x-ms-continuation String Devolve um token para obter resultados adicionais da operação. O cliente pode submeter novamente o pedido com o x-ms-continuation request cabeçalho que contém este valor para retomar a execução.
x-ms-request-charge Número O número de unidades de pedido consumidas pela operação.
etag String

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

O ReadDocumentFeed incremental pode ser retomado ao submeter novamente este valor em If-None-Match.

Códigos de estado

A tabela seguinte lista os códigos de estado comuns devolvidos por esta operação. Para obter uma lista completa dos códigos de estado, consulte Códigos de Estado HTTP.

Código de estado de HTTP Descrição
200 OK A operação foi bem-sucedida.
400 Pedido Incorreto O conjunto de substituições no nível x-ms-consistency é mais forte do que o definido durante a criação da conta. Por exemplo, se o nível de consistência for Sessão, a substituição não pode ser Forte ou Limitada.

Corpo

Propriedade Descrição
_rid Este é o ID de recurso gerado pelo sistema para a coleção onde residem os documentos.
_count Este é o número de documentos devolvidos pela operação de lista.
Documents A matriz de documentos devolvidos pela operação.

Propriedades do Documento

Propriedade Descrição
id Este é o nome exclusivo que identifica o documento, ou seja, nenhum documento pode partilhar o mesmo id. Não id pode exceder 255 carateres.
<personalizado> Qualquer JSON definido pelo utilizador.
_rid Esta é uma propriedade gerada pelo sistema. O ID do recurso (_rid) é um identificador exclusivo que também é hierárquico de acordo com a pilha de recursos no modelo de recursos. É utilizado internamente para posicionamento e navegação do recurso de documento.
_ts Esta é uma propriedade gerada pelo sistema. Especifica o último carimbo de data/hora atualizado do recurso. O valor é um carimbo de data/hora.
_self Esta é uma propriedade gerada pelo sistema. É o URI endereçável exclusivo para o recurso.
_etag Esta é uma propriedade gerada pelo sistema que especifica o recurso etag necessário para o controlo de simultaneidade otimista.
_attachments Esta é uma propriedade gerada pelo sistema 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  
}

Consulte também