api

Documentation

Index

• func GetIndexRules(ctx context.Context, api Interface) ([]index.Rule, error)
• func GetPools(ctx context.Context, api Interface) ([]*pools.Config, error)
• func IsLakeService(u string) bool
• func LookupBranchByID(ctx context.Context, api Interface, id ksuid.KSUID) (*lake.BranchMeta, error)
• func LookupBranchByName(ctx context.Context, api Interface, poolName, branchName string) (*lake.BranchMeta, error)
• func LookupPoolByID(ctx context.Context, api Interface, id ksuid.KSUID) (*pools.Config, error)
• func LookupPoolByName(ctx context.Context, api Interface, name string) (*pools.Config, error)
• func ScanIndexRules(ctx context.Context, api Interface) (zio.ReadCloser, error)
• type Interface
  • func CreateLocalLake(ctx context.Context, logger *zap.Logger, lakePath string) (Interface, error)
  • func FromRoot(root *lake.Root) Interface
  • func NewRemoteLake(conn *client.Connection) Interface
  • func OpenLake(ctx context.Context, logger *zap.Logger, u string) (Interface, error)
  • func OpenLocalLake(ctx context.Context, logger *zap.Logger, lakePath string) (Interface, error)

Functions

func GetIndexRules

func GetIndexRules(ctx context.Context, api Interface) ([]index.Rule, error)

func GetPools

func GetPools(ctx context.Context, api Interface) ([]*pools.Config, error)

func IsLakeService

func IsLakeService(u string) bool

func LookupBranchByID

func LookupBranchByID(ctx context.Context, api Interface, id ksuid.KSUID) (*lake.BranchMeta, error)

func LookupBranchByName

func LookupBranchByName(ctx context.Context, api Interface, poolName, branchName string) (*lake.BranchMeta, error)

func LookupPoolByID

func LookupPoolByID(ctx context.Context, api Interface, id ksuid.KSUID) (*pools.Config, error)

func LookupPoolByName

func LookupPoolByName(ctx context.Context, api Interface, name string) (*pools.Config, error)

func ScanIndexRules

func ScanIndexRules(ctx context.Context, api Interface) (zio.ReadCloser, error)

Types

type Interface

type Interface interface {
	Root() *lake.Root
	Query(ctx context.Context, head *lakeparse.Commitish, src string, srcfiles ...string) (zio.ReadCloser, error)
	QueryWithControl(ctx context.Context, head *lakeparse.Commitish, src string, srcfiles ...string) (zbuf.ProgressReadCloser, error)
	PoolID(ctx context.Context, poolName string) (ksuid.KSUID, error)
	CommitObject(ctx context.Context, poolID ksuid.KSUID, branchName string) (ksuid.KSUID, error)
	CreatePool(context.Context, string, order.SortKey, int, int64) (ksuid.KSUID, error)
	RemovePool(context.Context, ksuid.KSUID) error
	RenamePool(context.Context, ksuid.KSUID, string) error
	CreateBranch(ctx context.Context, pool ksuid.KSUID, name string, parent ksuid.KSUID) error
	RemoveBranch(ctx context.Context, pool ksuid.KSUID, branchName string) error
	MergeBranch(ctx context.Context, pool ksuid.KSUID, childBranch, parentBranch string, message api.CommitMessage) (ksuid.KSUID, error)
	Compact(ctx context.Context, pool ksuid.KSUID, branch string, objects []ksuid.KSUID, message api.CommitMessage) (ksuid.KSUID, error)
	Load(ctx context.Context, zctx *zed.Context, pool ksuid.KSUID, branch string, r zio.Reader, message api.CommitMessage) (ksuid.KSUID, error)
	Delete(ctx context.Context, poolID ksuid.KSUID, branchName string, tags []ksuid.KSUID, message api.CommitMessage) (ksuid.KSUID, error)
	DeleteWhere(ctx context.Context, poolID ksuid.KSUID, branchName, src string, commit api.CommitMessage) (ksuid.KSUID, error)
	Revert(ctx context.Context, poolID ksuid.KSUID, branch string, commitID ksuid.KSUID, commit api.CommitMessage) (ksuid.KSUID, error)
	AddIndexRules(context.Context, []index.Rule) error
	DeleteIndexRules(context.Context, []ksuid.KSUID) ([]index.Rule, error)
	ApplyIndexRules(ctx context.Context, rules []string, pool ksuid.KSUID, branchName string, ids []ksuid.KSUID) (ksuid.KSUID, error)
	UpdateIndex(ctx context.Context, names []string, pool ksuid.KSUID, branchName string) (ksuid.KSUID, error)
	AddVectors(ctx context.Context, pool, revision string, objects []ksuid.KSUID, message api.CommitMessage) (ksuid.KSUID, error)
	DeleteVectors(ctx context.Context, pool, revision string, objects []ksuid.KSUID, message api.CommitMessage) (ksuid.KSUID, error)
	Vacuum(ctx context.Context, pool, revision string, dryrun bool) ([]ksuid.KSUID, error)
}

func CreateLocalLake

func CreateLocalLake(ctx context.Context, logger *zap.Logger, lakePath string) (Interface, error)

func FromRoot

func FromRoot(root *lake.Root) Interface

func NewRemoteLake

func NewRemoteLake(conn *client.Connection) Interface

func OpenLake

func OpenLake(ctx context.Context, logger *zap.Logger, u string) (Interface, error)

func OpenLocalLake

func OpenLocalLake(ctx context.Context, logger *zap.Logger, lakePath string) (Interface, error)