mirror of
https://github.com/lancedb/lancedb.git
synced 2026-07-05 03:50:40 +00:00
10fecdf051
Expose the merged Rust OAuth header provider through the Node/TypeScript connection path. Includes: - Native OAuthConfig conversion for napi-rs - ConnectionOptions.oauthConfig plumbing - Public TypeScript OAuthConfig and OAuthFlowType exports - Generated TypeScript API docs for the new config surface - input-validation and debug-redaction coverage in the Rust binding layer Local validation: cargo fmt --all; git diff --check.
133 lines
2.8 KiB
Markdown
133 lines
2.8 KiB
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / ConnectionOptions
|
|
|
|
# Interface: ConnectionOptions
|
|
|
|
## Properties
|
|
|
|
### apiKey?
|
|
|
|
```ts
|
|
optional apiKey: string;
|
|
```
|
|
|
|
(For LanceDB cloud only): the API key to use with LanceDB Cloud.
|
|
|
|
Can also be set via the environment variable `LANCEDB_API_KEY`.
|
|
|
|
***
|
|
|
|
### clientConfig?
|
|
|
|
```ts
|
|
optional clientConfig: ClientConfig;
|
|
```
|
|
|
|
(For LanceDB cloud only): configuration for the remote HTTP client.
|
|
|
|
***
|
|
|
|
### hostOverride?
|
|
|
|
```ts
|
|
optional hostOverride: string;
|
|
```
|
|
|
|
(For LanceDB cloud only): the host to use for LanceDB cloud. Used
|
|
for testing purposes.
|
|
|
|
***
|
|
|
|
### manifestEnabled?
|
|
|
|
```ts
|
|
optional manifestEnabled: boolean;
|
|
```
|
|
|
|
(For LanceDB OSS only): use directory namespace manifests as the source
|
|
of truth for table metadata. Existing directory-listed root tables are
|
|
migrated into the manifest on access.
|
|
|
|
***
|
|
|
|
### namespaceClientProperties?
|
|
|
|
```ts
|
|
optional namespaceClientProperties: Record<string, string>;
|
|
```
|
|
|
|
(For LanceDB OSS only): extra properties for the backing namespace
|
|
client used by manifest-enabled native connections.
|
|
|
|
***
|
|
|
|
### oauthConfig?
|
|
|
|
```ts
|
|
optional oauthConfig: NativeOAuthConfig;
|
|
```
|
|
|
|
(For LanceDB cloud only): OAuth configuration for IdP-based
|
|
authentication (e.g., Azure Entra ID). When set, token acquisition
|
|
and refresh are handled entirely in Rust. TypeScript users should pass
|
|
the public `OAuthConfig` type exported from `@lancedb/lancedb`.
|
|
|
|
***
|
|
|
|
### readConsistencyInterval?
|
|
|
|
```ts
|
|
optional readConsistencyInterval: number;
|
|
```
|
|
|
|
The interval, in seconds, at which to check for updates to the table
|
|
from other processes. If None, then consistency is not checked. For
|
|
performance reasons, this is the default. For strong consistency, set
|
|
this to zero seconds. Then every read will check for updates from other
|
|
processes. As a compromise, you can set this to a non-zero value for
|
|
eventual consistency. If more than that interval has passed since the
|
|
last check, then the table will be checked for updates. Note: this
|
|
consistency only applies to read operations. Write operations are
|
|
always consistent.
|
|
|
|
Stronger consistency is not free. The smaller the interval, the more
|
|
often each read pays the cost of checking for updates against object
|
|
storage, raising per-read latency and cost.
|
|
|
|
***
|
|
|
|
### region?
|
|
|
|
```ts
|
|
optional region: string;
|
|
```
|
|
|
|
(For LanceDB cloud only): the region to use for LanceDB cloud.
|
|
Defaults to 'us-east-1'.
|
|
|
|
***
|
|
|
|
### session?
|
|
|
|
```ts
|
|
optional session: Session;
|
|
```
|
|
|
|
(For LanceDB OSS only): the session to use for this connection. Holds
|
|
shared caches and other session-specific state.
|
|
|
|
***
|
|
|
|
### storageOptions?
|
|
|
|
```ts
|
|
optional storageOptions: Record<string, string>;
|
|
```
|
|
|
|
(For LanceDB OSS only): configuration for object storage.
|
|
|
|
The available options are described at https://docs.lancedb.com/storage/
|