Patch By Query

This cURL request sends a query with an update clause to a database named "Example" on our playground server. The results of this query will each be modified on the server side.

curl -X PATCH "http://live-test.ravendb.net/databases/Example/queries"
-d "{ \"Query\": { \"Query\": \"from Employees as E update{ E.FirstName = 'Bob' }\" } }"

Response:

HTTP/1.1 200 OK
Server: nginx
Date: Sun, 24 Nov 2019 12:24:51 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Content-Encoding: gzip
Vary: Accept-Encoding
Raven-Server-Version: 4.2.5.42
Request-Time: 5

{
    "OperationId": 42,
    "OperationNodeTag": "A"
}

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

curl -X GET "<server URL>/databases/<database name>/docs?
            allowStale=<boolean>
            &staleTimeout=<TimeSpan>
            &maxOpsPerSec=<integer>"
-d "{ }"

Query String Parameters

Body

This is the general format of the request body:

-d "{
    \"Query\": {
        \"Query\": \"<RQL query referencing $<name>>\",
        \"QueryParameters\": {
            \"<name>\":\"<parameter>\",
            ...
        }
    }
}"

Http Status Codes

Body

{
    "OperationId": <int>,
    "OperationNodeTag": "<cluster node tag>"
}