문서 나열(ReadFeed)

  • 아티클

docs URI 경로와 같은 특정 컬렉션의 문서 리소스에 대해 GET을 수행하면 해당 컬렉션의 문서 목록이 반환됩니다. ReadFeed를 사용하여 모든 문서를 검색하거나 컬렉션 내의 문서에 대한 증분 변경 내용만 검색할 수 있습니다.

요청

메서드 요청 URI 설명
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs 는 {databaseaccount} 구독에서 만든 Azure Cosmos DB 계정의 이름입니다. 값은 {db-id} 데이터베이스의 ID이고 {coll-id} 값은 컬렉션의 이름입니다.

헤더

모든 Cosmos DB 요청에 사용되는 헤더는 일반적인 Azure Cosmos DB REST 요청 헤더를 참조하세요. ReadFeed 문서에 대한 중요한 응답 헤더는 다음과 같습니다.

헤더 필수 형식 설명
x-ms-max-item-count 선택 숫자 페이지당 반환할 최대 항목 수를 나타내는 정수입니다.
x-ms-continuation 선택 사항 문자열 더 많은 결과를 읽을 수 있는 경우 쿼리 및 읽기 피드 작업에 대해 반환되는 문자열 토큰입니다. 클라이언트는 x-ms-continuation 요청 헤더가 이 값으로 설정된 요청을 다시 제출하여 결과의 다음 페이지를 검색할 수 있습니다.
x-ms-consistency-level 선택 사항 문자열 일관성 수준 재정의입니다. 유효한 값은 Strong, Bounded, Session 또는 Eventual 입니다(가장 강력한 순서에서 가장 약한 값으로). 재정의는 계정의 구성된 일관성 수준과 동일하거나 약해야 합니다.
x-ms-session-token 선택 사항 문자열 세션 수준 일관성에 사용되는 문자열 토큰입니다. 클라이언트는 세션 일관성에 대한 읽기 요청 중에 이 헤더의 최신 읽기 값을 에코해야 합니다.
A-IM 선택 사항 문자열 로 설정 Incremental feed하거나, 그렇지 않으면 생략해야 합니다. REST API 버전 2016-07-11 부터 사용할 수 있습니다.
If-None-Match 선택 사항 문자열

헤더 없음: 처음(컬렉션 생성)부터 모든 변경 내용을 반환합니다.

"*": 컬렉션 내의 데이터에 대한 새 변경 내용을 모두 반환합니다.

<etag>: 컬렉션 ETag로 설정된 경우 는 해당 논리 타임스탬프 이후의 모든 변경 내용을 반환합니다.

REST API 버전 2016-07-11 부터 사용할 수 있습니다.
x-ms-documentdb-partitionkeyrangeid 선택 사항 문자열 데이터를 읽는 파티션 키 범위 ID입니다. REST API 버전 2016-07-11 부터 사용할 수 있습니다.

본문

없음

응답

컬렉션 내에 저장된 문서 배열을 반환합니다.

헤더

모든 Cosmos DB 응답 에서 반환되는 헤더는 일반적인 Azure Cosmos DB REST 응답 헤더를 참조하세요. 중요한 응답 헤더는 다음과 같습니다.

헤더 형식 Description
x-ms-continuation String 작업에서 추가 결과를 가져오는 토큰을 반환합니다. 클라이언트는 이 값이 포함된 헤더를 사용하여 x-ms-continuation request 요청을 다시 제출하여 실행을 다시 시작할 수 있습니다.
x-ms-request-charge 숫자 작업에서 사용하는 요청 단위 수입니다.
etag 문자열

응답에서 반환되는 최근 문서의 LSN(논리 시퀀스 번호)입니다.

증분 ReadDocumentFeed는 If-None-Match에서 이 값을 다시 제출하여 다시 시작될 수 있습니다.

상태 코드

다음 표에는 이 작업에서 반환하는 일반적인 상태 코드가 나열되어 있습니다. 상태 코드의 전체 목록은 HTTP 상태 코드를 참조하세요.

HTTP 상태 코드 Description
200 정상 작업이 완료되었습니다.
400 잘못된 요청 x-ms-consistency-level에 설정된 재정의 수준이 계정을 만드는 동안 설정된 수준보다 더 높습니다. 예를 들어 일관성 수준이 Session인 경우 Strong 또는 Bounded로 재정의할 수는 없습니다.

본문

속성 Description
_rid 문서가 있는 컬렉션의 시스템 생성 리소스 ID입니다.
_count 목록 작업에서 반환하는 문서의 수입니다.
Documents 작업에서 반환하는 문서의 배열입니다.

문서의 속성

속성 Description
id 이 이름은 문서를 식별하는 고유한 이름입니다. 즉, 두 문서가 동일한 id를 공유할 수 없습니다. 은 id 255자를 초과하지 않아야 합니다.
<custom> 모든 사용자 정의 JSON입니다.
_rid 시스템 생성 속성입니다. 리소스 ID(_rid)는 리소스 모델의 리소스 스택당 계층 구조인 고유 식별자입니다. 문서 리소스의 배치와 탐색을 위해 내부적으로 사용됩니다.
_ts 시스템 생성 속성으로, 리소스가 마지막으로 업데이트된 시간의 타임스탬프를 지정합니다. 값은 타임스탬프입니다.
_self 시스템 생성 속성으로, 고유한 주소를 지정할 수 있는 리소스의 URI입니다.
_etag 낙관적 동시성 제어에 필요한 리소스 etag 를 지정하는 시스템 생성 속성입니다.
_attachments 첨부 파일 리소스의 주소 지정 가능한 경로를 지정하는 시스템 생성 속성입니다. 
{  
  "_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  
}

예제

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  
}

참고 항목