docs: add a reference to @lancedb/lance in the docs (#1166)

We aren't yet ready to switch over the examples since almost all JS
examples rely on embeddings and we haven't yet ported those over.
However, this makes it possible for those that are interested to start
using `@lancedb/lancedb`
This commit is contained in:
Weston Pace
2024-03-29 06:55:03 -05:00
parent 1b0aaf9ec3
commit e21b56293c
34 changed files with 3561 additions and 7 deletions

View File

@@ -0,0 +1,51 @@
[@lancedb/lancedb](../README.md) / [Exports](../modules.md) / ConnectionOptions
# Interface: ConnectionOptions
## Table of contents
### Properties
- [apiKey](ConnectionOptions.md#apikey)
- [hostOverride](ConnectionOptions.md#hostoverride)
- [readConsistencyInterval](ConnectionOptions.md#readconsistencyinterval)
## Properties
### apiKey
`Optional` **apiKey**: `string`
#### Defined in
native.d.ts:51
___
### hostOverride
`Optional` **hostOverride**: `string`
#### Defined in
native.d.ts:52
___
### readConsistencyInterval
`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.
#### Defined in
native.d.ts:64