Sign in
Table
Branch
Metadata

Create a new branch

Create a new branch for table id starting from a source ref (another branch and/or version), defaulting to the latest version of the main branch.

post/v1/table/{id}/branches/create

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.

Request body

{"stackTrail":"components:schemas:CreateTableBranchRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context for a request as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nREST NAMESPACE ONLY\nContext entries are passed via HTTP headers using the naming convention\n`x-lance-ctx-<key>: <value>`. For example, a context entry\n`{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.\n"}
idstring[]
namestring required

Name of the branch to create

from_branchstring

Source branch to create the new branch from. When omitted, the new branch is created from the main branch.

from_versioninteger

Version of the source (branch or main) to create from. When omitted, the latest version of the source is used.

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "name": "name",
  "from_branch": "from_branch",
  "id": [
    "id",
    "id"
  ],
  "from_version": 0
}

Response

Create branch response

transaction_idstring

Optional transaction identifier

Example response

{
  "transaction_id": "transaction_id"
}

Changes