Skip to content

chore: cleanup lancedb related wording and update operation tags #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jackye1995 merged 1 commit into from
Jul 21, 2025
Merged

chore: cleanup lancedb related wording and update operation tags #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 1 addition & 2 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ nav:
- Apache Hive MetaStore: spec/impls/hive.md
- Apache Iceberg REST Catalog: spec/impls/iceberg.md
- User Guide:
- Overview: user-guide/overview.md
- Java SDK for LanceDB Cloud/Enterprise: user-guide/java-sdk.md
- Java SDK: user-guide/java-sdk.md
- Contributing: contributing.md
- Lance: https://lancedb.github.io/lance
56 changes: 34 additions & 22 deletions docs/src/spec/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,46 @@

The Lance Namespace Specification defines a list of operations that can be performed against any Lance namespace:

| Operation ID | Description |
|---------------------|--------------------------------------------------------------------------------------------------------------------|
| ListOperations | List the operations that are supported by this Lance namespace |
| ListNamespaces | List the names of child namespaces in the parent namespace, or root namespace if parent namespace is not specified |
| NamespaceExists | Check if a namespace exists |
| DescribeNamespace | Describe information of a namespace |
| CreateNamespace | Create a new namespace under a parent namespace, or root namespace if parent namespace is not specified |
| AlterNamespace | Alter information of a namespace |
| DropNamespace | Drop a namespace from its a parent namespace, or root namespace if parent namespace is not specified |
| ListTables | List the names of tables in a namespace |
| TableExists | Check if a table exists |
| DescribeTable | Describe information of a Lance table in the namespace |
| CreateTable | Create a new Lance table under a namespace |
| RegisterTable | Register an existing table at a given storage location to a namespace |
| AlterTable | Alter information of a Lance table |
| DropTable | Drop a table from its namespace |
| DeregisterTable | Deregister a table from its namespace, table content is kept unchanged in storage |
| DescribeTransaction | Describe information of a transaction |
| AlterTransaction | Alter information of a transaction |
| Operation ID | Latest Version | Description | Notes |
|-------------------------|----------------|--------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
| ListOperations | 1 | List the operations that are supported by this Lance namespace | |
| ListNamespaces | 1 | List the names of child namespaces in the parent namespace, or root namespace if parent namespace is not specified | |
| NamespaceExists | 1 | Check if a namespace exists | Returns no response |
| DescribeNamespace | 1 | Describe information of a namespace | |
| CreateNamespace | 1 | Create a new namespace under a parent namespace, or root namespace if parent namespace is not specified | |
| AlterNamespace | 1 | Alter information of a namespace | |
| DropNamespace | 1 | Drop a namespace from its a parent namespace, or root namespace if parent namespace is not specified | |
| ListTables | 1 | List the names of tables in a namespace | |
| TableExists | 1 | Check if a table exists | Returns no response |
| DescribeTable | 2 | Describe information of a Lance table in the namespace | |
| CreateTable | 1 | Create a new Lance table under a namespace | |
| RegisterTable | 1 | Register an existing table at a given storage location to a namespace | |
| AlterTable | 1 | Alter information of a Lance table | |
| DropTable | 1 | Drop a table from its namespace | |
| DeregisterTable | 1 | Deregister a table from its namespace, table content is kept unchanged in storage | |
| InsertIntoTable | 1 | Insert Arrow record batches into a table | Takes Arrow IRC record batches stream as request |
| MergeInsertIntoTable | 1 | Merge or insert Arrow record batches into a table based on matching condition of specific column values | Takes Arrow IRC record batches stream as request |
| UpdateTable | 1 | Update rows in a table based on conditions | |
| DeleteFromTable | 1 | Delete rows from a table based on conditions | |
| QueryTable | 1 | Query a table and return Arrow record batches | Returns Arrow IRC record batches stream as response |
| CountTableRows | 1 | Count the number of rows in a table | Returns table row count as response |
| CreateTableIndex | 1 | Create an index on a table | |
| CreateScalarTableIndex | 1 | Create a scalar index on a table | |
| DescribeTableIndexStats | 1 | Describe statistics of an index | |
| DescribeTransaction | 1 | Describe information of a transaction | |
| AlterTransaction | 1 | Alter information of a transaction | |

## Operation Versioning

There is no versioning concept within an operation. When backwards incompatible change is introduced,
a new operation needs to be created, with a naming convention of `<operationId>V<version>`,
When backwards incompatible change is introduced,
a new operation version needs to be created, with a naming convention of `<operationId>V<version>`,
for example `ListNamespacesV2`, `DescribeTableV3`, etc.

## Operation Request and Response Schema

Each operation has a request and response.
In general, each operation has a request and response.
The request and response schema is defined using JSON schema in the
`components/schemas` section of the [OpenAPI specification](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/lancedb/lance-namespace/refs/heads/main/docs/src/spec/rest.yaml).

!!! note
For exceptions to this rule, see the Notes section of the operations
Loading