gcs

Documentation

Index

• func NewFromCmdlineOptions() plugin.Plugin
• type BlobStoreGCS
  • func New(dataDir string, logger *slog.Logger, promRegistry prometheus.Registerer) (*BlobStoreGCS, error)
  • func NewWithOptions(opts ...BlobStoreGCSOptionFunc) (*BlobStoreGCS, error)
  • func (d *BlobStoreGCS) Bucket() *storage.BucketHandle
  • func (d *BlobStoreGCS) Client() *storage.Client
  • func (d *BlobStoreGCS) Close() error
  • func (d *BlobStoreGCS) Delete(txn types.Txn, key []byte) error
  • func (d *BlobStoreGCS) Get(txn types.Txn, key []byte) ([]byte, error)
  • func (b *BlobStoreGCS) GetCommitTimestamp() (int64, error)
  • func (d *BlobStoreGCS) NewIterator(txn types.Txn, opts types.BlobIteratorOptions) types.BlobIterator
  • func (d *BlobStoreGCS) NewTransaction(readWrite bool) types.Txn
  • func (d *BlobStoreGCS) Set(txn types.Txn, key, val []byte) error
  • func (b *BlobStoreGCS) SetCommitTimestamp(timestamp int64, txn types.Txn) error
  • func (d *BlobStoreGCS) Start() error
  • func (d *BlobStoreGCS) Stop() error
• type BlobStoreGCSOptionFunc
  • func WithBucket(bucket string) BlobStoreGCSOptionFunc
  • func WithCredentialsFile(credentialsFile string) BlobStoreGCSOptionFunc
  • func WithLogger(logger *slog.Logger) BlobStoreGCSOptionFunc
  • func WithPromRegistry(registry prometheus.Registerer) BlobStoreGCSOptionFunc
• type GcsLogger
  • func NewGcsLogger(logger *slog.Logger) *GcsLogger
  • func (g *GcsLogger) Debugf(msg string, args ...any)
  • func (g *GcsLogger) Errorf(msg string, args ...any)
  • func (g *GcsLogger) Infof(msg string, args ...any)
  • func (g *GcsLogger) Warningf(msg string, args ...any)

Functions

func NewFromCmdlineOptions

func NewFromCmdlineOptions() plugin.Plugin

Types

type BlobStoreGCS

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

BlobStoreGCS stores data in a Google Cloud Storage bucket.

func New

func New(
	dataDir string,
	logger *slog.Logger,
	promRegistry prometheus.Registerer,
) (*BlobStoreGCS, error)

New creates a new GCS-backed blob store.

func NewWithOptions

func NewWithOptions(opts ...BlobStoreGCSOptionFunc) (*BlobStoreGCS, error)

NewWithOptions creates a new GCS-backed blob store using options.

func (*BlobStoreGCS) Bucket

func (d *BlobStoreGCS) Bucket() *storage.BucketHandle

Returns the bucket handle.

func (*BlobStoreGCS) Client

func (d *BlobStoreGCS) Client() *storage.Client

Returns the GCS client.

func (*BlobStoreGCS) Close

func (d *BlobStoreGCS) Close() error

Close closes the GCS client.

func (*BlobStoreGCS) Delete

func (d *BlobStoreGCS) Delete(txn types.Txn, key []byte) error

Delete removes a key from GCS within a transaction

func (*BlobStoreGCS) Get

func (d *BlobStoreGCS) Get(txn types.Txn, key []byte) ([]byte, error)

Get retrieves a value from GCS within a transaction

func (*BlobStoreGCS) GetCommitTimestamp

func (b *BlobStoreGCS) GetCommitTimestamp() (int64, error)

func (*BlobStoreGCS) NewIterator

func (d *BlobStoreGCS) NewIterator(
	txn types.Txn,
	opts types.BlobIteratorOptions,
) types.BlobIterator

NewIterator creates an iterator for GCS within a transaction.

Important: items returned by the iterator's `Item()` must only be accessed while the transaction used to create the iterator is still active. Implementations may validate transaction state at access time (for example `ValueCopy` may fail if the transaction has been committed or rolled back). Typical usage iterates and accesses item values within the same transaction scope.

func (*BlobStoreGCS) NewTransaction

func (d *BlobStoreGCS) NewTransaction(readWrite bool) types.Txn

NewTransaction returns a lightweight transaction wrapper.

func (*BlobStoreGCS) Set

func (d *BlobStoreGCS) Set(txn types.Txn, key, val []byte) error

Set stores a key-value pair in GCS within a transaction

func (*BlobStoreGCS) SetCommitTimestamp

func (b *BlobStoreGCS) SetCommitTimestamp(
	timestamp int64,
	txn types.Txn,
) error

func (*BlobStoreGCS) Start

func (d *BlobStoreGCS) Start() error

Start implements the plugin.Plugin interface.

func (*BlobStoreGCS) Stop

func (d *BlobStoreGCS) Stop() error

Stop implements the plugin.Plugin interface.

type BlobStoreGCSOptionFunc

type BlobStoreGCSOptionFunc func(*BlobStoreGCS)

func WithBucket

func WithBucket(bucket string) BlobStoreGCSOptionFunc

WithBucket specifies the GCS bucket name

func WithCredentialsFile

func WithCredentialsFile(credentialsFile string) BlobStoreGCSOptionFunc

WithCredentialsFile specifies the path to the service account credentials file

func WithLogger

func WithLogger(logger *slog.Logger) BlobStoreGCSOptionFunc

WithLogger specifies the logger object to use for logging messages

func WithPromRegistry

func WithPromRegistry(
	registry prometheus.Registerer,
) BlobStoreGCSOptionFunc

WithPromRegistry specifies the prometheus registry to use for metrics

type GcsLogger

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

GcsLogger is a wrapper type to give our logger a consistent interface

func NewGcsLogger

func NewGcsLogger(logger *slog.Logger) *GcsLogger

func (*GcsLogger) Debugf

func (g *GcsLogger) Debugf(msg string, args ...any)

func (*GcsLogger) Errorf

func (g *GcsLogger) Errorf(msg string, args ...any)

func (*GcsLogger) Infof

func (g *GcsLogger) Infof(msg string, args ...any)

func (*GcsLogger) Warningf

func (g *GcsLogger) Warningf(msg string, args ...any)