see on GitHub

Get All Documents



Basic Example

This is a cURL request to a database named "Example" on our playground server. Paging through all of the documents in the database, the request skips the first 9 documents and retrieves only the next 3.

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?start=9&pageSize=3"

Response:

Server:"nginx"
Date:"Thu, 10 Oct 2019 12:00:40 GMT"
Content-Type:"application/json; charset=utf-8"
Transfer-Encoding:"chunked"
Connection:"keep-alive"
Content-Encoding:"gzip"
ETag:""A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A""
Vary:"Accept-Encoding"
Raven-Server-Version:"4.2.4.42"

{
    "Results": [
        {
            "Name": "Seafood",
            "Description": "Seaweed and fish",
            "@metadata": {
                "@attachments": [
                    {
                        "Name": "image.jpg",
                        "Hash": "GWdpGVCWyLsrtNdA5AOee0QOZFG6rKIqCosZZN5WnCA=",
                        "ContentType": "image/jpeg",
                        "Size": 33396
                    }
                ],
                "@collection": "Categories",
                "@change-vector": "A:2107-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasAttachments",
                "@id": "categories/8-A",
                "@last-modified": "2018-07-27T12:21:39.1315788Z"
            }
        },
        {
            "Name": "Produce",
            "Description": "Dried fruit and bean curd",
            "@metadata": {
                "@attachments": [
                    {
                        "Name": "image.jpg",
                        "Hash": "asY7yUHhdgaVoKhivgua0OUSJKXqNDa3Z1uLP9XAocM=",
                        "ContentType": "image/jpeg",
                        "Size": 61749
                    }
                ],
                "@collection": "Categories",
                "@change-vector": "A:2104-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasAttachments",
                "@id": "categories/7-A",
                "@last-modified": "2018-07-27T12:21:11.2283909Z"
            }
        },
        {
            "Name": "Meat/Poultry",
            "Description": "Prepared meats",
            "@metadata": {
                "@attachments": [
                    {
                        "Name": "image.jpg",
                        "Hash": "K37huqcfGCjDC0up0zVte7DAut5YS5K1z1kC+iUmeCI=",
                        "ContentType": "image/jpeg",
                        "Size": 31219
                    }
                ],
                "@collection": "Categories",
                "@change-vector": "A:2101-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasAttachments",
                "@id": "categories/6-A",
                "@last-modified": "2018-07-27T12:20:49.7774078Z"
            }
        }
    ]
}

Request Format

This is the general form of a cURL request that uses all query string parameters:

curl -X GET "<server URL>/databases/<database name>/docs?
            &start=<integer>
            &pageSize=<integer>
            &metadata=<boolean>"
--header If-None-Match: <hash>
Linebreaks are added for clarity.

Query String Parameters

Parameter Description Required
start Number of results to skip. No
pageSize Maximum number of results to retrieve. No
metadataOnly Set this parameter to true to retrieve only the document metadata for each result. No

Headers

Header Description Required
If-None-Match This header takes a hash representing the previous results of an identical request. The hash is found in the response header ETag. If the results were not modified since the previous request, the server responds with http status code 304, and the requested documents are retrieved from a local cache rather than over the network. No

Response Format

Http Status Codes

Code Description
200 Results were successfully retrieved
304 In response to an If-None-Match check: none of the requested documents were modified since they were last loaded, so they were not retrieved from the server.

Headers

Header Description
Content-Type MIME media type and character encoding. This should always be: application/json; charset=utf-8
ETag Hash representing the state of these results. If another, identical request is made, this hash can be sent in the If-None-Match header to check whether the retrieved documents have been modified since the last response.
Raven-Server-Version Version of RavenDB that the responding server is running

Body

Retrieved documents are sorted in descending order of their change vectors. A retrieved document is identical in contents and format to the document stored in the server - unless the metadataOnly parameter is set to true.

This is the general format of the JSON response body:

{
    "Results": [
        {
            "<field>":"<value>",
            ...
            "@metadata":{
                ...
            }
        },
        { <document contents> },
        ...
    ]
}
Linebreaks are added for clarity.

Query Parameter Examples

About Northwind, the database used in our examples.

In this section:


start

Skip first 1,057 documents, and retrieve the rest (our version of Northwind contains 1,059 documents).
cURL request:

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?start=1056"

Response:

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 10 Oct 2019 16:30:37 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Content-Encoding: gzip
ETag: "A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A"
Vary: Accept-Encoding
Raven-Server-Version: 4.2.4.42

