Elencare (lettura feed) documenti

Articolo
07/19/2023

L'esecuzione di un'operazione GET sulla risorsa relativa ai documenti di una determinata raccolta, ad esempio il percorso URI docs, restituirà un elenco di documenti presenti nella raccolta. ReadFeed può essere usato per recuperare tutti i documenti o solo le modifiche incrementali ai documenti all'interno della raccolta.

Richiesta

Metodo	URI richiesta	Descrizione
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Si noti che è `{databaseaccount}` il nome dell'account Azure Cosmos DB creato nella sottoscrizione. Il `{db-id}` valore è id del database e {coll-id} è il nome della raccolta.

Intestazioni

Vedere Intestazioni di richiesta REST comuni di Azure Cosmos DB per le intestazioni usate da tutte le richieste di Cosmos DB. Le intestazioni di risposta importanti per ReadFeed Document sono le seguenti:

Intestazione	Obbligatoria	Tipo	Description
`x-ms-max-item-count`	Facoltativo	Number	Intero che indica il numero massimo di elementi da restituire per pagina.
`x-ms-continuation`	Facoltativo	String	Token stringa restituito per le query e le operazioni di lettura-feed se sono presenti altri risultati da leggere. I client possono recuperare la pagina successiva dei risultati inviando di nuovo la richiesta con l'intestazione della richiesta x-ms-continuation impostata su questo valore.
`x-ms-consistency-level`	Facoltativo	String	Questo è l'override del livello di coerenza. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine di più forte al più debole). L'override deve essere uguale o più debole del livello di coerenza configurato dell'account.
`x-ms-session-token`	Facoltativo	String	Token stringa usato con coerenza a livello di sessione. I client devono ripetere il valore di lettura più recente di questa intestazione durante le richieste di lettura per la coerenza della sessione.
`A-IM`	Facoltativo	String	Deve essere impostato su `Incremental feed`o omesso in caso contrario. Disponibile dalla versione `2016-07-11` dell'API REST in poi.
`If-None-Match`	Facoltativo	String	Nessuna intestazione: restituisce tutte le modifiche fin dall'inizio (creazione della raccolta) "*": restituisce tutte le nuove modifiche ai dati all'interno della raccolta <etag>: se impostato su una raccolta ETag, restituisce tutte le modifiche apportate dal timestamp logico. Disponibile dalla versione `2016-07-11` dell'API REST in poi.
`x-ms-documentdb-partitionkeyrangeid`	Facoltativo	String	L'ID dell'intervallo di chiavi di partizione per la lettura dei dati. Disponibile dalla versione `2016-07-11` dell'API REST in poi.

Corpo

Nessuno.

Risposta

Restituisce una matrice di documenti archiviati all'interno dell'insieme.

Intestazioni

Vedere Intestazioni di risposta REST comuni di Azure Cosmos DB per le intestazioni restituite da tutte le risposte di Cosmos DB. Le intestazioni di risposta importanti sono:

Intestazione Tipo Descrizione

x-ms-continuation string Restituisce un token per recuperare risultati aggiuntivi dall'operazione. Il client può inviare di nuovo la richiesta con l'intestazione x-ms-continuation request contenente questo valore per riprendere l'esecuzione.

x-ms-request-charge Number Numero di unità richiesta utilizzate dall'operazione.

Intestazione	Tipo	Descrizione
`x-ms-continuation`	string	Restituisce un token per recuperare risultati aggiuntivi dall'operazione. Il client può inviare di nuovo la richiesta con l'intestazione `x-ms-continuation request` contenente questo valore per riprendere l'esecuzione.
`x-ms-request-charge`	Number	Numero di unità richiesta utilizzate dall'operazione.
`etag`	string	Il numero di sequenza logica (LSN) dell'ultimo documento restituito nella risposta. Un ReadDocumentFeed incrementale può essere ripreso inviando nuovamente questo valore in If-None-Match.

etag

string

Il numero di sequenza logica (LSN) dell'ultimo documento restituito nella risposta.

Un ReadDocumentFeed incrementale può essere ripreso inviando nuovamente questo valore in If-None-Match.

Codici di stato

La seguente tabella elenca i codici di stato comuni restituiti da questa operazione. Per un elenco completo dei codici di stato, vedere Codici di stato HTTP.

Codice di stato HTTP	Descrizione
200 - OK	L'operazione è stata completata.
400 - Richiesta non valida	L'override in x-ms-consistency-level corrisponde a un livello più avanzato rispetto a quello impostato durante la creazione dell'account. Ad esempio, se il livello di coerenza è impostato su Sessione, l'override non può essere Assoluta o Associata.

Corpo

Proprietà	Descrizione
`_rid`	ID della risorsa generato dal sistema per la raccolta in cui si trova il documento.
`_count`	Numero di documenti restituiti dall'operazione List.
`Documents`	Matrice di documenti restituiti dall'operazione.

Proprietà del documento

Proprietà	Descrizione
`id`	Si tratta del nome univoco che identifica il documento, ad esempio nessun documento può condividere lo stesso `id`. L'oggetto `id` non deve superare i 255 caratteri.
<custom>	Qualsiasi JSON definito dall'utente.
`_rid`	Si tratta di una proprietà generata dal sistema. L'ID risorsa (`_rid`) è un identificatore univoco che è anche gerarchico per ogni stack di risorse nel modello di risorse. Viene usato internamente per il posizionamento e l'esplorazione della risorsa documento.
`_ts`	Proprietà generata dal sistema. Indica il timestamp dell'ultimo aggiornamento della risorsa. Il valore è un timestamp.
`_self`	Proprietà generata dal sistema. URI indirizzabile univoco per la risorsa.
`_etag`	Si tratta di una proprietà generata dal sistema che specifica la risorsa `etag` necessaria per il controllo della concorrenza ottimistica.
`_attachments`	Proprietà generata dal sistema che specifica il percorso indirizzabile della risorsa degli allegati.

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

Esempio

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  
}

Condividi tramite

Elencare (lettura feed) documenti

Richiesta

Intestazioni

Corpo

Risposta

Intestazioni

Codici di stato

Corpo

Esempio

Vedere anche

Risorse aggiuntive