!function(){var e,t,n;e="9627b71b382d201",t=function(){Reo.init({clientID:"9627b71b382d201"})},(n=document.createElement("script")).src="https://static.reo.dev/"+e+"/reo.js",n.defer=!0,n.onload=t,document.head.appendChild(n)}();
 


module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  setupFiles: ['dotenv/config'],
  testMatch: ['**/*.test.ts'],
  testTimeout: 60000
};

Describe a table and return Table Information.

Describe a table

int64

name

vector

key auth

LanceDB

LanceDB Enterprise

LanceDB Cloud

Effortlessly transform Open Source experience to Cloud/Enterprise

Quickstart Guide

Performance

Ingest data

Update Data

Build an index

Vector Search

Working with multiple vectors per document in LanceDB Enterprise

Multivector Search

Full Text Search

Hybrid Search

Metadata Filtering

Schema Evolution

Versioning & Reproducibility

Query Data with SQL

Architecture

Security

LanceDB APIs let you interact programmatically with your remote database and tables.

Introduction

List tables, optionally, with pagination.

List Tables

Create a new table.

Will return 400 if table with requested name already exists.


Create a new table

Count the number of rows in a table.

Can optionally pass a predicate to count the rows that match.


Count rows in a table

Rename a table.

Drop a table

If the table does not exist, it will return 200.


Drop a table

Search for rows, using any combination of vector search, full text
search, and SQL filter expressions.


Vector Query

Insert data to a table

Update rows in a table, using SQL expressions and an optional predicate.


Apply a SQL update to a table

Delete rows from a table using a SQL predicate.

Delete rows from a table

Perform a merge-insert SQL query against a table. This can be used
to perform upserts. To perform an upsert, set `when_matched_update_all`
and `when_not_matched_insert_all` to true.


Merge-insert data to a table

Add new columns to a table. You must pass a SQL expression to generate
the new columns. This expression can reference existing columns.

For example, you can add a new column `new_column` that is `old_column + 1`:
```
{
  "new_columns": [
    {
      "name": "new_column",
      "expression": "old_column + 1"
    }
  ]
}
```

If you want to fill with null, you can use a NULL expression with a cast
to the correct type:
```
{
  "new_columns": [
    {
      "name": "new_column",
      "expression": "CAST(NULL AS int64)"
    }
  ]
}
```

Some example data types:
- int64
- float32
- string


Add columns to a table

Alter the name, type, or nullability of a column.


Alter name, type, or nullability of a column

Drop columns from a table

Create an index on a column. We support vector, full text search, and scalar indices.

Vector index options are: `IVF_PQ` and `IVF_HNSW_SQ`. The `distance_type`
parameter is required for vector indices.

For [full text search](https://lancedb.github.io/lancedb/fts/), use `FTS`.
For [scalar indices](https://lancedb.github.io/lancedb/guides/scalar_index/),
use `BTREE`, `BITMAP`, or `LABEL_LIST`.


Create Vector Index

List indices of a table

List the detailed information of an index, including index type, distance metric, and number of rows indexed/unindexed.

API Documentation

Tables

Data

Index

Describe a table

Authorizations

Path Parameters

Response