Sign in

v1

latestOpenAPI 3.1.1Apache 2.02026-07-2654130166.5 KB
Table
Data

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 name
  • on: pass through query parameter of the same name
  • when_matched_update_all: pass through query parameter of the same name
  • when_matched_update_all_filt: pass through query parameter of the same name
  • when_not_matched_insert_all: pass through query parameter of the same name
  • when_not_matched_by_source_delete: pass through query parameter of the same name
  • when_not_matched_by_source_delete_filt: pass through query parameter of the same name
post/v1/table/{id}/merge_insert

Response

Result of merge insert operation

contextContext

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

  • On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
  • On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.
transaction_idstring

Optional transaction identifier

num_updated_rowsinteger

Number of rows updated

num_inserted_rowsinteger

Number of rows inserted

num_deleted_rowsinteger

Number of rows deleted (typically 0 for merge insert)

versioninteger

The commit version associated with the operation