mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-09 13:22:58 +00:00
b3a4efd587
This reverts commit a547c523c2 or #2281
The current implementation can cause panics and performance degradation.
I will bring this back with more testing in
https://github.com/lancedb/lancedb/pull/2311
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Enhanced clarity on read consistency settings with updated
descriptions and default behavior.
- Removed outdated warnings about eventual consistency from the
troubleshooting guide.
- **Refactor**
- Streamlined the handling of the read consistency interval across
integrations, now defaulting to "None" for improved performance.
- Simplified internal logic to offer a more consistent experience.
- **Tests**
- Updated test expectations to reflect the new default representation
for the read consistency interval.
- Removed redundant tests related to "no consistency" settings for
streamlined testing.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
82 lines
1.7 KiB
Markdown
82 lines
1.7 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.
|
|
|
|
***
|
|
|
|
### readConsistencyInterval?
|
|
|
|
```ts
|
|
optional readConsistencyInterval: number;
|
|
```
|
|
|
|
(For LanceDB OSS only): 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.
|
|
|
|
***
|
|
|
|
### region?
|
|
|
|
```ts
|
|
optional region: string;
|
|
```
|
|
|
|
(For LanceDB cloud only): the region to use for LanceDB cloud.
|
|
Defaults to 'us-east-1'.
|
|
|
|
***
|
|
|
|
### storageOptions?
|
|
|
|
```ts
|
|
optional storageOptions: Record<string, string>;
|
|
```
|
|
|
|
(For LanceDB OSS only): configuration for object storage.
|
|
|
|
The available options are described at https://lancedb.github.io/lancedb/guides/storage/
|