objstorage

package

Go to main page

Versions in this module

v1

v1.1.4

Jan 22, 2025

v1.1.3

Jan 3, 2025

v1.1.2

Aug 13, 2024

v1.1.1

Jun 14, 2024

v1.1.0

Jan 9, 2024

Changes in this version

type CreateOptions

+ SharedCleanupMethod SharedCleanupMethod

type CreatorID

+ func (c CreatorID) IsSet() bool

+ func (c CreatorID) String() string

type NoopReadHandle

+ func (*NoopReadHandle) SetupForCompaction()

+ func (h *NoopReadHandle) ReadAt(ctx context.Context, p []byte, off int64) error

type ObjectMetadata

+ DiskFileNum base.DiskFileNum

+ Remote struct{ ... }

+ func (meta *ObjectMetadata) AssertValid()

+ func (meta *ObjectMetadata) IsExternal() bool

+ func (meta *ObjectMetadata) IsRemote() bool

+ type OpenOptions struct

+ MustExist bool

type Provider

+ AttachRemoteObjects func(objs []RemoteObjectToAttach) ([]ObjectMetadata, error)

+ CreateExternalObjectBacking func(locator remote.Locator, objName string) (RemoteObjectBacking, error)

+ IsNotExistError func(err error) bool

+ IsSharedForeign func(meta ObjectMetadata) bool

+ Metrics func() sharedcache.Metrics

+ RemoteObjectBacking func(meta *ObjectMetadata) (RemoteObjectBackingHandle, error)

type ReadHandle

+ Close func() error

+ ReadAt func(ctx context.Context, p []byte, off int64) error

+ SetupForCompaction func()

type Readable

+ Close func() error

+ ReadAt func(ctx context.Context, p []byte, off int64) error

+ type RemoteObjectBacking []byte

+ type RemoteObjectBackingHandle interface

+ Close func()

+ Get func() (RemoteObjectBacking, error)

+ type RemoteObjectToAttach struct

+ Backing RemoteObjectBacking

+ FileNum base.DiskFileNum

+ FileType base.FileType

+ type SharedCleanupMethod uint8

+ const SharedNoCleanup

+ const SharedRefTracking

v1.0.0

Oct 6, 2023

Changes in this version

+ func IsNotExistError(err error) bool

+ func TestingCheckMaxReadahead(rh ReadHandle) bool

+ type CreateOptions struct

+ PreferSharedStorage bool

+ type CreatorID = sharedobjcat.CreatorID

+ type NoopReadHandle struct

+ func MakeNoopReadHandle(r io.ReaderAt) NoopReadHandle

+ func (*NoopReadHandle) Close() error

+ func (*NoopReadHandle) MaxReadahead()

+ func (*NoopReadHandle) RecordCacheHit(offset, size int64)

+ type ObjectMetadata struct

+ FileNum base.FileNum

+ FileType base.FileType

+ Shared struct{ ... }

+ func (meta *ObjectMetadata) IsShared() bool

+ func (meta *ObjectMetadata) SharedObjectBacking() (SharedObjectBacking, error)

+ type PreallocatedReadHandle struct

+ func (rh *PreallocatedReadHandle) Close() error

+ func (rh *PreallocatedReadHandle) MaxReadahead()

+ func (rh *PreallocatedReadHandle) ReadAt(p []byte, offset int64) (n int, err error)

+ func (rh *PreallocatedReadHandle) RecordCacheHit(offset, size int64)

+ type Provider struct

+ func Open(settings Settings) (p *Provider, _ error)

+ func (p *Provider) AttachSharedObjects(objs []SharedObjectToAttach) ([]ObjectMetadata, error)

+ func (p *Provider) Close() error

+ func (p *Provider) Create(fileType base.FileType, fileNum base.FileNum, opts CreateOptions) (w Writable, meta ObjectMetadata, err error)

+ func (p *Provider) LinkOrCopyFromLocal(srcFS vfs.FS, srcFilePath string, dstFileType base.FileType, ...) (ObjectMetadata, error)

+ func (p *Provider) List() []ObjectMetadata

+ func (p *Provider) Lookup(fileType base.FileType, fileNum base.FileNum) (ObjectMetadata, error)

+ func (p *Provider) OpenForReading(fileType base.FileType, fileNum base.FileNum) (Readable, error)

+ func (p *Provider) OpenForReadingMustExist(fileType base.FileType, fileNum base.FileNum) (Readable, error)

+ func (p *Provider) Path(meta ObjectMetadata) string

+ func (p *Provider) Remove(fileType base.FileType, fileNum base.FileNum) error

+ func (p *Provider) SetCreatorID(creatorID CreatorID) error

+ func (p *Provider) Size(meta ObjectMetadata) (int64, error)

+ func (p *Provider) Sync() error

+ type ReadHandle interface

+ MaxReadahead func()

+ RecordCacheHit func(offset, size int64)

+ func UsePreallocatedReadHandle(readable Readable, rh *PreallocatedReadHandle) ReadHandle

+ type Readable interface

+ NewReadHandle func() ReadHandle

+ Size func() int64

+ type Settings struct

+ BytesPerSync int

+ FS vfs.FS

+ FSCleaner base.Cleaner

+ FSDirInitialListing []string

+ FSDirName string

+ Logger base.Logger

+ NoSyncOnClose bool

+ Shared struct{ ... }

+ func DefaultSettings(fs vfs.FS, dirName string) Settings

+ type SharedObjectBacking []byte

+ type SharedObjectToAttach struct

+ Backing SharedObjectBacking

+ FileNum base.FileNum

+ FileType base.FileType

+ type Writable interface

+ Abort func()

+ Finish func() error

+ Write func(p []byte) error

+ func NewFileWritable(file vfs.File) Writable

Other modules containing this package

github.com/cockroachdb/pebble/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL