Module Typesense.Collection

module Response : sig ... end
val get_collections : ?get_collections_parameters:string -> t -> unit -> Response.t

List all collections

Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

val create_collection : body:CollectionSchema.T.t -> t -> unit -> Response.t

Create a new collection

When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.

val get_collection : collection_name:string -> t -> unit -> Response.t

Retrieve a single collection

Retrieve the details of a collection, given its name.

  • parameter collection_name

    The name of the collection to retrieve

val delete_collection : collection_name:string -> t -> unit -> Response.t

Delete a collection

Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.

  • parameter collection_name

    The name of the collection to delete