POST
/
v1
/
table
/
{name}
/
merge_insert
/
curl --request POST \
  --url https://{db}.{region}.api.lancedb.com/v1/table/{name}/merge_insert/ \
  --header 'Content-Type: application/vnd.apache.arrow.stream' \
  --header 'x-api-key: <api-key>'
This response does not have an example.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
name
string
required

name of the table

Query Parameters

​
on
string
required

The column to match on.

Example:

"id"

​
when_matched_update_all
boolean
required

If true, update all columns when a match is found with the new values.

​
when_matched_update_all_filt
string | null

An additional filter to apply when updating all columns.

Example:

"category = 'shoes'"

​
when_not_matched_insert_all
boolean
required

If true, insert all columns when no match is found.

​
when_not_matched_by_source_delete
boolean
required

If true, delete rows in the target table when there is no match in the source table.

​
when_not_matched_by_source_delete_filt
string | null

An additional filter to apply when deleting rows in the target table.

Example:

"category = 'shoes'"

Body

application/vnd.apache.arrow.stream · file

Arrow IPC stream buffer

The body is of type file.

Response

200

Merge-insert successful

POST
/
v1
/
table
/
{name}
/
merge_insert
/
curl --request POST \
  --url https://{db}.{region}.api.lancedb.com/v1/table/{name}/merge_insert/ \
  --header 'Content-Type: application/vnd.apache.arrow.stream' \
  --header 'x-api-key: <api-key>'
This response does not have an example.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
name
string
required

name of the table

Query Parameters

​
on
string
required

The column to match on.

Example:

"id"

​
when_matched_update_all
boolean
required

If true, update all columns when a match is found with the new values.

​
when_matched_update_all_filt
string | null

An additional filter to apply when updating all columns.

Example:

"category = 'shoes'"

​
when_not_matched_insert_all
boolean
required

If true, insert all columns when no match is found.

​
when_not_matched_by_source_delete
boolean
required

If true, delete rows in the target table when there is no match in the source table.

​
when_not_matched_by_source_delete_filt
string | null

An additional filter to apply when deleting rows in the target table.

Example:

"category = 'shoes'"

Body

application/vnd.apache.arrow.stream · file

Arrow IPC stream buffer

The body is of type file.

Response

200

Merge-insert successful