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>",
"num_updated_rows": 1,
"num_inserted_rows": 1,
"num_deleted_rows": 1,
"version": 1
}Merge insert (upsert) records into a table
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.
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 (since there are no existing rows to merge with).
REST NAMESPACE ONLY
REST namespace uses Arrow IPC stream as the request body.
It passes in the MergeInsertIntoTableRequest information in the following way:
id: pass through path parameter of the same nameon: pass through query parameter of the same namewhen_matched_update_all: pass through query parameter of the same namewhen_matched_update_all_filt: pass through query parameter of the same namewhen_not_matched_insert_all: pass through query parameter of the same namewhen_not_matched_by_source_delete: pass through query parameter of the same namewhen_not_matched_by_source_delete_filt: pass through query parameter of the same name
curl --request POST \
--url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/merge_insert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.apache.arrow.stream' \
--data '"<string>"'{
"transaction_id": "<string>",
"num_updated_rows": 1,
"num_inserted_rows": 1,
"num_deleted_rows": 1,
"version": 1
}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.
Column name to use for matching rows (required)
Update all columns when rows match
The row is updated (similar to UpdateAll) only for rows where the SQL expression evaluates to true
Insert all columns when rows don't match
Delete all rows from target table that don't match a row in the source table
Delete rows from the target table if there is no match AND the SQL expression evaluates to true
Timeout for the operation (e.g., "30s", "5m")
Whether to use index for matching rows
Body
Arrow IPC stream containing the records to merge
The body is of type file.
Response
Result of merge insert operation
Response from merge insert operation
Optional transaction identifier
Number of rows updated
x >= 0Number of rows inserted
x >= 0Number of rows deleted (typically 0 for merge insert)
x >= 0The commit version associated with the operation
x >= 0Was this page helpful?