tool

Documentation

Index

• type Comparer
• type FilterPolicy
• type Merger
• type Option
  • func Comparers(cmps ...*Comparer) Option
  • func DefaultComparer(c *Comparer) Option
  • func FS(fs vfs.FS) Option
  • func Filters(filters ...FilterPolicy) Option
  • func Mergers(mergers ...*Merger) Option
  • func OpenErrEnhancer(fn func(error) error) Option
• type T
  • func New(opts ...Option) *T
  • func (t *T) ConfigureSharedStorage(s remote.StorageFactory, createOnShared remote.CreateOnSharedStrategy, ...)

Types

type Comparer

type Comparer = base.Comparer

Comparer exports the base.Comparer type.

type FilterPolicy

type FilterPolicy = base.FilterPolicy

FilterPolicy exports the base.FilterPolicy type.

type Merger

type Merger = base.Merger

Merger exports the base.Merger type.

type Option

type Option func(*T)

A Option configures the Pebble introspection tool.

func Comparers

func Comparers(cmps ...*Comparer) Option

Comparers may be passed to New to register comparers for use by the introspesction tools.

func DefaultComparer

func DefaultComparer(c *Comparer) Option

DefaultComparer registers a comparer for use by the introspection tools and sets it as the default.

func FS

func FS(fs vfs.FS) Option

FS sets the filesystem implementation to use by the introspection tools.

func Filters

func Filters(filters ...FilterPolicy) Option

Filters may be passed to New to register filter policies for use by the introspection tools.

func Mergers

func Mergers(mergers ...*Merger) Option

Mergers may be passed to New to register mergers for use by the introspection tools.

func OpenErrEnhancer

func OpenErrEnhancer(fn func(error) error) Option

OpenErrEnhancer sets a function that enhances an error encountered when the tool opens a database; used to provide the user additional context, for example that a corruption error might be caused by encryption at rest not being configured properly.

type T

type T struct {
	Commands []*cobra.Command
	// contains filtered or unexported fields
}

T is the container for all of the introspection tools.

func New

func New(opts ...Option) *T

New creates a new introspection tool.

func (*T) ConfigureSharedStorage

func (t *T) ConfigureSharedStorage(
	s remote.StorageFactory,
	createOnShared remote.CreateOnSharedStrategy,
	createOnSharedLocator remote.Locator,
)

ConfigureSharedStorage updates the shared storage options.