rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-09 05:12:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

allow passing api key as env var (#841)

Browse Source 
Allow passing API key as env var:
```shell
export LANCEDB_API_KEY=sh_123...
```

with this set, apiKey argument can omitted from `connect`
```js
    const db = await vectordb.connect({
        uri: "db://test-proj-01-ae8343",
        region: "us-east-1",
  })
```
```py
    db = lancedb.connect(
        uri="db://test-proj-01-ae8343",
        region="us-east-1",
    )
```
This commit is contained in:
Bert
2024-01-22 16:18:28 -05:00
committed by Weston Pace
parent d8befeeea2
commit a409000c6f
3 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
node/src/index.ts
View File

@@ -78,7 +78,11 @@ export interface ConnectionOptions {
/** AWS region to connect to. Default is {@link defaultAwsRegion}. */
awsRegion?: string
// API key for the remote connections
/**
* API key for the remote connections
*
* Can also be passed by setting environment variable `LANCEDB_API_KEY`
*/
apiKey?: string
/** Region to connect */

7
node/src/remote/index.ts
View File

@@ -38,8 +38,13 @@ export class RemoteConnection implements Connection {
if (!opts.uri.startsWith('db://')) {
throw new Error(`Invalid remote DB URI: ${opts.uri}`)
}
if (opts.apiKey == null || opts.apiKey === '') {
opts = Object.assign({}, opts, { apiKey: process.env.LANCEDB_API_KEY })
}
if (opts.apiKey === undefined || opts.region === undefined) {
throw new Error('API key and region are not supported for remote connections')
throw new Error(
'API key and region are must be passed for remote connections. ' +
'API key can also be set through LANCEDB_API_KEY env variable.')
}
this._dbName = opts.uri.slice('db://'.length)