# LanceDB ## Docs - [Create a materialized view](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/materializedview/create-a-materialized-view.md): Create a materialized view at identifier `id`. The view may be query-backed, UDTF-backed, or chunker-backed, controlled by the `kind` discriminator. - [Trigger an async materialized view refresh](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/materializedview/trigger-an-async-materialized-view-refresh.md): Trigger an asynchronous refresh job for materialized view `id`. Returns a job ID for tracking. - [Check if a namespace exists](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/namespace/check-if-a-namespace-exists.md): Check if namespace `id` exists. - [Create a new namespace](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/namespace/create-a-new-namespace.md): Create new namespace `id`. - [Describe a namespace](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/namespace/describe-a-namespace.md): Describe the detailed information for namespace `id`. - [Drop a namespace](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/namespace/drop-a-namespace.md): Drop namespace `id` from its parent namespace. - [List namespaces](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/namespace/list-namespaces.md): List all child namespace names of the parent namespace `id`. - [List tables in a namespace](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/namespace/list-tables-in-a-namespace.md): List all child table names of the parent namespace `id`. - [Add new columns to table schema](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/add-new-columns-to-table-schema.md): Add new columns to table `id` using SQL expressions or default values. - [Analyze query execution plan](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/analyze-query-execution-plan.md): Analyze the query execution plan for a query against table `id`. Returns detailed statistics and analysis of the query execution plan. - [Atomically commit a batch of mixed table operations](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/atomically-commit-a-batch-of-mixed-table-operations.md): Atomically commit a batch of table operations. This is a generalized version of `BatchCreateTableVersions` that supports mixed operation types within a single atomic transaction at the metadata layer. - [Atomically create versions for multiple tables](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/atomically-create-versions-for-multiple-tables.md): Atomically create new version entries for multiple tables. - [Check if a table exists](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/check-if-a-table-exists.md): Check if table `id` exists. - [Count rows in a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/count-rows-in-a-table.md): Count the number of rows in table `id` - [Create a new branch](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/create-a-new-branch.md): Create a new branch for table `id` starting from a source ref (another branch and/or version), defaulting to the latest version of the main branch. - [Create a new table version](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/create-a-new-table-version.md): Create a new version entry for table `id`. - [Create a new tag](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/create-a-new-tag.md): Create a new tag for table `id` that points to a specific version. - [Create a scalar index on a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/create-a-scalar-index-on-a-table.md): Create a scalar index on a table field for faster filtering operations. Supports scalar indexes (BTREE, BITMAP, LABEL_LIST, FTS, etc.). This is an alias for CreateTableIndex specifically for scalar indexes. Index creation is handled asynchronously. Use the `ListTableIndices` and `DescribeTableIndexS… - [Create a table with the given name](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/create-a-table-with-the-given-name.md): Create table `id` in the namespace with the given data in Arrow IPC stream. - [Create an index on a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/create-an-index-on-a-table.md): Create an index on a table field for faster search operations. Supports vector indexes (IVF_FLAT, IVF_HNSW_SQ, IVF_PQ, etc.) and scalar indexes (BTREE, BITMAP, FTS, etc.). Index creation is handled asynchronously. Use the `ListTableIndices` and `DescribeTableIndexStats` operations to monitor index c… - [Declare a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/declare-a-table.md): Declare a table with the given name without touching storage. This is a metadata-only operation that records the table existence and sets up aspects like access control. - [Delete a branch](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/delete-a-branch.md): Delete an existing branch from table `id`. - [Delete a tag](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/delete-a-tag.md): Delete an existing tag from table `id`. - [Delete rows from a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/delete-rows-from-a-table.md): Delete rows from table `id`. - [Delete table version records](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/delete-table-version-records.md): Delete version metadata records for table `id`. - [Deregister a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/deregister-a-table.md): Deregister table `id` from its namespace. - [Describe a specific table version](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/describe-a-specific-table-version.md): Describe the detailed information for a specific version of table `id`. - [Describe information of a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/describe-information-of-a-table.md): Describe the detailed information for table `id`. - [Drop a specific index](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/drop-a-specific-index.md): Drop the specified index from table `id`. - [Drop a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/drop-a-table.md): Drop table `id` and delete its data. - [Get query execution plan explanation](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/get-query-execution-plan-explanation.md): Get the query execution plan for a query against table `id`. Returns a human-readable explanation of how the query will be executed. - [Get table index statistics](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/get-table-index-statistics.md): Get statistics for a specific index on a table. Returns information about the index type, distance type (for vector indices), and row counts. - [Get table statistics](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/get-table-statistics.md): Get statistics for table `id`, including row counts, data sizes, and column statistics. - [Get version for a specific tag](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/get-version-for-a-specific-tag.md): Get the version number that a specific tag points to for table `id`. - [Insert records into a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/insert-records-into-a-table.md): Insert new records into table `id`. - [List all branches for a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/list-all-branches-for-a-table.md): List all branches that have been created for table `id`. Returns a map of branch names to their contents. - [List all tables](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/list-all-tables.md): List all tables across all namespaces. - [List all tags for a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/list-all-tags-for-a-table.md): List all tags that have been created for table `id`. Returns a map of tag names to their corresponding version numbers and metadata. - [List all versions of a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/list-all-versions-of-a-table.md): List all versions (commits) of table `id` with their metadata. - [List indexes on a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/list-indexes-on-a-table.md): List all indices created on a table. Returns information about each index including name, columns, status, and UUID. - [Merge insert (upsert) records into a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/merge-insert-upsert-records-into-a-table.md): Performs a merge insert (upsert) operation on table `id`. This operation updates existing rows based on a matching column and inserts new rows that don't match. It returns the number of rows inserted and updated. - [Modify existing columns](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/modify-existing-columns.md): Modify existing columns in table `id`, such as renaming or changing data types. - [Query a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/query-a-table.md): Query table `id` with vector search, full text search and optional SQL filtering. Returns results in Arrow IPC file or stream format. - [Register a table to a namespace](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/register-a-table-to-a-namespace.md): Register an existing table at a given storage location as `id`. - [Remove columns from table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/remove-columns-from-table.md): Remove specified columns from table `id`. - [Rename a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/rename-a-table.md): Rename table `id` to a new name. - [Restore table to a specific version](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/restore-table-to-a-specific-version.md): Restore table `id` to a specific version. - [Trigger an async column backfill job](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/trigger-an-async-column-backfill-job.md): Trigger an asynchronous backfill job for a computed column on table `id`. The column must be a virtual (UDF-backed) column. Returns a job ID for tracking. - [Update a tag to point to a different version](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/update-a-tag-to-point-to-a-different-version.md): Update an existing tag for table `id` to point to a different version. - [Update per-field metadata](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/update-per-field-metadata.md): Update the Arrow field (column) metadata for table `id`. - [Update rows in a table](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/update-rows-in-a-table.md): Update existing rows in table `id`. - [Update table schema metadata](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/table/update-table-schema-metadata.md): Replace the schema metadata for table `id` with the provided key-value pairs. - [Alter information of a transaction.](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/transaction/alter-information-of-a-transaction.md): Alter a transaction with a list of actions such as setting status or properties. The server should either succeed and apply all actions, or fail and apply no action. - [Describe information about a transaction](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/transaction/describe-information-about-a-transaction.md): Return a detailed information for a given transaction - [Indexing Data](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/indexing/index.md): Optimize search performance with LanceDB using vector indexes, full-text search, scalar indexes, and more. - [Quantization](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/indexing/quantization.md): Use quantization to improve storage requirements and query latency of your LanceDB vector index. - [Scalar Indexes](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/indexing/scalar-index.md): Learn how to use scalar indexes in LanceDB for efficient metadata filtering and query optimization. - [Vector Indexes](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/indexing/vector-index.md): Build and optimize LanceDB vector indexes, including IVF, HNSW and binary quantized indexes. ## OpenAPI Specs - [openapi](https://lancedb-bcbb4faf-update-indexing-docs.mintlify.site/api-reference/rest/openapi.yml)