RavenDB
Query RavenDB with RQL and read or write documents, with client certificates. Typical uses: read a RavenDB application's documents, load rows in batches.
ravendb pingravendb inforavendb database_createravendb databasesravendb putravendb putravendb insertravendb insertravendb getravendb getravendb queryravendb queryravendb findravendb findravendb countravendb countravendb updateravendb updateravendb deleteravendb delete_whereravendb collectionsravendb collection_inforavendb requestravendb requestravendb database_drop

ravendb ping <config>


Description

    Test the connection: {ok, version}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
admin
ravendb ping "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}"
mentdb
{"ok": true, "version": "7.1.4"}

ravendb info <config>


Description

    The build and the cluster topology

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
admin
ravendb info "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}"
mentdb
{"build": {"BuildVersion": 71024, "ProductVersion": "7.1", "CommitHash": "86bc582", "FullVersion": "7.1.4"}, "cluster": {"@metadata": {"DateTime": "2026-11-17T11:48:10.3391990Z", "WebUrl": "http://127.0.0.1:8080", "NodeTag": "A"}, "Topology": {"TopologyId": "8f041eef-5275-4917-b2f7-dfcf4b45b28d", "AllNodes": {"A": "http://127.0.0.1:8080"}, "Members": {"A": "http://127.0.0.1:8080"}, "Promotables": {}, "Watchers": {}, "LastNodeId": "A", "Etag": 1}, "Etag": 1, "Leader": "A", "LeaderShipDuration": 306823, "CurrentState": "Leader", "NodeTag": "A", "ServerRole": "Member", "CurrentTerm": 1, "NodeLicenseDetails": {"A": {"UtilizedCores": 2, "MaxUtilizedCores": null, "NumberOfCores": 11, "InstalledMemoryInGb": 18, "UsableMemoryInGb": 18, "BuildInfo": {"ProductVersion": "7.1", "BuildVersion": 71024, "CommitHash": "86bc582", "FullVersion": "7.1.4", "AssemblyVersion": "7.1.4.71024"}, "OsInfo": {"Type": "MacOS", "FullName": "macOS 14.4", "Version": "14.4", "BuildVersion": "23E214", "Is64Bit": true}}}, "LastStateChangeReason": "Leader, I'm the only one in the cluster, so I'm the leader (at 11/17/2026 11:43:03)", "Status": {}}}

ravendb database_create <config> <name>


Description

    Create a database (replication factor 1): {created}, or {created: null, exists}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    name:   The database - String - required
admin
ravendb database_create "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "shop"
mentdb
{"created": "shop"}

ravendb databases <config>


Description

    The databases of the server

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
admin
ravendb databases "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}"
mentdb
["shop"]

ravendb put <config> <collection> <id> <json_doc>


Description

    Create or replace a document by id in a collection (@metadata.@collection): {id, change_vector}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    id:   The document id, like customers/1 (ids are global in RavenDB) - String - required
    json_doc:   The document as a JSON object - String - required
