objinterface

type Collection interface {
	// DropRootObject removes the given root object from the collection.
	DropRootObject(ctx context.Context, identifier id.Id) error
	// GetID returns the identifying ID for the Collection.
	GetID() RootObjectID
	// GetRootObject returns the root object matching the given ID. Returns false if it cannot be found.
	GetRootObject(ctx context.Context, identifier id.Id) (RootObject, bool, error)
	// HasRootObject returns whether a root object exactly matching the given ID was found.
	HasRootObject(ctx context.Context, identifier id.Id) (bool, error)
	// IDToTableName converts the given ID to a table name. The table name will be empty for invalid IDs.
	IDToTableName(identifier id.Id) doltdb.TableName
	// IterAll iterates over all root objects in the Collection.
	IterAll(ctx context.Context, callback func(rootObj RootObject) (stop bool, err error)) error
	// IterIDs iterates over all IDs in the Collection.
	IterIDs(ctx context.Context, callback func(identifier id.Id) (stop bool, err error)) error
	// PutRootObject updates the Collection with the given root object. This may error if the root object already exists.
	PutRootObject(ctx context.Context, rootObj RootObject) error
	// RenameRootObject changes the ID for a root object matching the old ID.
	RenameRootObject(ctx context.Context, oldID id.Id, newID id.Id) error
	// ResolveName finds the closest matching (or exact) ID for the given name. If an exact match is not found, then
	// this may error if the name is ambiguous.
	ResolveName(ctx context.Context, name doltdb.TableName) (doltdb.TableName, id.Id, error)
	// TableNameToID converts the given name to an ID. The ID will be invalid for empty/malformed names.
	TableNameToID(name doltdb.TableName) id.Id

	// HandleMerge handles merging of two objects. It is guaranteed that "ours" and "theirs" will not be nil, however
	// "ancestor" may or may not be nil.
	HandleMerge(ctx context.Context, mro merge.MergeRootObject) (doltdb.RootObject, *merge.MergeStats, error)
	// LoadCollection loads the Collection from the given root.
	LoadCollection(ctx context.Context, root RootValue) (Collection, error)
	// LoadCollectionHash loads the Collection hash from the given root. This does not load the entire collection from
	// the root, and is therefore a bit more performant if only the hash is needed.
	LoadCollectionHash(ctx context.Context, root RootValue) (hash.Hash, error)
	// Serializer returns the serializer associated with this Collection.
	Serializer() RootObjectSerializer
	// UpdateRoot updates the Collection in the given root, returning the updated root.
	UpdateRoot(ctx context.Context, root RootValue) (RootValue, error)
}

type RootObject interface {
	doltdb.RootObject
	// GetID returns the ID associated with this root object.
	GetID() RootObjectID
}

type RootObjectID int64

type RootObjectSerializer struct {
	Bytes        func(*serial.RootValue) []byte
	RootValueAdd func(builder *flatbuffers.Builder, sequences flatbuffers.UOffsetT)
}

type RootValue interface {
	doltdb.RootValue
	// GetStorage returns the storage contained in the root.
	GetStorage(context.Context) storage.RootStorage
	// WithStorage returns an updated RootValue with the given storage.
	WithStorage(context.Context, storage.RootStorage) RootValue
}