Répertorier les documents (ReadFeed)

Article
08/05/2023

L'exécution d'une opération GET sur la ressource documents d'une collection particulière, c'est-à-dire le chemin d'accès à l'URI docs, renvoie la liste des documents figurant dans cette collection. ReadFeed peut être utilisé pour récupérer tous les documents, ou uniquement les modifications incrémentielles apportées aux documents au sein de la collection.

Requête

Méthode	URI de demande	Description
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Notez que le `{databaseaccount}` est le nom du compte Azure Cosmos DB créé sous votre abonnement. La `{db-id}` valeur est id de la base de données et la valeur {coll-id} est le nom de la collection.

En-têtes

Consultez En-têtes de requête REST Azure Cosmos DB courants pour les en-têtes utilisés par toutes les requêtes Cosmos DB. Les en-têtes de réponse importants pour le document ReadFeed sont les suivants :

En-tête	Obligatoire	Type	Description
`x-ms-max-item-count`	Facultatif	Number	Entier indiquant le nombre maximal d’éléments à retourner par page.
`x-ms-continuation`	Facultatif	String	Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il y a d’autres résultats à lire. Les clients peuvent récupérer la page suivante des résultats en soumettant à nouveau la requête avec l’en-tête de requête x-ms-continuation défini sur cette valeur.
`x-ms-consistency-level`	Facultatif	String	Remplacement de niveau de cohérence. Les valeurs valides sont les suivantes : Strong, Bounded, Session ou Eventual (dans l’ordre du plus fort au plus faible). La substitution doit être identique ou inférieure au niveau de cohérence configuré du compte.
`x-ms-session-token`	Facultatif	String	Jeton de chaîne utilisé avec la cohérence au niveau de la session. Les clients doivent faire écho à la dernière valeur de lecture de cet en-tête lors des demandes de lecture de cohérence de session.
`A-IM`	Facultatif	String	Doit être défini sur `Incremental feed`, ou omis dans le cas contraire. Disponible à partir de la version `2016-07-11` de l’API REST.
`If-None-Match`	Facultatif	String	Aucun en-tête : retourne toutes les modifications depuis le début (création de la collection). « * » : retourne toutes les nouvelles modifications apportées aux données dans la collection. <etag> : s’il est défini sur un ETag de collection, retourne toutes les modifications apportées depuis cet horodatage logique. Disponible à partir de la version `2016-07-11` de l’API REST.
`x-ms-documentdb-partitionkeyrangeid`	Facultatif	String	ID de la plage de clés de partition pour la lecture des données. Disponible à partir de la version `2016-07-11` de l’API REST.

Corps

Aucun.

response

Retourne un tableau de documents stockés dans la collection.

En-têtes

Consultez En-têtes de réponse REST Azure Cosmos DB courants pour les en-têtes retournés par toutes les réponses Cosmos DB. Les en-têtes de réponse importants sont les suivants :

En-tête Type Description

x-ms-continuation String Retourne un jeton pour extraire des résultats supplémentaires de l’opération. Le client peut soumettre à nouveau la demande avec l’en-tête x-ms-continuation request contenant cette valeur pour reprendre l’exécution.

x-ms-request-charge Number Nombre d’unités de requête consommées par l’opération.

En-tête	Type	Description
`x-ms-continuation`	String	Retourne un jeton pour extraire des résultats supplémentaires de l’opération. Le client peut soumettre à nouveau la demande avec l’en-tête `x-ms-continuation request` contenant cette valeur pour reprendre l’exécution.
`x-ms-request-charge`	Number	Nombre d’unités de requête consommées par l’opération.
`etag`	String	Numéro de séquence logique (LSN) du dernier document renvoyé dans la réponse. L’opération ReadDocumentFeed incrémentielle peut être reprise en soumettant à nouveau cette valeur dans If-None-Match.

etag

String

Numéro de séquence logique (LSN) du dernier document renvoyé dans la réponse.

L’opération ReadDocumentFeed incrémentielle peut être reprise en soumettant à nouveau cette valeur dans If-None-Match.

Codes d’état

Le tableau suivant répertorie les codes d'état courants renvoyés par cette opération. Pour obtenir la liste complète des codes status, consultez Codes d’état HTTP.

Code d'état HTTP	Description
200 OK	L'opération a réussi.
400 Demande incorrecte	Le remplacement défini dans x-ms-consistency-level est plus puissant que celui défini pendant la création du compte. Par exemple, si le niveau de cohérence est Session, le niveau de remplacement ne peut pas Strong ou Bounded.

body

Propriété	Description
`_rid`	Id de ressource généré par le système pour la collection dans laquelle les documents résident.
`_count`	Nombre de documents renvoyés par l'opération Liste.
`Documents`	Tableau des documents renvoyés par l'opération.

Propriétés du document

Propriété	Description
`id`	Il s’agit du nom unique qui identifie le document, c’est-à-dire qu’aucun document ne peut partager le même `id`. ne `id` doit pas dépasser 255 caractères.
<custom>	Tout JSON défini par l'utilisateur.
`_rid`	Il s’agit d’une propriété générée par le système. L’ID de ressource (`_rid`) est un identificateur unique qui est également hiérarchique en fonction de la pile de ressources sur le modèle de ressource. Il est utilisé en interne pour le positionnement et la navigation de la ressource de document.
`_ts`	Cette propriété est générée par le système. Elle spécifie l'horodateur de la dernière mise à jour de la ressource. La valeur est un horodateur.
`_self`	Cette propriété est générée par le système. Il s'agit de l'URI adressable unique pour la ressource.
`_etag`	Il s’agit d’une propriété générée par le système qui spécifie la ressource `etag` requise pour le contrôle d’accès concurrentiel optimiste.
`_attachments`	Il s'agit d'une propriété générée par le système qui spécifie le chemin d'accès adressable pour la ressource de pièces jointes.

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

Exemple

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  
}

Share via

Répertorier les documents (ReadFeed)

Requête

En-têtes

Corps

response

En-têtes

Codes d’état

body

Exemple

Voir aussi

Ressources supplémentaires