LanceDB Table API is one of 16 APIs that LanceDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Table. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and release notes.
This API exposes
41 operations
across 41 paths,
and defines 97 schemas.
It is described by OpenAPI 3.1.1, at version 1.0.0.
Requests are made against 2 base URLs: {scheme}://{host}:{port}/{basePath}, {scheme}://{host}/{basePath}.
The identity and technical contract details declared by the specification.
CountTableRowsResponse
integer
Response containing the count of rows. Serializes transparently as just the number for backward compatibility.
AlterTableDropColumnsResponse
object
2 properties
1 required
UpdateTableTagResponse
object
Response for update tag operation
1 property
TagContents
object
3 properties
2 required
GetTableTagVersionRequest
object
4 properties
1 required
ManifestNamingScheme
string
The naming scheme used for manifest files in the versions/ directory. Known values: - V1: versions/{version}.manifest - Simple version-based naming - V2: versi…
ListTableIndicesRequest
object
6 properties
IndexContent
object
4 properties
4 required
DescribeTableVersionResponse
object
Response containing the table version information
1 property
1 required
DescribeTableIndexStatsResponse
object
5 properties
DeregisterTableRequest
object
The table content remains available in the storage.
3 properties
RenameTableRequest
object
5 properties
1 required
AlterTableBackfillColumnsResponse
object
1 property
1 required
CommitTableResult
object
Result of a single operation within a batch commit. Each result corresponds to one operation in the request, in the same order. Exactly one of the result field…
4 properties
VersionRange
object
A range of versions to delete (start inclusive, end exclusive). Special values: - startversion: 0 with endversion: -1 means ALL versions
2 properties
2 required
JsonArrowDataType
object
JSON representation of an Apache Arrow DataType
3 properties
1 required
ErrorResponse
object
Common JSON error response model
4 properties
1 required
MultiMatchQuery
object
1 property
1 required
AlterColumnsEntry
object
5 properties
1 required
DeleteTableTagResponse
object
Response for delete tag operation
1 property
ExplainTableQueryPlanRequest
object
5 properties
1 required
JsonArrowSchema
object
JSON representation of a Apache Arrow schema.
2 properties
1 required
DropTableIndexResponse
object
Response for drop index operation
1 property
RestoreTableResponse
object
Response for restore table operation
1 property
AlterTableAddColumnsRequest
object
3 properties
1 required
DeclareTableResponse
object
Response for declaring a table.
5 properties
TableExistsRequest
object
4 properties
AddColumnsEntry
object
3 properties
1 required
BatchDeleteTableVersionsResponse
object
Response for deleting table version records
2 properties
AddVirtualColumnEntry
object
11 properties
6 required
QueryTableRequest
object
21 properties
2 required
UpdateTableResponse
object
4 properties
2 required
CommitTableOperation
object
A single operation within a batch commit. Provide exactly one of the operation fields to specify the operation kind.
4 properties
BatchCommitTablesRequest
object
Request to atomically commit a batch of table operations. This replaces BatchCreateTableVersionsRequest with a more general interface that supports mixed opera…
3 properties
1 required
BatchDeleteTableVersionsRequest
object
Request to delete table version records. Supports deleting ranges of versions for efficient bulk cleanup.
4 properties
1 required
DeleteFromTableRequest
object
Delete data from table based on a SQL predicate. Returns the number of rows that were deleted.
4 properties
1 required
DeleteTableTagRequest
object
4 properties
1 required
CreateTableVersionResponse
object
Response for creating a table version
2 properties
FragmentStats
object
3 properties
3 required
ListTablesResponse
object
2 properties
1 required
CreateTableIndexResponse
object
Response for create index operation
1 property
MergeInsertIntoTableResponse
object
Response from merge insert operation
5 properties
RestoreTableRequest
object
4 properties
1 required
RegisterTableRequest
object
6 properties
1 required
ListTableIndicesResponse
object
2 properties
1 required
CreateTableResponse
object
5 properties
DeclareTableRequest
object
Request for declaring a table.
6 properties
AlterVirtualColumnEntry
object
10 properties
DescribeTableRequest
object
8 properties
DeleteFromTableResponse
object
2 properties
DescribeTableResponse
object
12 properties
FtsQuery
object
Full-text search query. Exactly one query type field must be provided. This structure follows the same pattern as AlterTransactionAction to minimize difference…
5 properties
BatchCreateTableVersionsResponse
object
Response for batch creating table versions. Contains the created versions for each table in the same order as the request.
2 properties
1 required
CreateTableIndexRequest
object
15 properties
2 required
AlterTableAlterColumnsRequest
object
3 properties
1 required
AlterTableBackfillColumnsRequest
object
16 properties
1 required
Identity
object
Identity information of a request.
2 properties
CreateTableTagResponse
object
Response for create tag operation
1 property
RegisterTableResponse
object
3 properties
DropTableResponse
object
4 properties
DescribeTableIndexStatsRequest
object
5 properties
UpdateTableRequest
object
Each update consists of a column name and an SQL expression that will be evaluated against the current row's value. Optionally, a predicate can be provided to…
6 properties
1 required
StringFtsQuery
object
2 properties
1 required
GetTableStatsResponse
object
4 properties
4 required
CreateTableTagRequest
object
5 properties
2 required
CreateTableScalarIndexResponse
object
Response for create scalar index operation
1 property
StructuredFtsQuery
object
1 property
1 required
BooleanQuery
object
Boolean query with must, should, and mustnot clauses
3 properties
3 required
PageToken
string
An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot retu…
DeregisterTableResponse
object
4 properties
MatchQuery
object
7 properties
1 required
PhraseQuery
object
3 properties
1 required
FragmentSummary
object
7 properties
7 required
RenameTableResponse
object
1 property
AlterTableAlterColumnsResponse
object
1 property
1 required
BoostQuery
object
Boost query that scores documents matching positive query higher and negative query lower
3 properties
2 required
DescribeTableVersionRequest
object
Request to describe a specific table version
4 properties
ListTableTagsResponse
object
Response containing table tags
2 properties
1 required
JsonArrowField
object
JSON representation of an Apache Arrow field.
4 properties
3 required
AlterTableDropColumnsRequest
object
4 properties
1 required
TableVersion
object
6 properties
2 required
GetTableStatsRequest
object
3 properties
BatchCommitTablesResponse
object
Response for a batch commit of table operations. Contains the results of each operation in the same order as the request.
2 properties
1 required
UpdateTableTagRequest
object
5 properties
2 required
CountTableRowsRequest
object
5 properties
Operator
string
The operator to use for combining terms. Case insensitive, supports both PascalCase and snakecase. Valid values are: - And: All terms must match. - Or: At leas…
AnalyzeTableQueryPlanRequest
object
21 properties
2 required
Context
object
Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are pa…
InsertIntoTableResponse
object
Response from inserting records into a table
1 property
ListTableVersionsResponse
object
2 properties
1 required
BatchCreateTableVersionsRequest
object
Request to atomically create new version entries for multiple tables. The operation is atomic: all versions are created or none are.
3 properties
1 required
CreateTableVersionRequest
object
Request to create a new table version entry. This supports putifnotexists semantics, where the operation fails if the version already exists.
9 properties
2 required
AlterTableAddColumnsResponse
object
1 property
1 required
TableBasicStats
object
2 properties
2 required
PageLimit
integer
An inclusive upper bound of the number of results that a caller will receive.
CreateTableVersionEntry
object
An entry for creating a new table version in a batch operation. This supports putifnotexists semantics, where the operation fails if the version already exists.
7 properties
3 required
GetTableTagVersionResponse
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs LanceDB publishes across the network.
