com.lancedb.lance

Class Dataset.Branches

java.lang.Object

com.lancedb.lance.Dataset.Branches

Enclosing class:

Dataset

public class Dataset.Branches
extends Object

Branch operations of the dataset.

Constructor Summary

Constructors

Constructor and Description
Branches()

Method Summary

Modifier and Type	Method and Description
Dataset	create(String branch, long versionNumber) Create a branch at a specified version.
Dataset	create(String branchName, long versionNumber, String sourceBranch) Create a branch from a specific source branch and version.
Dataset	create(String branchName, String sourceTag) Create a branch from a tag reference.
void	delete(String branchName) Delete a branch and its metadata.
List<Branch>	list() List all branches in this dataset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Branches

public Branches()

Method Detail

create

public Dataset create(String branch,
                      long versionNumber)

Create a branch at a specified version. The returned Dataset points to the created branch's initial version.

Parameters:

branch - the branch name to create

versionNumber - the version number to create branch from

Returns:

a new Dataset of the branch

create

public Dataset create(String branchName,
                      long versionNumber,
                      String sourceBranch)

Create a branch from a specific source branch and version.

Parameters:

branchName - the branch name to create

versionNumber - the version number to create branch from

sourceBranch - the source branch name

Returns:

a new Dataset of the created branch

create

public Dataset create(String branchName,
                      String sourceTag)

Create a branch from a tag reference.

Parameters:

branchName - the branch name to create

sourceTag - the tag name to create branch from

Returns:

a new Dataset of the created branch

delete

public void delete(String branchName)

Delete a branch and its metadata.

Parameters:

branchName - the branch to delete

list

public List<Branch> list()

List all branches in this dataset.

Returns:

a list of Branch objects