Interface CollectionSpawnOptions

Options for spawning a new collection.

interface CollectionSpawnOptions {
    defaultMaxTimeMS?: null | number;
    embeddingApiKey?: null | string | EmbeddingHeadersProvider;
    namespace?: string;
}

Hierarchy (view full)

Properties

defaultMaxTimeMS? embeddingApiKey? namespace?

Properties

Optional defaultMaxTimeMS

defaultMaxTimeMS?: null | number

The default maxTimeMS for all operations on the collection. Will override the maxTimeMS set in the DataAPIClient options; it can be overridden on a per-operation basis.

This does not mean the request will be cancelled after this time, but rather that the client will wait for this time before considering the request to have timed out.

The request may or may not still be running on the server after this time.

Optional embeddingApiKey

embeddingApiKey?: null | string | EmbeddingHeadersProvider

The API key for the embedding service to use, or the EmbeddingHeadersProvider if using a provider that requires it (e.g. AWS bedrock).

Optional namespace

namespace?: string

The namespace (aka keyspace) to use for the db operation.

Settings

Member Visibility

Theme

On This Page

defaultMaxTimeMSembeddingApiKeynamespace