Setup
A local directory needs no setup: LanceDB stores the table there, with no server. Object storage and LanceDB Cloud need credentials.Object storage
Object storage
uri also takes s3://, gs:// and az:// URIs. Pass the store’s
credentials or endpoint in storage_options.LanceDB Cloud and Enterprise
LanceDB Cloud and Enterprise
- In the LanceDB Cloud UI, open the project and copy its database URI
(it starts with
db://) and an API key. - Note the project’s region;
regiondefaults tous-east-1. - LanceDB Enterprise: the LanceDB team provides the URI, the API key and
the endpoint that goes in
host_override. - In the config, set
uri: ${LANCEDB_URI},api_key: ${LANCEDB_API_KEY}andregion: ${LANCEDB_REGION}.
Connect
- YAML
- Python
- TypeScript
workspace.yaml
Layout
- Without
table, every table is a top-level folder. - A card lists the row’s columns, without the vector and blob columns.
- The
searchCLI ranks rows by meaning and returns their<id>.mdpaths,search_limit(10) by default. The table needs an embedding function on a source column.
Sample runs
max_rows (1,000)
rows, so keep group_by to low-cardinality columns.
SDK guides
Python
Every config field, the VFS.md and write support.
TypeScript
Every config field, the VFS.md and write support.