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 name
• mode: pass through query parameter of the same name

POST /v1/table/{id}/insert

Insert records into a table

cURL

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>"'

200

{
  "transaction_id": "<string>"
}

Authorizations

OAuth2BearerAuthApiKeyAuth

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

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

delimiter · string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

mode · string · default: append

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

application/vnd.apache.arrow.stream

Arrow IPC stream containing the records to insert

The body is of type file.

Response

200

application/json

Result of inserting records into a table

Response from inserting records into a table

transaction_id · string

Optional transaction identifier