Interface: ClientConfig

Properties

blobRequestConcurrency?

optional blobRequestConcurrency: number;

Maximum number of concurrent blob HTTP requests across all tables and blob handles on this connection. Defaults to 8. Can also be set with LANCE_CLIENT_BLOB_REQUEST_CONCURRENCY. Must be greater than zero.

extraHeaders?

optional extraHeaders: Record<string, string>;

idDelimiter?

optional idDelimiter: string;

The delimiter joining a namespace path and a name into one object identifier. "$" is the only supported value, and leaving this unset is how to get it; anything else is rejected when the connection is created.

retryConfig?

optional retryConfig: RetryConfig;

timeoutConfig?

optional timeoutConfig: TimeoutConfig;

tlsConfig?

optional tlsConfig: TlsConfig;

userAgent?

optional userAgent: string;

userId?

optional userId: string;

User identifier for tracking purposes.

This is sent as the x-lancedb-user-id header in requests to LanceDB Cloud/Enterprise. It can be set directly, or via the LANCEDB_USER_ID environment variable. Alternatively, set LANCEDB_USER_ID_ENV_KEY to specify another environment variable that contains the user ID value.

1.4 KiB Raw Blame History