mirror of
https://github.com/lancedb/lancedb.git
synced 2026-07-03 11:00:40 +00:00
a898dc81c2
## Summary - Add a `user_id` field to `ClientConfig` that allows users to identify themselves to LanceDB Cloud/Enterprise - The user_id is sent as the `x-lancedb-user-id` HTTP header in all requests - Supports three configuration methods: - Direct assignment via `ClientConfig.user_id` - Environment variable `LANCEDB_USER_ID` - Indirect env var lookup via `LANCEDB_USER_ID_ENV_KEY` Closes #3230 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
71 lines
931 B
Markdown
71 lines
931 B
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / ClientConfig
|
|
|
|
# Interface: ClientConfig
|
|
|
|
## Properties
|
|
|
|
### extraHeaders?
|
|
|
|
```ts
|
|
optional extraHeaders: Record<string, string>;
|
|
```
|
|
|
|
***
|
|
|
|
### idDelimiter?
|
|
|
|
```ts
|
|
optional idDelimiter: string;
|
|
```
|
|
|
|
***
|
|
|
|
### retryConfig?
|
|
|
|
```ts
|
|
optional retryConfig: RetryConfig;
|
|
```
|
|
|
|
***
|
|
|
|
### timeoutConfig?
|
|
|
|
```ts
|
|
optional timeoutConfig: TimeoutConfig;
|
|
```
|
|
|
|
***
|
|
|
|
### tlsConfig?
|
|
|
|
```ts
|
|
optional tlsConfig: TlsConfig;
|
|
```
|
|
|
|
***
|
|
|
|
### userAgent?
|
|
|
|
```ts
|
|
optional userAgent: string;
|
|
```
|
|
|
|
***
|
|
|
|
### userId?
|
|
|
|
```ts
|
|
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.
|