Sign in
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 nullable

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

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

mode'append' | 'overwrite'

How the insert should behave:

  • 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

versioninteger

The version of the table after the insert

Example response

{
  "version": 0
}

Changes