(create-collection! settings schema)
Create collection using the supplied collection schema.
Create collection using the supplied collection schema.
(create-document! settings collection-name document)
Indexes the document.
Indexes the document.
(create-documents! settings collection-name documents & {:as opt})
Creates documents in the specified collection.
Creates documents in the specified collection.
(delete-alias! settings collection-name)
Delete alias on collection-name
Delete alias on collection-name
(delete-api-key! settings id)
Deletes api-key on id.
Deletes api-key on id.
(delete-collection! settings collection-name)
Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.
Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.
(delete-document! settings collection-name id)
Deletes the document on id in the specified collection.
Deletes the document on id in the specified collection.
(delete-documents! settings collection-name options)
Delete documents.
Delete documents.
(delete-override! settings collection-name override-name)
Delete override on name.
Delete override on name.
(delete-synonym! settings collection-name synonym-name)
Delete synonym on synonym-name in collection.
Delete synonym on synonym-name in collection.
(export-documents settings collection-name options)
Exports documents in the specified collection.
Exports documents in the specified collection.
(health settings)
Get health information about a Typesense node.
Get health information about a Typesense node.
(list-collections settings)
Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.
Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.
(list-overrides settings collection-name)
Lists overrides.
Lists overrides.
(list-synonyms settings collection-name)
List synonyms in collection
List synonyms in collection
(metrics settings)
Get current RAM, CPU, Disk & Network usage metrics.
Get current RAM, CPU, Disk & Network usage metrics.
(multi-search settings
search-reqs
common-search-params
&
{:as opt-query-params})
Search for documents in multiple collections.
Search for documents in multiple collections.
(retrieve-alias settings collection-name)
Retrieves alias on collection-name.
Retrieves alias on collection-name.
(retrieve-api-key settings id)
Retrives api-key on id.
Retrives api-key on id.
(retrieve-collection settings collection-name)
Retrieves collection on collection name.
Retrieves collection on collection name.
(retrieve-document settings collection-name id)
Retrieves the document on id in the specified collection.
Retrieves the document on id in the specified collection.
(retrieve-override settings collection-name override-name)
Retrieve override on name.
Retrieve override on name.
(retrieve-synonym settings collection-name synonym-name)
Retrieve synonym on synonym-name in collection.
Retrieve synonym on synonym-name in collection.
(search settings collection-name options)
Search for documents using the specified query options.
Search for documents using the specified query options.
(stats settings)
Get stats about API endpoints. This endpoint returns average requests per second and latencies for all requests in the last 10 seconds.
Get stats about API endpoints. This endpoint returns average requests per second and latencies for all requests in the last 10 seconds.
(update-collection! settings collection-name update-schema)
Update collection on name using the supplied update-schema.
Update collection on name using the supplied update-schema.
(update-document! settings collection-name id document)
Update an individual document from a collection by using its id. The update can be partial
Update an individual document from a collection by using its id. The update can be partial
(update-documents! settings collection-name documents & {:as opt})
Updates documents in the specified collection.
Updates documents in the specified collection.
(upsert-alias! settings collection-name alias-collection)
Upsert alias.
Upsert alias.
(upsert-document! settings collection-name document)
Indexes the document.
Indexes the document.
(upsert-documents! settings collection-name documents & {:as opt})
Upserts documents in the specified collection.
Upserts documents in the specified collection.
(upsert-override! settings collection-name override-name override)
Upsert override.
Upsert override.
(upsert-synonym! settings collection-name synonym-name synonyms)
Upsert synonym.
Upsert synonym.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close