Liking cljdoc? Tell your friends :D

typesense.client


create-api-key!clj

(create-api-key! settings options)

Create api-key.

Create api-key.
sourceraw docstring

create-collection!clj

(create-collection! settings schema)

Create collection using the supplied collection schema.

Create collection using the supplied collection schema.
sourceraw docstring

create-document!clj

(create-document! settings collection-name document)

Indexes the document.

Indexes the document.
sourceraw docstring

create-documents!clj

(create-documents! settings collection-name documents & {:as opt})

Creates documents in the specified collection.

Creates documents in the specified collection.
sourceraw docstring

delete-alias!clj

(delete-alias! settings collection-name)

Delete alias on collection-name

Delete alias on collection-name
sourceraw docstring

delete-api-key!clj

(delete-api-key! settings id)

Deletes api-key on id.

Deletes api-key on id.
sourceraw docstring

delete-collection!clj

(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.
sourceraw docstring

delete-document!clj

(delete-document! settings collection-name id)

Deletes the document on id in the specified collection.

Deletes the document on id in the specified collection.
sourceraw docstring

delete-documents!clj

(delete-documents! settings collection-name options)

Delete documents.

Delete documents.
sourceraw docstring

delete-override!clj

(delete-override! settings collection-name override-name)

Delete override on name.

Delete override on name.
sourceraw docstring

delete-synonym!clj

(delete-synonym! settings collection-name synonym-name)

Delete synonym on synonym-name in collection.

Delete synonym on synonym-name in collection.
sourceraw docstring

export-documentsclj

(export-documents settings collection-name options)

Exports documents in the specified collection.

Exports documents in the specified collection.
sourceraw docstring

healthclj

(health settings)

Get health information about a Typesense node.

Get health information about a Typesense node.
sourceraw docstring

list-aliasesclj

(list-aliases settings)

List aliases.

List aliases.
sourceraw docstring

list-api-keysclj

(list-api-keys settings)

List api-keys.

List api-keys.
sourceraw docstring

list-collectionsclj

(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.
sourceraw docstring

list-overridesclj

(list-overrides settings collection-name)

Lists overrides.

Lists overrides.
sourceraw docstring

list-synonymsclj

(list-synonyms settings collection-name)

List synonyms in collection

List synonyms in collection
sourceraw docstring

metricsclj

(metrics settings)

Get current RAM, CPU, Disk & Network usage metrics.

Get current RAM, CPU, Disk & Network usage metrics.
sourceraw docstring

(multi-search settings
              search-reqs
              common-search-params
              &
              {:as opt-query-params})

Search for documents in multiple collections.

Search for documents in multiple collections.
sourceraw docstring

retrieve-aliasclj

(retrieve-alias settings collection-name)

Retrieves alias on collection-name.

Retrieves alias on collection-name.
sourceraw docstring

retrieve-api-keyclj

(retrieve-api-key settings id)

Retrives api-key on id.

Retrives api-key on id.
sourceraw docstring

retrieve-collectionclj

(retrieve-collection settings collection-name)

Retrieves collection on collection name.

Retrieves collection on collection name.
sourceraw docstring

retrieve-documentclj

(retrieve-document settings collection-name id)

Retrieves the document on id in the specified collection.

Retrieves the document on id in the specified collection.
sourceraw docstring

retrieve-overrideclj

(retrieve-override settings collection-name override-name)

Retrieve override on name.

Retrieve override on name.
sourceraw docstring

retrieve-synonymclj

(retrieve-synonym settings collection-name synonym-name)

Retrieve synonym on synonym-name in collection.

Retrieve synonym on synonym-name in collection.
sourceraw docstring

(search settings collection-name options)

Search for documents using the specified query options.

Search for documents using the specified query options.
sourceraw docstring

statsclj

(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.
sourceraw docstring

update-collection!clj

(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.
sourceraw docstring

update-document!clj

(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
sourceraw docstring

update-documents!clj

(update-documents! settings collection-name documents & {:as opt})

Updates documents in the specified collection.

Updates documents in the specified collection.
sourceraw docstring

upsert-alias!clj

(upsert-alias! settings collection-name alias-collection)

Upsert alias.

Upsert alias.
sourceraw docstring

upsert-document!clj

(upsert-document! settings collection-name document)

Indexes the document.

Indexes the document.
sourceraw docstring

upsert-documents!clj

(upsert-documents! settings collection-name documents & {:as opt})

Upserts documents in the specified collection.

Upserts documents in the specified collection.
sourceraw docstring

upsert-override!clj

(upsert-override! settings collection-name override-name override)

Upsert override.

Upsert override.
sourceraw docstring

upsert-synonym!clj

(upsert-synonym! settings collection-name synonym-name synonyms)

Upsert synonym.

Upsert synonym.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close