API Reference
- SDKs
- Overview
- GETList all tables
- POSTRegister a table to a namespace
- POSTDescribe information of a table
- POSTCheck if a table exists
- POSTDrop a table
- POSTDeregister a table
- POSTRestore table to a specific version
- POSTRename a table
- POSTUpdate table schema metadata
- POSTList all versions of a table
- POSTCreate a new table version
- POSTDescribe a specific table version
- POSTDelete table version records
- POSTAtomically create versions for multiple tables
- POSTAtomically commit a batch of mixed table operations
- POSTModify existing columns
- POSTRemove columns from table
- POSTGet table statistics
- POSTInsert records into a table
- POSTMerge insert (upsert) records into a table
- POSTUpdate rows in a table
- POSTDelete rows from a table
- POSTQuery a table
- POSTCount rows in a table
- POSTCreate a table with the given name
- POSTGet query execution plan explanation
- POSTAnalyze query execution plan
- POSTAdd new columns to table schema
- POSTCreate an index on a table
- POSTCreate a scalar index on a table
- POSTList indexes on a table
- POSTGet table index statistics
- POSTDrop a specific index
- POSTList all tags for a table
- POSTGet version for a specific tag
- POSTDeclare a table
- POSTCreate a new tag
- POSTDelete a tag
- POSTUpdate a tag to point to a different version
A valid request URL is required to generate request examples{
"transaction_id": "<string>"
}Insert records into a table
Insert new records into table id.
For tables that have been declared but not yet created on storage (is_only_declared=true), this operation will create the table with the provided data.
REST NAMESPACE ONLY
REST namespace uses Arrow IPC stream as the request body.
It passes in the InsertIntoTableRequest information in the following way:
id: pass through path parameter of the same namemode: pass through query parameter of the same name
curl --request POST \
--url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/insert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.apache.arrow.stream' \
--data '"<string>"'{
"transaction_id": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.lancedb.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
string identifier of an object in a namespace, following the Lance Namespace spec.
When the value is equal to the delimiter, it represents the root namespace.
For example, v1/namespace/$/list performs a ListNamespace on the root namespace.
Query Parameters
An optional delimiter of the string identifier, following the Lance Namespace spec.
When not specified, the $ delimiter must be used.
How the insert should behave. Case insensitive, supports both PascalCase and snake_case. Valid values are:
- Append (default): insert data to the existing table
- Overwrite: remove all data in the table and then insert data to it
Body
Arrow IPC stream containing the records to insert
The body is of type file.
Response
Result of inserting records into a table
Response from inserting records into a table
Optional transaction identifier
Was this page helpful?