Solr
Index and search Apache Solr: search and find as rows, cursor export, insert rows, atomic updates and deletes. Typical uses: feed a Solr index, export search results.
solr pingsolr infosolr collection_createsolr collection_createsolr pingsolr collectionssolr coressolr insertsolr insertsolr putsolr putsolr commitsolr commitsolr getsolr findsolr findsolr countsolr countsolr searchsolr searchsolr searchsolr search_allsolr search_allsolr updatesolr updatesolr collection_infosolr deletesolr deletesolr delete_wheresolr delete_wheresolr requestsolr requestsolr collection_drop
solr ping <config>
Description
Test the server: {ok, version, mode (std or solrcloud)}
Test the server: {ok, version, mode (std or solrcloud)}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
admin
solr ping "{\"url\": \"http://localhost:8983/solr\"}"
mentdb
{"ok": true, "version": "9.11.0", "mode": "std"}
solr info <config>
Description
The server: {version, lucene_version, mode, jvm}
The server: {version, lucene_version, mode, jvm}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
admin
solr info "{\"url\": \"http://localhost:8983/solr\"}"
mentdb
{"version": "9.11.0", "lucene_version": "9.12.3", "mode": "std", "jvm": "21.0.13 21.0.13+9-LTS"}
solr collection_create <config> <name>
Description
Create a collection (SolrCloud) or a core (standalone, from a configset of the Solr home: _default). Returns {created}
Create a collection (SolrCloud) or a core (standalone, from a configset of the Solr home: _default). Returns {created}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The name - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The name - String - required
admin
solr collection_create "{\"url\": \"http://localhost:8983/solr\"}" "products"
mentdb
{"created": "products"}
solr collection_create <config> <name> <options_json>
Description
Create with options: configset (_default), num_shards (1), replication_factor (1)
Create with options: configset (_default), num_shards (1), replication_factor (1)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The name - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The name - String - required
options_json: The options - String - required
admin
solr collection_create "{\"url\": \"http://localhost:8983/solr\"}" "tmpcore" "{\"configset\": \"_default\"}"
mentdb
{"created": "tmpcore"}
solr ping <config> <collection>
Description
Test a collection or a core with its ping handler: {ok, collection}
Test a collection or a core with its ping handler: {ok, collection}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
admin
solr ping "{\"url\": \"http://localhost:8983/solr\"}" "products"
mentdb
{"ok": true, "collection": "products"}
solr collections <config>
Description
The names of the collections (SolrCloud) or of the cores (standalone)
The names of the collections (SolrCloud) or of the cores (standalone)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
admin
solr collections "{\"url\": \"http://localhost:8983/solr\"}"
mentdb
["products", "tmpcore"]
solr cores <config>
Description
The cores as rows {name, docs, deleted_docs, bytes, last_modified, start_time}
The cores as rows {name, docs, deleted_docs, bytes, last_modified, start_time}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
admin
solr cores "{\"url\": \"http://localhost:8983/solr\"}"
mentdb
[{"name": "products", "docs": 0, "deleted_docs": 0, "bytes": 69, "last_modified": null, "start_time": "2026-11-17T11:24:06.399Z"}, {"name": "tmpcore", "docs": 0, "deleted_docs": 0, "bytes": 69, "last_modified": null, "start_time": "2026-11-17T11:24:06.496Z"}]
solr insert <config> <collection> <rows_json>
Description
Insert or replace documents from MQL rows (with the unique key, id by default), by batches of 1000. Returns {inserted, errors, committed}; the documents are visible after a commit
Insert or replace documents from MQL rows (with the unique key, id by default), by batches of 1000. Returns {inserted, errors, committed}; the documents are visible after a commit
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
admin
solr insert "{\"url\": \"http://localhost:8983/solr\"}" "products" "[{\"id\": \"p1\", \"name\": \"Café\", \"price\": 3.5, \"tags\": [\"hot\", \"drink\"]}, {\"id\": \"p2\", \"name\": \"Thé vert\", \"price\": 2.8, \"tags\": [\"hot\"]}]"
mentdb
{"inserted": 2, "errors": [], "committed": false}
solr insert <config> <collection> <rows_json> <options_json>
Description
Insert with options: commit (false; true: with the last batch), commit_within (milliseconds), batch_size (1000), id_field (copied into id as a string), overwrite (true)
Insert with options: commit (false; true: with the last batch), commit_within (milliseconds), batch_size (1000), id_field (copied into id as a string), overwrite (true)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
rows_json: The MQL rows: a JSON array of objects - String - required
options_json: The options - String - required
admin
solr insert "{\"url\": \"http://localhost:8983/solr\"}" "products" "[{\"sku\": 3, \"name\": \"Croissant\", \"price\": 1.2}, {\"sku\": 4, \"name\": \"Pain\", \"price\": 1.1}]" "{\"id_field\": \"sku\", \"commit\": true}"
mentdb
{"inserted": 2, "errors": [], "committed": true}
solr put <config> <collection> <id> <document_json>
Description
Index or replace one document by id. Returns {id, result}
Index or replace one document by id. Returns {id, result}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
admin
solr put "{\"url\": \"http://localhost:8983/solr\"}" "products" "p5" "{\"name\": \"Chocolat chaud\", \"price\": 3.9}"
mentdb
{"id": "p5", "result": "indexed"}
solr put <config> <collection> <id> <document_json> <options_json>
Description
Put with options: commit, commit_within, unique_key (id)
Put with options: commit, commit_within, unique_key (id)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
id: The id - String - required
document_json: The document as a JSON object - String - required
options_json: The options - String - required
admin
solr put "{\"url\": \"http://localhost:8983/solr\"}" "products" "p6" "{\"name\": \"Jus\", \"price\": 2.5}" "{\"commit\": true}"
mentdb
{"id": "p6", "result": "indexed"}
solr commit <config> <collection>
Description
Commit: the added and deleted documents become visible. Returns 1
Commit: the added and deleted documents become visible. Returns 1
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
admin
solr commit "{\"url\": \"http://localhost:8983/solr\"}" "products"
mentdb
1
solr commit <config> <collection> <options_json>
Description
Commit with options: soft (true: a soft commit), optimize (true: merge the segments, slow)
Commit with options: soft (true: a soft commit), optimize (true: merge the segments, slow)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
options_json: The options - String - required
admin
solr commit "{\"url\": \"http://localhost:8983/solr\"}" "products" "{\"soft\": true}"
mentdb
1
solr get <config> <collection> <id>
Description
A document by id with the real-time get handler (even before a commit), null if it does not exist
A document by id with the real-time get handler (even before a commit), null if it does not exist
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
id: The id - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
id: The id - String - required
admin
solr get "{\"url\": \"http://localhost:8983/solr\"}" "products" "p2"
mentdb
{"id": "p2", "name": ["Thé vert"], "price": [2.8], "tags": ["hot"], "_version_": 1882104420448075776, "_root_": "p2"}
no such id (fixed result: real Solr 9.11.0)
admin
solr get "{\"url\": \"http://localhost:8983/solr\"}" "products" "nothing"
mentdb
null
solr find <config> <collection> <filter_json>
Description
The documents of a filter as rows (10 by default)
The documents of a filter as rows (10 by default)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
admin
solr find "{\"url\": \"http://localhost:8983/solr\"}" "products" "{\"id\": [\"p1\", \"p2\"]}"
mentdb
[{"id": "p1", "name": ["Café"], "price": [3.5], "tags": ["hot", "drink"], "_version_": 1882104420447027200, "_root_": "p1"}, {"id": "p2", "name": ["Thé vert"], "price": [2.8], "tags": ["hot"], "_version_": 1882104420448075776, "_root_": "p2"}]
solr find <config> <collection> <filter_json> <options_json>
Description
The documents of a filter with options: limit (10, 100000 at most), skip, sort ("price:desc,id"), fields
The documents of a filter with options: limit (10, 100000 at most), skip, sort ("price:desc,id"), fields
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
options_json: The options: limit, skip, sort ("year:desc,title"), fields (a list or "a,b") - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
options_json: The options: limit, skip, sort ("year:desc,title"), fields (a list or "a,b") - String - required
admin
solr find "{\"url\": \"http://localhost:8983/solr\"}" "products" "price:[1 TO 3]" "{\"sort\": \"price:desc\", \"fields\": \"id,price\"}"
mentdb
[{"id": "p2", "price": [2.8]}, {"id": "p6", "price": [2.5]}, {"id": "3", "price": [1.2]}, {"id": "4", "price": [1.1]}]
solr count <config> <collection>
Description
The number of documents
The number of documents
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
admin
solr count "{\"url\": \"http://localhost:8983/solr\"}" "products"
mentdb
6
solr count <config> <collection> <filter_json>
Description
The number of documents of a filter
The number of documents of a filter
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
admin
solr count "{\"url\": \"http://localhost:8983/solr\"}" "products" "price:[2 TO *]"
mentdb
4
solr search <config> <collection>
Description
All the documents (q *:*, 10 rows by default) as rows with their score
All the documents (q *:*, 10 rows by default) as rows with their score
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
admin
solr search "{\"url\": \"http://localhost:8983/solr\"}" "products"
mentdb
[{"id": "p1", "name": ["Café"], "price": [3.5], "tags": ["hot", "drink"], "_version_": 1882104420447027200, "_root_": "p1", "score": 1}, {"id": "p2", "name": ["Thé vert"], "price": [2.8], "tags": ["hot"], "_version_": 1882104420448075776, "_root_": "p2", "score": 1}, {"id": "3", "sku": [3], "name": ["Croissant"], "price": [1.2], "_version_": 1882104420467998720, "_root_": "3", "score": 1}, {"id": "4", "sku": [4], "name": ["Pain"], "price": [1.1], "_version_": 1882104420467998721, "_root_": "4", "score": 1}, {"id": "p5", "name": ["Chocolat chaud"], "price": [3.9], "_version_": 1882104420497358848, "_root_": "p5", "score": 1}, {"id": "p6", "name": ["Jus"], "price": [2.5], "_version_": 1882104420499456000, "_root_": "p6", "score": 1}]
solr search <config> <collection> <json_query>
Description
A search: a plain text is q, a JSON object holds the Solr parameters. The rows have their score unless fl is given
A search: a plain text is q, a JSON object holds the Solr parameters. The rows have their score unless fl is given
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
json_query: The Solr parameters as a JSON object: q (*:* by default), fq (a string or an array), fl, sort, rows, start, df, defType, facet, facet.field... A value is a string, a number, a boolean or an array (repeated parameter) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
json_query: The Solr parameters as a JSON object: q (*:* by default), fq (a string or an array), fl, sort, rows, start, df, defType, facet, facet.field... A value is a string, a number, a boolean or an array (repeated parameter) - String - required
admin
solr search "{\"url\": \"http://localhost:8983/solr\"}" "products" "name:thé"
mentdb
[{"id": "p2", "name": ["Thé vert"], "price": [2.8], "tags": ["hot"], "_version_": 1882104420448075776, "_root_": "p2", "score": 0.58129996}]
fields, a sort and a filter query (fixed result: real Solr 9.11.0)
admin
solr search "{\"url\": \"http://localhost:8983/solr\"}" "products" "{\"q\": \"*:*\", \"fq\": [\"price:[1 TO *]\"], \"fl\": \"id,name,price\", \"sort\": \"price asc\", \"rows\": 3}"
mentdb
[{"id": "4", "name": ["Pain"], "price": [1.1]}, {"id": "3", "name": ["Croissant"], "price": [1.2]}, {"id": "p6", "name": ["Jus"], "price": [2.5]}]
solr search <config> <collection> <json_query> <options_json>
Description
A search with options: full (true: {total, start, max_score, rows} and facet_counts, highlighting, stats... when asked), handler (select)
A search with options: full (true: {total, start, max_score, rows} and facet_counts, highlighting, stats... when asked), handler (select)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
json_query: The Solr parameters as a JSON object: q (*:* by default), fq (a string or an array), fl, sort, rows, start, df, defType, facet, facet.field... A value is a string, a number, a boolean or an array (repeated parameter) - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
json_query: The Solr parameters as a JSON object: q (*:* by default), fq (a string or an array), fl, sort, rows, start, df, defType, facet, facet.field... A value is a string, a number, a boolean or an array (repeated parameter) - String - required
options_json: The options - String - required
admin
solr search "{\"url\": \"http://localhost:8983/solr\"}" "products" "{\"q\": \"*:*\", \"rows\": 0, \"facet\": true, \"facet.field\": \"tags\"}" "{\"full\": true}"
mentdb
{"total": 6, "start": 0, "max_score": 1, "rows": [], "facet_counts": {"facet_queries": {}, "facet_fields": {"tags": []}, "facet_ranges": {}, "facet_intervals": {}, "facet_heatmaps": {}}}
solr search_all <config> <collection>
Description
All the documents with cursorMark (sorted by the unique key), 100000 rows at most by default
All the documents with cursorMark (sorted by the unique key), 100000 rows at most by default
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
admin
solr search_all "{\"url\": \"http://localhost:8983/solr\"}" "products"
mentdb
[{"id": "3", "sku": [3], "name": ["Croissant"], "price": [1.2], "_version_": 1882104420467998720, "_root_": "3"}, {"id": "4", "sku": [4], "name": ["Pain"], "price": [1.1], "_version_": 1882104420467998721, "_root_": "4"}, {"id": "p1", "name": ["Café"], "price": [3.5], "tags": ["hot", "drink"], "_version_": 1882104420447027200, "_root_": "p1"}, {"id": "p2", "name": ["Thé vert"], "price": [2.8], "tags": ["hot"], "_version_": 1882104420448075776, "_root_": "p2"}, {"id": "p5", "name": ["Chocolat chaud"], "price": [3.9], "_version_": 1882104420497358848, "_root_": "p5"}, {"id": "p6", "name": ["Jus"], "price": [2.5], "_version_": 1882104420499456000, "_root_": "p6"}]
solr search_all <config> <collection> <json_query> <options_json>
Description
All the documents of a query; options: limit (100000, 1000000 at most), page_size (1000), unique_key (id: added to the sort when absent)
All the documents of a query; options: limit (100000, 1000000 at most), page_size (1000), unique_key (id: added to the sort when absent)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
json_query: The Solr parameters as a JSON object: q (*:* by default), fq (a string or an array), fl, sort, rows, start, df, defType, facet, facet.field... A value is a string, a number, a boolean or an array (repeated parameter) - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
json_query: The Solr parameters as a JSON object: q (*:* by default), fq (a string or an array), fl, sort, rows, start, df, defType, facet, facet.field... A value is a string, a number, a boolean or an array (repeated parameter) - String - required
options_json: The options - String - required
admin
solr search_all "{\"url\": \"http://localhost:8983/solr\"}" "products" "{\"q\": \"*:*\", \"fl\": \"id\"}" "{\"page_size\": 2}"
mentdb
[{"id": "3"}, {"id": "4"}, {"id": "p1"}, {"id": "p2"}, {"id": "p5"}, {"id": "p6"}]
solr update <config> <collection> <filter_json> <changes_json>
Description
Set fields on the documents of a filter with atomic updates (100000 documents at most; the fields must be stored or have docValues). Returns {matched, modified}
Set fields on the documents of a filter with atomic updates (100000 documents at most; the fields must be stored or have docValues). Returns {matched, modified}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
changes_json: The fields to set, as a JSON object - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
changes_json: The fields to set, as a JSON object - String - required
admin
solr update "{\"url\": \"http://localhost:8983/solr\"}" "products" "{\"id\": [\"p1\", \"p2\"]}" "{\"price\": 3.0}"
mentdb
{"matched": 2, "modified": 2}
solr update <config> <collection> <filter_json> <changes_json> <options_json>
Description
Update with options: commit, commit_within, unique_key (id), limit (100000)
Update with options: commit, commit_within, unique_key (id), limit (100000)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
changes_json: The fields to set, as a JSON object - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
changes_json: The fields to set, as a JSON object - String - required
options_json: The options - String - required
admin
solr update "{\"url\": \"http://localhost:8983/solr\"}" "products" "price:[0 TO 2]" "{\"price\": 1.0}" "{\"commit\": true}"
mentdb
{"matched": 2, "modified": 2}
solr collection_info <config> <collection>
Description
A collection or a core: {name, docs, unique_key, fields (rows of the schema)}
A collection or a core: {name, docs, unique_key, fields (rows of the schema)}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
admin
solr collection_info "{\"url\": \"http://localhost:8983/solr\"}" "products"
mentdb
{"name": "products", "docs": 6, "unique_key": "id", "fields": [{"name": "_nest_path_", "type": "_nest_path_"}, {"name": "_root_", "type": "string", "indexed": true, "stored": false}, {"name": "_text_", "type": "text_general", "multiValued": true, "indexed": true, "stored": false}, {"name": "_version_", "type": "plong", "indexed": false, "stored": false}, {"name": "id", "type": "string", "multiValued": false, "indexed": true, "required": true, "stored": true}, {"name": "name", "type": "text_general"}, {"name": "price", "type": "pdoubles"}, {"name": "sku", "type": "plongs"}, {"name": "tags", "type": "text_general"}]}
solr delete <config> <collection> <ids>
Description
Delete documents by id: an id, or a JSON array of ids. Returns {deleted: the number of ids requested} (Solr does not say how many of them existed)
Delete documents by id: an id, or a JSON array of ids. Returns {deleted: the number of ids requested} (Solr does not say how many of them existed)
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
ids: An id or a JSON array of ids - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
ids: An id or a JSON array of ids - String - required
admin
solr delete "{\"url\": \"http://localhost:8983/solr\"}" "products" "p1"
mentdb
{"deleted": 1}
solr delete <config> <collection> <ids> <options_json>
Description
Delete by id with options: commit, commit_within
Delete by id with options: commit, commit_within
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
ids: An id or a JSON array of ids - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
ids: An id or a JSON array of ids - String - required
options_json: The options - String - required
admin
solr delete "{\"url\": \"http://localhost:8983/solr\"}" "products" "[\"3\", \"4\"]" "{\"commit\": true}"
mentdb
{"deleted": 2}
solr delete_where <config> <collection> <filter_json>
Description
Delete the documents of a filter. An empty filter ({} with any spaces) is refused: give *:* to delete everything. Returns {deleted: the number found by the filter just before}
Delete the documents of a filter. An empty filter ({} with any spaces) is refused: give *:* to delete everything. Returns {deleted: the number found by the filter just before}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
admin
solr delete_where "{\"url\": \"http://localhost:8983/solr\"}" "products" "price:[0 TO 3]"
mentdb
{"deleted": 2}
solr delete_where <config> <collection> <filter_json> <options_json>
Description
Delete by filter with options: commit, commit_within
Delete by filter with options: commit, commit_within
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
options_json: The options - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
collection: The collection (SolrCloud) or the core (standalone) - String - required
filter_json: The filter: {} for all; an object of equalities {"author": "Hugo", "year": [1831, 1862]} (values as quoted phrases, null = field absent); or a Solr query text like price:[0 TO 3] - String - required
options_json: The options - String - required
admin
solr delete_where "{\"url\": \"http://localhost:8983/solr\"}" "products" "*:*" "{\"commit\": true}"
mentdb
{"deleted": 3}
solr request <config> <method> <path>
Description
Any endpoint (path relative to the url, like /products/schema/fields): the JSON answer, or the text
Any endpoint (path relative to the url, like /products/schema/fields): the JSON answer, or the text
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path with an optional query string - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path with an optional query string - String - required
admin
solr request "{\"url\": \"http://localhost:8983/solr\"}" "GET" "/products/schema/uniquekey"
mentdb
{"responseHeader": {"status": 0, "QTime": 0}, "uniqueKey": "id"}
solr request <config> <method> <path> <body_json>
Description
Any endpoint with a JSON body
Any endpoint with a JSON body
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path - String - required
body_json: The body - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
method: The HTTP method - String - required
path: The path - String - required
body_json: The body - String - required
admin
solr request "{\"url\": \"http://localhost:8983/solr\"}" "POST" "/products/schema" "{\"add-field\": {\"name\": \"brand\", \"type\": \"string\", \"stored\": true}}"
mentdb
{"responseHeader": {"status": 0, "QTime": 58}}
solr collection_drop <config> <name>
Description
Delete a collection (SolrCloud) or unload a core with its index, data and instance folders (standalone). Returns {dropped, existed}
Delete a collection (SolrCloud) or unload a core with its index, data and instance folders (standalone). Returns {dropped, existed}
Parameters
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The name - String - required
config: The configuration as JSON: url (http://localhost:8983/solr), username with password (the name of a secret: secret set) for the basic authentication, or bearer (the name of a secret: secret set) for JWT, ca_file, insecure (localhost only), allow_plain, timeout_ms (30000), max_response_mb (64) - String - required
name: The name - String - required
admin
solr collection_drop "{\"url\": \"http://localhost:8983/solr\"}" "tmpcore"
mentdb
{"dropped": "tmpcore", "existed": true}
no such core (fixed result: real Solr 9.11.0)
admin
solr collection_drop "{\"url\": \"http://localhost:8983/solr\"}" "oldcore"
mentdb
{"dropped": "oldcore", "existed": false}
