mirror of https://github.com/lancedb/lancedb.git synced 2026-05-17 20:10:39 +00:00

Files

Jack Ye a898dc81c2 feat: add user_id field to ClientConfig for user identification (#3240 )

## 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>

2026-04-06 11:20:10 -07:00

931 B

Raw Blame History

@lancedb/lancedb • Docs

@lancedb/lancedb / ClientConfig

Interface: ClientConfig

Properties

extraHeaders?

optional extraHeaders: Record<string, string>;

idDelimiter?

optional idDelimiter: string;

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.

931 B Raw Blame History