Table
Data

Insert records into a table

Insert new records into table id.

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

Path parameters

idstring 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

delimiterstring

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

modestring

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

Response

Result of inserting records into a table

transaction_idstring

Optional transaction identifier

Example response

{
  "transaction_id": "transaction_id"
}

Changes