{
    "Results": [
        {
            "ExternalId": "ALFKI",
            "Name": "Alfreds Futterkiste",
            "Contact": {
                "Name": "Maria Anders",
                "Title": "Sales Representative"
            },
            "Address": {
                "Line1": "Obere Str. 57",
                "Line2": null,
                "City": "Berlin",
                "Region": null,
                "PostalCode": "12209",
                "Country": "Germany",
                "Location": {
                    "Latitude": 53.24939,
                    "Longitude": 14.43286
                }
            },
            "Phone": "030-0074321",
            "Fax": "030-0076545",
            "@metadata": {
                "@collection": "Companies",
                "@change-vector": "A:3-W33iO0zJC0qZKWh6fjnp6A",
                "@id": "companies/1-A",
                "@last-modified": "2018-07-27T12:11:53.0182893Z"
            }
        },
        {
            "Max": 8,
            "@metadata": {
                "@collection": "@hilo",
                "@change-vector": "A:1-W33iO0zJC0qZKWh6fjnp6A",
                "@id": "Raven/Hilo/categories",
                "@last-modified": "2018-07-27T12:11:53.0145929Z"
            }
        }
    ]
}


pageSize

Retrieve the first document.
cURL request:

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?pageSize=1"

Response:

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 10 Oct 2019 16:33:31 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Content-Encoding: gzip
ETag: "A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A"
Vary: Accept-Encoding
Raven-Server-Version: 4.2.4.42

{
    "Results": [
        {
            "LastName": "Callahan",
            "FirstName": "Laura",
            "Title": "Inside Sales Coordinator",
            "Address": {
                "Line1": "4726 - 11th Ave. N.E.",
                "Line2": null,
                "City": "Seattle",
                "Region": "WA",
                "PostalCode": "98105",
                "Country": "USA",
                "Location": {
                    "Latitude": 47.664164199999988,
                    "Longitude": -122.3160148
                }
            },
            "HiredAt": "1994-03-05T00:00:00.0000000",
            "Birthday": "1958-01-09T00:00:00.0000000",
            "HomePhone": "(206) 555-1189",
            "Extension": "2344",
            "ReportsTo": "employees/2-A",
            "Notes": [
                "Laura received a BA in psychology from the University of Washington.  She has also completed a course in business French.  She reads and writes French."
            ],
            "Territories": [
                "19428",
                "44122",
                "45839",
                "53404"
            ],
            "@metadata": {
                "@attachments": [
                    {
                        "Name": "photo.jpg",
                        "Hash": "8dte+O8Ds9RJx8dKruWurqapAojM/ZxjHBMst9wm5sI=",
                        "ContentType": "image/jpeg",
                        "Size": 14446
                    }
                ],
                "@collection": "Employees",
                "@change-vector": "A:2134-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasAttachments",
                "@id": "employees/8-A",
                "@last-modified": "2018-07-27T12:26:25.0179915Z"
            }
        }
    ]
}


metadataOnly

Skip 123, take the next five, and retrieve only the metadata of each document.
cURL request:

curl -X GET "http://live-test.ravendb.net/databases/Example/docs?
                start=123
                &pageSize=5
                &metadataOnly=true"
Linebreaks are added for clarity.

Response:

HTTP/1.1 200 OK
Server: nginx
Date: Thu, 10 Oct 2019 16:50:00 GMT
Content-Type: application/json; charset=utf-8
Connection: keep-alive
ETag: "A:2134-W33iO0zJC0qZKWh6fjnp6A, A:1887-0N64iiIdYUKcO+yq1V0cPA, A:6214-xwmnvG1KBkSNXfl7/0yJ1A"
Vary: Accept-Encoding
Raven-Server-Version: 4.2.4.42
Content-Length: 918

{
    "Results": [
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1871-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/728-A",
                "@last-modified": "2018-07-27T12:11:53.1753957Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1869-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/727-A",
                "@last-modified": "2018-07-27T12:11:53.1751418Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1867-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/726-A",
                "@last-modified": "2018-07-27T12:11:53.1749721Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1865-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/725-A",
                "@last-modified": "2018-07-27T12:11:53.1747646Z"
            }
        },
        {
            "@metadata": {
                "@collection": "Orders",
                "@change-vector": "A:1863-W33iO0zJC0qZKWh6fjnp6A",
                "@flags": "HasRevisions",
                "@id": "orders/724-A",
                "@last-modified": "2018-07-27T12:11:53.1745710Z"
            }
        }
    ]
}