repository

Documentation

Index

• type Asset
• type Meta
• type Tag
• type WorkSpace

Types

type Asset

type Asset interface {
	Init(ws model.WSName) error
	Add(ws model.WSName, asset *model.Asset) (model.AssetID, error)
	BatchAdd(ws model.WSName, assets []*model.Asset) ([]model.AssetID, error)
	Close() error
	AddByFilePathIfDoesNotExist(ws model.WSName, filePath string) (id model.AssetID, added bool, err error)
	AddByFilePathListIfDoesNotExist(ws model.WSName, filePathList []string) (idList []model.AssetID, err error)
	Get(ws model.WSName, id model.AssetID) (asset *model.Asset, exist bool, err error)
	GetByPath(ws model.WSName, path string) (asset *model.Asset, exist bool, err error)
	Has(ws model.WSName, id model.AssetID) (ok bool, err error)
	Update(ws model.WSName, asset *model.Asset) error
	BatchUpdateByID(ws model.WSName, assets []*model.Asset) (updatedAssets, skippedAssets []*model.Asset, err error)

	// BatchUpdateByPath update assets by path.
	// Invalid asset will be skip. For example, an asset that contains a bounding box that does not have an ID.
	// If asset which have non exist path is provided, it will be ignored.
	BatchUpdateByPath(ws model.WSName, assets []*model.Asset) (updatedAssets, skippedAssets []*model.Asset, err error)

	Delete(ws model.WSName, id model.AssetID) error
	ListByAsync(ctx context.Context, ws model.WSName, f func(asset *model.Asset) bool, cap int) (assetChan <-chan *model.Asset, err error)
	ListRawByAsync(ctx context.Context, ws model.WSName, f func(v []byte) bool, cap int) (c <-chan []byte, err error)
	List(ws model.WSName) (assets []*model.Asset, err error)
	ListBy(ws model.WSName, f func(asset *model.Asset) bool) (assets []*model.Asset, err error)
	ListByIDList(ws model.WSName, idList []model.AssetID) ([]*model.Asset, error)
	ListByPaths(ws model.WSName, paths []string) ([]*model.Asset, error)
	ListByIDListAsync(ctx context.Context, ws model.WSName, idList []model.AssetID, cap int) (assetChan <-chan *model.Asset, errChan <-chan error, err error)
	ForEach(ws model.WSName, f func(asset *model.Asset) error) error
	Revalidate(ws model.WSName) error
}

type Meta

type Meta interface {
	Init() error
	GetDBVersion() (*semver.Version, bool, error)
	SetDBVersion(version *semver.Version) error
}

type Tag

type Tag interface {
	Init(ws model.WSName) error
	Add(ws model.WSName, tag *model.UnregisteredUnindexedTag) (*model.Tag, error)
	AddWithIndex(ws model.WSName, unregisteredTag *model.UnregisteredTag) (*model.Tag, error)
	AddByName(ws model.WSName, tagName string) (*model.Tag, bool, error)
	AddByNames(ws model.WSName, tagNames []string) ([]*model.Tag, error)

	// Save persists tag and return ID of the tag.
	// If the tag already exists, update it. Otherwise add new tag with new ID.
	Save(ws model.WSName, tagWithIndex *model.Tag) (*model.Tag, error)

	// Delete deletes tag which have given ID
	Delete(ws model.WSName, idList []model.TagID) error
}

type WorkSpace

type WorkSpace interface {
	Init() error
	List() (workspaces []*model.WorkSpace, err error)
	Add(ws *model.WorkSpace) error
	Update(ws *model.WorkSpace) error
}