docs: minor updates for js migration guides (#1451)

Co-authored-by: Will Jones <willjones127@gmail.com>
This commit is contained in:
Cory Grinstead
2024-07-22 12:26:49 -05:00
committed by GitHub
parent 2276b114c5
commit 69295548cc
51 changed files with 2353 additions and 1853 deletions

View File

@@ -1,40 +1,16 @@
[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / ConnectionOptions
[**@lancedb/lancedb**](../README.md) **Docs**
***
[@lancedb/lancedb](../globals.md) / ConnectionOptions
# Interface: ConnectionOptions
## Table of contents
### Properties
- [apiKey](ConnectionOptions.md#apikey)
- [hostOverride](ConnectionOptions.md#hostoverride)
- [readConsistencyInterval](ConnectionOptions.md#readconsistencyinterval)
## Properties
### apiKey
### readConsistencyInterval?
`Optional` **apiKey**: `string`
#### Defined in
native.d.ts:51
___
### hostOverride
`Optional` **hostOverride**: `string`
#### Defined in
native.d.ts:52
___
### readConsistencyInterval
`Optional` **readConsistencyInterval**: `number`
> `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
@@ -46,6 +22,12 @@ 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.
#### Defined in
***
native.d.ts:64
### storageOptions?
> `optional` **storageOptions**: `Record`&lt;`string`, `string`&gt;
(For LanceDB OSS only): configuration for object storage.
The available options are described at https://lancedb.github.io/lancedb/guides/storage/