Liking cljdoc? Tell your friends :D

typesense.client


create-api-key!clj

(create-api-key! settings options)

Create api-key.

Create api-key.
raw docstring

create-collection!clj

(create-collection! settings schema)

Create collection using the supplied collection schema.

Create collection using the supplied collection schema.
raw docstring

create-document!clj

(create-document! settings collection-name document)

Indexes the document.

Indexes the document.
raw docstring

delete-alias!clj

(delete-alias! settings collection-name)

Delete alias on collection-name

Delete alias on collection-name
raw docstring

delete-api-key!clj

(delete-api-key! settings id)

Deletes api-key on id.

Deletes api-key on id.
raw 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.
raw docstring

delete-documents!clj

(delete-documents! settings collection-name options)

Delete documents.

Delete documents.
raw docstring

delete-override!clj

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

Delete override on name.

Delete override on name.
raw 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.
raw docstring

drop-collection!clj

(drop-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.
raw docstring

export-documentsclj

(export-documents settings collection-name options)

Exports documents in the specified collection.

Exports documents in the specified collection.
raw docstring

import-documents!clj

(import-documents! settings collection-name documents)
(import-documents! settings collection-name documents options)

Imports documents in the specified collection.

Imports documents in the specified collection.
raw docstring

list-aliasesclj

(list-aliases settings)

List aliases.

List aliases.
raw docstring

list-api-keysclj

(list-api-keys settings)

List api-keys.

List api-keys.
raw 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.
raw docstring

list-overridesclj

(list-overrides settings collection-name)

Lists overrides.

Lists overrides.
raw docstring

list-synonymsclj

(list-synonyms settings collection-name)

List synonyms in collection

List synonyms in collection
raw docstring

retrieve-aliasclj

(retrieve-alias settings collection-name)

Retrieves alias on collection-name.

Retrieves alias on collection-name.
raw docstring

retrieve-api-keyclj

(retrieve-api-key settings id)

Retrives api-key on id.

Retrives api-key on id.
raw docstring

retrieve-collectionclj

(retrieve-collection settings collection-name)

Retrieves collection on collection name.

Retrieves collection on collection name.
raw 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.
raw docstring

retrieve-overrideclj

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

Retrieve override on name.

Retrieve override on name.
raw docstring

retrieve-synonymclj

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

Retrieve synonym on synonym-name in collection.

Retrieve synonym on synonym-name in collection.
raw docstring

(search settings collection-name options)

Search for documents using the specified query options.

Search for documents using the specified query options.
raw 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
raw docstring

upsert-alias!clj

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

Upsert alias.

Upsert alias.
raw docstring

upsert-document!clj

(upsert-document! settings collection-name document)

Indexes the document.

Indexes the document.
raw docstring

upsert-override!clj

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

Upsert override.

Upsert override.
raw docstring

upsert-synonym!clj

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

Upsert synonym.

Upsert synonym.
raw docstring

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

× close