drive

Documentation

Overview

Package drive provides the definitions for the low-level pfs storage drivers.

Index

• func IsPermissionError(err error) bool
• func MatchProvenance(want []*pfs.Commit, have []*pfs.Commit) bool
• type Driver
  • func NewDriver(blockAddress string) (Driver, error)

Functions

func IsPermissionError

func IsPermissionError(err error) bool

func MatchProvenance

func MatchProvenance(want []*pfs.Commit, have []*pfs.Commit) bool

MatchProvenance checks if all the commits we want exist in the commits we have.

Types

type Driver

type Driver interface {
	CreateRepo(repo *pfs.Repo, created *google_protobuf.Timestamp, provenance []*pfs.Repo, shards map[uint64]bool) error
	InspectRepo(repo *pfs.Repo, shards map[uint64]bool) (*pfs.RepoInfo, error)
	ListRepo(provenance []*pfs.Repo, shards map[uint64]bool) ([]*pfs.RepoInfo, error)
	DeleteRepo(repo *pfs.Repo, shards map[uint64]bool, force bool) error
	StartCommit(repo *pfs.Repo, commitID string, parentID string, branch string, started *google_protobuf.Timestamp, provenance []*pfs.Commit, shards map[uint64]bool) error
	FinishCommit(commit *pfs.Commit, finished *google_protobuf.Timestamp, cancel bool, shards map[uint64]bool) error
	InspectCommit(commit *pfs.Commit, shards map[uint64]bool) (*pfs.CommitInfo, error)
	ListCommit(repo []*pfs.Repo, commitType pfs.CommitType, fromCommit []*pfs.Commit,
		provenance []*pfs.Commit, all bool, shards map[uint64]bool) ([]*pfs.CommitInfo, error)
	ListBranch(repo *pfs.Repo, shards map[uint64]bool) ([]*pfs.CommitInfo, error)
	DeleteCommit(commit *pfs.Commit, shards map[uint64]bool) error
	PutFile(file *pfs.File, handle string, delimiter pfs.Delimiter, shard uint64, reader io.Reader) error
	MakeDirectory(file *pfs.File, shard uint64) error
	GetFile(file *pfs.File, filterShard *pfs.Shard, offset int64,
		size int64, from *pfs.Commit, shard uint64, unsafe bool, handle string) (io.ReadCloser, error)
	InspectFile(file *pfs.File, filterShard *pfs.Shard, from *pfs.Commit, shard uint64, unsafe bool, handle string) (*pfs.FileInfo, error)
	ListFile(file *pfs.File, filterShard *pfs.Shard, from *pfs.Commit, shard uint64, recurse bool, unsafe bool, handle string) ([]*pfs.FileInfo, error)
	DeleteFile(file *pfs.File, shard uint64, unsafe bool, handle string) error
	DeleteAll(shards map[uint64]bool) error
	AddShard(shard uint64) error
	DeleteShard(shard uint64) error
	Dump()
}

Driver represents a low-level pfs storage driver.

func NewDriver

func NewDriver(blockAddress string) (Driver, error)

NewDriver creates a Driver.