vectordb / Exports / ConnectionOptions

接口：ConnectionOptions

属性

apiKey

• Optional apiKey: string

用于远程连接的API密钥

也可以通过设置环境变量 LANCEDB_API_KEY 来传递

定义于

index.ts:113

awsCredentials

• Optional awsCredentials: AwsCredentials

用户提供的AWS凭证。

如果未提供，LanceDB将使用默认的凭据提供链。

已弃用

请通过storageOptions传递aws_access_key_id、aws_secret_access_key和aws_session_token。

定义于

index.ts:93

aws区域

• Optional awsRegion: string

要连接的AWS区域。默认为defaultAwsRegion

已弃用

请通过storageOptions传递region参数。

定义于

index.ts:99

hostOverride

• Optional hostOverride: string 主机覆盖

覆盖远程连接的主机URL。

这对本地测试很有用。

定义于

index.ts:123

readConsistencyInterval

• Optional readConsistencyInterval: number

(仅限LanceDB开源版): 以秒为单位的间隔时间，用于检查其他进程对表的更新。如果为None，则不检查一致性。出于性能考虑，这是默认设置。如需强一致性，请将此值设为零秒，这样每次读取都会检查其他进程的更新。作为折中方案，您可以设置非零值以实现最终一致性。如果自上次检查后已超过该间隔时间，则会检查表的更新。注意：此一致性仅适用于读取操作，写入操作始终保持一致性。

定义于

index.ts:141

区域

• Optional region: string

连接区域。默认为'us-east-1'

定义于

index.ts:116

存储选项

• Optional storageOptions: Record\<string, string>

用户提供的对象存储选项。例如，S3凭证或请求超时设置。

各种选项的详细说明请参阅 https://lancedb.github.io/lancedb/guides/storage/

定义于

index.ts:106

超时时间

• Optional 超时时间: number

请求超时的持续时间（毫秒）。默认值 = 10,000（10秒）

定义于

index.ts:128

uri

• uri: string

LanceDB 数据库 URI。

/path/to/database - 本地数据库
s3://bucket/path/to/database 或 gs://bucket/path/to/database - 云存储上的数据库
db://host:port - 远程数据库（LanceDB云服务）

定义于

index.ts:84