dscache

Documentation

Index

• Variables
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) AddDsVersionInfo(ver dsref.VersionInfo)
  • func (b *Builder) AddDsVersionInfoWithIndexes(ver dsref.VersionInfo, topIndex, cursorIndex int)
  • func (b *Builder) AddUser(username, profileID string)
  • func (b *Builder) Build() *Dscache
  • func (b *Builder) SetFilename(filename string)
• type Dscache
  • func BuildDscacheFromLogbookAndProfilesAndDsref(ctx context.Context, refs []reporef.DatasetRef, profiles profile.Store, ...) (*Dscache, error)
  • func NewDscache(ctx context.Context, fsys qfs.Filesystem, bus event.Bus, ...) *Dscache
  • func (d *Dscache) Assign(other *Dscache) error
  • func (d *Dscache) IsEmpty() bool
  • func (d *Dscache) ListRefs() ([]reporef.DatasetRef, error)
  • func (d *Dscache) LookupByName(ref dsref.Ref) (*dsref.VersionInfo, error)
  • func (d *Dscache) ResolveRef(ctx context.Context, ref *dsref.Ref) (string, error)
  • func (d *Dscache) VerboseString(showEmpty bool) string

Variables

var (

	// ErrNoDscache is returned when methods are called on a non-existant Dscache
	ErrNoDscache = fmt.Errorf("dscache: does not exist")
	// ErrInvalidProfileID is returned when an invalid profileID is given to dscache
	ErrInvalidProfileID = fmt.Errorf("invalid profileID")
)

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder can be used to construct a dscache directly

func NewBuilder

func NewBuilder() *Builder

NewBuilder returns a new dscache builder

func (*Builder) AddDsVersionInfo

func (b *Builder) AddDsVersionInfo(ver dsref.VersionInfo)

AddDsVersionInfo adds a versionInfo to the dscache

func (*Builder) AddDsVersionInfoWithIndexes

func (b *Builder) AddDsVersionInfoWithIndexes(ver dsref.VersionInfo, topIndex, cursorIndex int)

AddDsVersionInfoWithIndexes adds a versionInfo with indexes to the dscache

func (*Builder) AddUser

func (b *Builder) AddUser(username, profileID string)

AddUser adds a user to the dscache

func (*Builder) Build

func (b *Builder) Build() *Dscache

Build returns the built Dscache

func (*Builder) SetFilename

func (b *Builder) SetFilename(filename string)

SetFilename sets the filename for the dscache

type Dscache

type Dscache struct {
	Filename            string
	Root                *dscachefb.Dscache
	Buffer              []byte
	CreateNewEnabled    bool
	ProfileIDToUsername map[string]string
	DefaultUsername     string
}

Dscache represents an in-memory serialized dscache flatbuffer

func BuildDscacheFromLogbookAndProfilesAndDsref

func BuildDscacheFromLogbookAndProfilesAndDsref(ctx context.Context, refs []reporef.DatasetRef, profiles profile.Store, book *logbook.Book, filesys qfs.Filesystem) (*Dscache, error)

BuildDscacheFromLogbookAndProfilesAndDsref creates a dscache, building it from logbook and profiles and dsrefs. Deprecated: Dsref is going away once dscache is in use. For now, only FSIPath is retrieved from dsref, but in the future it will be added directly to dscache, with the file systems's linkfiles (.qri-ref) acting as the authoritative source.

func NewDscache

func NewDscache(ctx context.Context, fsys qfs.Filesystem, bus event.Bus, username, filename string) *Dscache

NewDscache will construct a dscache from the given filename, or will construct an empty dscache that will save to the given filename. Using an empty filename will disable loading and saving

func (*Dscache) Assign

func (d *Dscache) Assign(other *Dscache) error

Assign assigns the data from one dscache to this one

func (*Dscache) IsEmpty

func (d *Dscache) IsEmpty() bool

IsEmpty returns whether the dscache has any constructed data in it

func (*Dscache) ListRefs

func (d *Dscache) ListRefs() ([]reporef.DatasetRef, error)

ListRefs returns references to each dataset in the cache

func (*Dscache) LookupByName

func (d *Dscache) LookupByName(ref dsref.Ref) (*dsref.VersionInfo, error)

LookupByName looks up a dataset by dsref and returns the latest VersionInfo if found

func (*Dscache) ResolveRef

func (d *Dscache) ResolveRef(ctx context.Context, ref *dsref.Ref) (string, error)

ResolveRef finds the identifier for a dataset reference implements dsref.Resolver interface

func (*Dscache) VerboseString

func (d *Dscache) VerboseString(showEmpty bool) string

VerboseString is a convenience function that returns a readable string, for testing and debugging