Enumerar documentos (ReadFeed)

Artículo
08/05/2023

Realizar una operación GET en el recurso de documentos de una colección determinada, es decir, la ruta de acceso de URI docs, devuelve una lista de documentos en la colección. ReadFeed se puede usar para recuperar todos los documentos o simplemente los cambios incrementales en los documentos de la colección.

Solicitud

Método	URI de solicitud	Descripción
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Tenga en cuenta que `{databaseaccount}` es el nombre de la cuenta de Azure Cosmos DB creada en la suscripción. El `{db-id}` valor es id. de la base de datos y el valor {coll-id} es el nombre de la colección.

encabezados

Consulte Encabezados de solicitud REST comunes de Azure Cosmos DB para ver los encabezados que usan todas las solicitudes de Cosmos DB. Los encabezados de respuesta importantes del documento ReadFeed son los siguientes:

Encabezado	Obligatorio	Tipo	Descripción
`x-ms-max-item-count`	Opcional	Number	Entero que indica el número máximo de elementos que se devolverán por página.
`x-ms-continuation`	Opcionales	String	Un token de cadena devuelto para las consultas y las operaciones de fuente de lectura si hay más resultados que se van a leer. Los clientes pueden recuperar la siguiente página de resultados mediante la reenvío de la solicitud con el encabezado de solicitud x-ms-continuation establecido en este valor.
`x-ms-consistency-level`	Opcionales	String	Es el nivel que reemplazar al nivel de coherencia anterior. Los valores válidos son: Strong, Bounded, Session o Eventual (en orden de mayor a menor). La invalidación debe ser la misma o más débil que el nivel de coherencia configurado de la cuenta.
`x-ms-session-token`	Opcionales	String	Token de cadena usado con coherencia de nivel de sesión. Los clientes deben hacer eco del valor de lectura más reciente de este encabezado durante las solicitudes de lectura para la coherencia de la sesión.
`A-IM`	Opcionales	String	Debe establecerse `Incremental feed`en o omitirse en caso contrario. Disponible en la versión `2016-07-11` de la API rest en adelante.
`If-None-Match`	Opcionales	String	Ningún encabezado: devuelve todos los cambios desde el principio (creación de la colección). "*": devuelve todos los cambios nuevos en los datos dentro de la colección. <etag>: si se establece en una ETag de colección, devuelve todos los cambios realizados desde esa marca de tiempo lógica. Disponible en la versión `2016-07-11` de la API rest en adelante.
`x-ms-documentdb-partitionkeyrangeid`	Opcionales	String	Id. de intervalo de claves de partición para la lectura de datos. Disponible en la versión `2016-07-11` de la API rest en adelante.

Cuerpo

Ninguno.

Response

Devuelve una matriz de documentos almacenados dentro de la colección.

encabezados

Consulte Encabezados de respuesta REST comunes de Azure Cosmos DB para ver los encabezados devueltos por todas las respuestas de Cosmos DB. Los encabezados de respuesta importantes son:

Encabezado Tipo Descripción

x-ms-continuation String Devuelve un token para capturar resultados adicionales de la operación. El cliente puede volver a enviar la solicitud con el x-ms-continuation request encabezado que contiene este valor para reanudar la ejecución.

x-ms-request-charge Number Número de unidades de solicitud consumidas por la operación.

Encabezado	Tipo	Descripción
`x-ms-continuation`	String	Devuelve un token para capturar resultados adicionales de la operación. El cliente puede volver a enviar la solicitud con el `x-ms-continuation request` encabezado que contiene este valor para reanudar la ejecución.
`x-ms-request-charge`	Number	Número de unidades de solicitud consumidas por la operación.
`etag`	String	El número de secuencia lógica (LSN) del último documento devuelto en la respuesta. La operación ReadDocumentFeed incremental se puede reanudar reenviando este valor en If-None-Match.

etag

String

El número de secuencia lógica (LSN) del último documento devuelto en la respuesta.

La operación ReadDocumentFeed incremental se puede reanudar reenviando este valor en If-None-Match.

Códigos de estado

La tabla siguiente muestra los códigos de estado comunes que devuelve esta operación. Para obtener una lista completa de los códigos de estado, consulte Códigos de estado HTTP.

Código de estado HTTP	Descripción
200 OK	La operación se realizó correctamente.
400 - Solicitud incorrecta	El nivel de reemplazo establecido en x-ms-consistency-level es más seguro que el establecido durante la creación de cuentas. Por ejemplo, si el nivel de coherencia es Session, la invalidación no puede ser Strong o Bounded.

Body

Propiedad	Descripción
`_rid`	Es el identificador del recurso generado por el sistema para la colección donde residen los documentos.
`_count`	La cantidad de documentos que devuelve la operación de lista.
`Documents`	La matriz de documentos devuelta por la operación.

Propiedades del documento

Propiedad	Descripción
`id`	Este es el nombre único que identifica el documento, es decir, ningún documento puede compartir el mismo `id`. No `id` debe superar los 255 caracteres.
<custom>	Cualquier JSON definida por el usuario.
`_rid`	Se trata de una propiedad generada por el sistema. El identificador de recurso (`_rid`) es un identificador único que también es jerárquico por la pila de recursos en el modelo de recursos. Se usa de forma interna para la ubicación y la navegación del recurso de documento.
`_ts`	Se trata de una propiedad generada por el sistema. Especifica la última marca de tiempo actualizada del recurso. El valor es una marca de tiempo.
`_self`	Se trata de una propiedad generada por el sistema. Es el URI direccionable único para el recurso.
`_etag`	Se trata de una propiedad generada por el sistema que especifica el recurso `etag` necesario para el control de simultaneidad optimista.
`_attachments`	Se trata de una propiedad generada por el sistema que especifica la ruta de acceso direccionable del recurso de datos adjuntos.

{  
  "_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  
}

Ejemplo

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  
}

Compartir a través de

Enumerar documentos (ReadFeed)

Solicitud

encabezados

Cuerpo

Response

encabezados

Códigos de estado

Body

Ejemplo

Consulte también

Recursos adicionales