admin
ravendb put "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "customers/1" "{\"Name\": \"Zoé\", \"City\": \"Paris\", \"Age\": 31}"
mentdb
{"id": "customers/1", "change_vector": "A:1-xKBfgOMnUkeB++Drchz20Q"}

ravendb put <config> <collection> <id> <json_doc> <json_options>


Description

    Put with options: change_vector (optimistic concurrency: an error if the document changed)

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    id:   The document id, like customers/1 (ids are global in RavenDB) - String - required
    json_doc:   The document as a JSON object - String - required
    json_options:   The options - String - required
admin
ravendb put "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "customers/1" "{\"Name\": \"Zoé\"}" "{\"change_vector\": \"A:999-xxx\"}"
mentdb
ERROR: Sorry, an error appears (RavenDB error ConcurrencyException: Document customers/1 has change vector A:1-xKBfgOMnUkeB++Drchz20Q, but Put was called with change vector A:999-xxx. Optimistic concurrency violation, transaction will be aborted. (HTTP 409)).

ravendb insert <config> <collection> <json_rows>


Description

    Insert rows in batches of 1000 (bulk_docs): an @id field gives the id, else RavenDB makes one (customers/0000000000000000003-A): {inserted, errors, ids}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_rows:   The rows: a JSON array of objects (100000 at most) - String - required
admin
ravendb insert "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "[{\"@id\": \"customers/2\", \"Name\": \"Paul\", \"City\": \"Paris\", \"Age\": 45}, {\"Name\": \"Ana\", \"City\": \"Nice\", \"Age\": 19}]"
mentdb
{"inserted": 2, "errors": [], "ids": ["customers/2", "customers/0000000000000000004-A"]}

ravendb insert <config> <collection> <json_rows> <json_options>


Description

    Insert with options: id_field (a field copied to the id, it stays in the document), batch_size (1000)

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_rows:   The rows: a JSON array of objects (100000 at most) - String - required
    json_options:   The options - String - required
admin
ravendb insert "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "[{\"Code\": \"customers/4\", \"Name\": \"Max\", \"City\": \"Lyon\", \"Age\": 52}]" "{\"id_field\": \"Code\"}"
mentdb
{"inserted": 1, "errors": [], "ids": ["customers/4"]}

ravendb get <config> <collection> <id>


Description

    A document as a JSON object with its @id first; null if it does not exist. The collection may be empty

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    id:   The document id, like customers/1 (ids are global in RavenDB) - String - required
admin
ravendb get "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "customers/1"
mentdb
{"@id": "customers/1", "Name": "Zoé", "City": "Paris", "Age": 31}
no such document (fixed result: real RavenDB 7.1.4)
admin
ravendb get "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "customers/99"
mentdb
null

ravendb get <config> <collection> <id> <json_options>


Description

    A document with options: metadata (true: @metadata kept)

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    id:   The document id, like customers/1 (ids are global in RavenDB) - String - required
    json_options:   The options - String - required
admin
ravendb get "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "customers/1" "{\"metadata\": true}"
mentdb
{"Name": "Zoé", "City": "Paris", "Age": 31, "@metadata": {"@collection": "Customers", "@change-vector": "A:1-xKBfgOMnUkeB++Drchz20Q", "@id": "customers/1", "@last-modified": "2026-11-17T11:48:10.3853090Z"}}

ravendb query <config> <rql>


Description

    Run RQL: the documents (or projections) as rows, page by page (1000 at most)

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    rql:   The RQL query - String - required
admin
ravendb query "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "from Customers group by City order by City select key() as City, count() as N"
mentdb
[{"City": "Lyon", "N": 1}, {"City": "Nice", "N": 1}, {"City": "Paris", "N": 2}]

ravendb query <config> <rql> <json_options>


Description

    RQL with options: params (a JSON object for $name), limit (1000, 100000 at most), start, page_size (1000), metadata, wait_for_non_stale

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    rql:   The RQL query - String - required
    json_options:   The options - String - required
admin
ravendb query "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "from Customers where Age >= $min order by Age" "{\"params\": {\"min\": 30}, \"wait_for_non_stale\": true}"
mentdb
[{"@id": "customers/1", "Name": "Zoé", "City": "Paris", "Age": 31}, {"@id": "customers/2", "Name": "Paul", "City": "Paris", "Age": 45}, {"@id": "customers/4", "Code": "customers/4", "Name": "Max", "City": "Lyon", "Age": 52}]

ravendb find <config> <collection> <json_filter>


Description

    The documents of a collection matching a filter (RQL with parameters) as rows

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_filter:   The filter, the same for every NoSQL family: {"city": "Paris", "age": {"$gte": 18}}; operators $eq $ne $gt $gte $lt $lte $in $nin; the conditions are combined with AND - String - required
admin
ravendb find "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "{\"City\": {\"$nin\": [\"Paris\"]}}"
mentdb
[{"@id": "customers/0000000000000000004-A", "Name": "Ana", "City": "Nice", "Age": 19}, {"@id": "customers/4", "Code": "customers/4", "Name": "Max", "City": "Lyon", "Age": 52}]

ravendb find <config> <collection> <json_filter> <json_options>


Description

    Find with options: Options: limit (1000, 100000 at most), skip, sort ({"age": -1} or [["age", "desc"]]), fields (an array of field names), metadata, wait_for_non_stale

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_filter:   The filter, the same for every NoSQL family: {"city": "Paris", "age": {"$gte": 18}}; operators $eq $ne $gt $gte $lt $lte $in $nin; the conditions are combined with AND - String - required
    json_options:   The options - String - required
admin
ravendb find "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "{\"Age\": {\"$gte\": 20}}" "{\"sort\": {\"Age\": -1}, \"fields\": [\"Name\", \"Age\"], \"wait_for_non_stale\": true}"
mentdb
[{"@id": "customers/4", "Name": "Max", "Age": 52}, {"@id": "customers/2", "Name": "Paul", "Age": 45}, {"@id": "customers/1", "Name": "Zoé", "Age": 31}]

ravendb count <config> <collection>


Description

    The number of documents of a collection (TotalResults of a query of 0 rows)

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
admin
ravendb count "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers"
mentdb
4

ravendb count <config> <collection> <json_filter>


Description

    The number of documents matching a filter

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_filter:   The filter, the same for every NoSQL family: {"city": "Paris", "age": {"$gte": 18}}; operators $eq $ne $gt $gte $lt $lte $in $nin; the conditions are combined with AND - String - required
admin
ravendb count "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "{\"City\": \"Paris\"}"
mentdb
2

ravendb update <config> <collection> <json_filter> <json_changes>


Description

    Set top-level fields in the matching documents: {matched, modified}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_filter:   The filter, the same for every NoSQL family: {"city": "Paris", "age": {"$gte": 18}}; operators $eq $ne $gt $gte $lt $lte $in $nin; the conditions are combined with AND - String - required
    json_changes:   The new values of top-level fields, like {"vip": true} - String - required
admin
ravendb update "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "{\"City\": \"Paris\"}" "{\"Vip\": true}"
mentdb
{"matched": 2, "modified": 2}

ravendb update <config> <collection> <json_filter> <json_changes> <json_options>


Description

    Update with options: limit (100000)

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_filter:   The filter, the same for every NoSQL family: {"city": "Paris", "age": {"$gte": 18}}; operators $eq $ne $gt $gte $lt $lte $in $nin; the conditions are combined with AND - String - required
    json_changes:   The new values of top-level fields, like {"vip": true} - String - required
    json_options:   The options - String - required
admin
ravendb update "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "{\"Age\": {\"$gt\": 40}}" "{\"Senior\": true}" "{\"limit\": 1}"
mentdb
{"matched": 1, "modified": 1}

ravendb delete <config> <collection> <id>


Description

    Delete a document: {deleted: 1}, or {deleted: 0} if it does not exist

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    id:   The document id, like customers/1 (ids are global in RavenDB) - String - required
admin
ravendb delete "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "customers/4"
mentdb
{"deleted": 1}

ravendb delete_where <config> <collection> <json_filter>


Description

    Delete the documents matching a filter: {deleted}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
    json_filter:   The filter, the same for every NoSQL family: {"city": "Paris", "age": {"$gte": 18}}; operators $eq $ne $gt $gte $lt $lte $in $nin; the conditions are combined with AND - String - required
admin
ravendb delete_where "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers" "{\"Senior\": true}"
mentdb
{"deleted": 1}

ravendb collections <config>


Description

    The collections of the database

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
admin
ravendb collections "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}"
mentdb
["Customers"]

ravendb collection_info <config> <collection>


Description

    A collection: {name, exists, count}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    collection:   The collection, like Customers - String - required
admin
ravendb collection_info "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "Customers"
mentdb
{"name": "Customers", "exists": true, "count": 2}

ravendb request <config> <method> <path>


Description

    Any request of the HTTP API: the JSON answer

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    method:   The HTTP method - String - required
    path:   The path from the root of the server, starting with / (encoded) - String - required
admin
ravendb request "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "GET" "/databases/shop/indexes?namesOnly=true"
mentdb
{"@metadata": {"DateTime": "2026-11-17T11:48:10.4968760Z", "WebUrl": "http://127.0.0.1:8080", "NodeTag": "A"}, "Results": ["Auto/Customers/ByAge", "Auto/Customers/ByAgeAndCity", "Auto/Customers/ByAgeAndCityAndSenior", "Auto/Customers/ByCountReducedByCity"]}

ravendb request <config> <method> <path> <json_body>


Description

    Any request with a JSON body

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    method:   The HTTP method - String - required
    path:   The path from the root of the server, starting with / (encoded) - String - required
    json_body:   The JSON body - String - required
admin
ravendb request "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "PATCH" "/databases/shop/queries" "{\"Query\": {\"Query\": \"from Customers update { this.Checked = true }\"}}"
mentdb
{"OperationId": 1, "OperationNodeTag": "A"}

ravendb database_drop <config> <name>


Description

    Delete a database and its files: {dropped}

Parameters

    config:   The RavenDB configuration as JSON: url (http://127.0.0.1:8080), database, cert_file (a client certificate: .pfx with cert_password, or PEM with key_file), ca_file (PEM certificates to trust: a private CA or a self-signed server), timeout_ms (30000), max_bytes (64 MB). A client certificate needs https - String - required
    name:   The database - String - required
admin
ravendb database_drop "{\"url\": \"http://127.0.0.1:8080\", \"database\": \"shop\"}" "shop"
mentdb
{"dropped": "shop"}