LAlance-format
Table
Data

Insert records into a table

Changed on

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

Request

  • Base URL
    http://localhost:2333
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /oauth/token
    • or HTTP bearer
    • or API key in header x-api-key

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.

branchstring

Optional branch to target. When not specified, the main branch is used. Used by branch-scoped operations that cannot carry a branch field in their request body (Arrow IPC stream and bodyless operations). Operations with a JSON request body carry branch as a body field instead.

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

Request body application/vnd.apache.arrow.stream

string binary required

Response

Result of inserting records into a table

contextunknown
transaction_idstring

Optional transaction identifier

num_inserted_rowsinteger

Number of rows inserted

versioninteger

The commit version associated with the operation

Example response

{
  "transaction_id": "transaction_id",
  "num_inserted_rows": 0,
  "context": {
    "key": "context"
  },
  "version": 0
}

Changes

  • f09656f7f568Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 591cd95574b0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status