fsrepo

Documentation

Overview

Package fsrepo is a file-system implementation of repo

Index

• func Filepath(rf File) string
• func NewRepo(path string, fsys *muxfs.Mux, book *logbook.Book, cache *dscache.Dscache, ...) (repo.Repo, error)
• type File
• type Refstore
  • func (rs Refstore) DeleteRef(del reporef.DatasetRef) error
  • func (rs Refstore) GetRef(get reporef.DatasetRef) (reporef.DatasetRef, error)
  • func (rs Refstore) PutRef(r reporef.DatasetRef) (err error)
  • func (rs Refstore) RefCount() (int, error)
  • func (rs Refstore) References(offset, limit int) ([]reporef.DatasetRef, error)
• type Repo
  • func (r *Repo) Bus() event.Bus
  • func (r *Repo) Destroy() error
  • func (r *Repo) Done() <-chan struct{}
  • func (r *Repo) DoneErr() error
  • func (r *Repo) Dscache() *dscache.Dscache
  • func (r *Repo) Filesystem() *muxfs.Mux
  • func (r *Repo) Logbook() *logbook.Book
  • func (r *Repo) Path() string
  • func (r *Repo) Profiles() profile.Store
  • func (r *Repo) ResolveRef(ctx context.Context, ref *dsref.Ref) (string, error)
  • func (r *Repo) SetFilesystem(fs *muxfs.Mux)

Functions

func Filepath

func Filepath(rf File) string

Filepath gives the relative filepath to a repofiles in a given repository

func NewRepo

func NewRepo(path string, fsys *muxfs.Mux, book *logbook.Book, cache *dscache.Dscache, pro profile.Store, bus event.Bus) (repo.Repo, error)

NewRepo creates a new file-based repository

Types

type File

type File int

File represents a type file in a qri repository

const (
	// FileUnknown makes the default file value invalid
	FileUnknown File = iota
	// FileLockfile is the on-disk mutex lock
	FileLockfile
	// FileInfo stores information about this repository
	// like version number, size of repo, etc.
	FileInfo
	// FileConfig holds configuration specific to this repo
	FileConfig
	// FileDatasets holds the list of datasets
	FileDatasets
	// FileEventLogs is a log of all queries in order they're run
	FileEventLogs
	// FileJSONRefs is a file for the user's local namespace
	// No longer in use
	FileJSONRefs
	// FileDscache is a flatbuffer file of this repo's dataset cache
	FileDscache
	// FileRefs is a flatbuffer file of this repo's dataset references
	FileRefs
	// FilePeers holds peer repositories
	// Ideally this won't stick around for long
	FilePeers
	// FileAnalytics holds analytics data
	FileAnalytics
	// FileSearchIndex is the path to a search index
	FileSearchIndex
	// FileSelectedRefs is the path to the current ref selection
	FileSelectedRefs
	// FileChangeRequests is a file of change requests
	FileChangeRequests
)

type Refstore

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

Refstore is a file-based implementation of the Refstore interface. It stores names in a json file

func (Refstore) DeleteRef

func (rs Refstore) DeleteRef(del reporef.DatasetRef) error

DeleteRef removes a name from the store

func (Refstore) GetRef

func (rs Refstore) GetRef(get reporef.DatasetRef) (reporef.DatasetRef, error)

GetRef completes a partially-known reference

func (Refstore) PutRef

func (rs Refstore) PutRef(r reporef.DatasetRef) (err error)

PutRef adds a reference to the store

func (Refstore) RefCount

func (rs Refstore) RefCount() (int, error)

RefCount returns the size of the Refstore

func (Refstore) References

func (rs Refstore) References(offset, limit int) ([]reporef.DatasetRef, error)

References gives a set of dataset references from the store

type Repo

type Repo struct {
	repo.Refstore
	// contains filtered or unexported fields
}

Repo is a filesystem-based implementation of the Repo interface

func (*Repo) Bus

func (r *Repo) Bus() event.Bus

Bus accesses the repo's bus

func (*Repo) Destroy

func (r *Repo) Destroy() error

Destroy destroys this repository

func (*Repo) Done

func (r *Repo) Done() <-chan struct{}

Done returns a channel that the repo will send on when the repo is finished closing

func (*Repo) DoneErr

func (r *Repo) DoneErr() error

DoneErr gives an error that occurred during the shutdown process

func (*Repo) Dscache

func (r *Repo) Dscache() *dscache.Dscache

Dscache returns a dscache

func (*Repo) Filesystem

func (r *Repo) Filesystem() *muxfs.Mux

Filesystem returns this repo's Filesystem

func (*Repo) Logbook

func (r *Repo) Logbook() *logbook.Book

Logbook stores operation logs for coordinating state across peers

func (*Repo) Path

func (r *Repo) Path() string

Path returns the path to the root of the repo directory

func (*Repo) Profiles

func (r *Repo) Profiles() profile.Store

Profiles returns this repo's Peers implementation

func (*Repo) ResolveRef

func (r *Repo) ResolveRef(ctx context.Context, ref *dsref.Ref) (string, error)

ResolveRef implements the dsref.RefResolver interface

func (*Repo) SetFilesystem

func (r *Repo) SetFilesystem(fs *muxfs.Mux)

SetFilesystem implements QFSSetter, currently used during lib contstruction