mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-13 07:12:57 +00:00
allow passing api key as env var (#841)
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:
@@ -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 */
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
# limitations under the License.
|
||||
|
||||
import importlib.metadata
|
||||
import os
|
||||
from typing import Optional
|
||||
|
||||
__version__ = importlib.metadata.version("lancedb")
|
||||
@@ -39,6 +40,7 @@ def connect(
|
||||
api_key: str, optional
|
||||
If presented, connect to LanceDB cloud.
|
||||
Otherwise, connect to a database on file system or cloud storage.
|
||||
Can be set via environment variable `LANCEDB_API_KEY`.
|
||||
region: str, default "us-east-1"
|
||||
The region to use for LanceDB Cloud.
|
||||
host_override: str, optional
|
||||
@@ -66,6 +68,8 @@ def connect(
|
||||
A connection to a LanceDB database.
|
||||
"""
|
||||
if isinstance(uri, str) and uri.startswith("db://"):
|
||||
if api_key is None:
|
||||
api_key = os.environ.get("LANCEDB_API_KEY")
|
||||
if api_key is None:
|
||||
raise ValueError(f"api_key is required to connected LanceDB cloud: {uri}")
|
||||
return RemoteDBConnection(uri, api_key, region, host_override)
|
||||
|
||||
Reference in New Issue
Block a user