Create a new branch

curl --request POST \ --url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/branches/create \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "<string>", "identity": { "api_key": "<string>", "auth_token": "<string>" }, "context": {}, "id": [ "<string>" ], "from_branch": "<string>", "from_version": 1 } '

Authorizations

Authorization

string

header

required

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

Path Parameters

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.

Body

application/json

name

string

required

Name of the branch to create

identity

object

Identity information of a request.

Show child attributes

context

object

Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

Show child attributes

string[]

from_branch

string

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

from_version

integer<int64>

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

Required range: x >= 0

Response

Create branch response

Response for create branch operation

transaction_id

string

Optional transaction identifier