postgres

Documentation

Index

• Constants
• Variables
• func Migrate(ctx context.Context, dbPool *pgxpool.Pool, dbParams params.Database, ...) error
• func RegisterMigrate(name string, f MigrateFunc, tables []string)
• func UnregisterAll()
• type Driver
  • func (d *Driver) Open(ctx context.Context, kvParams kvparams.KV) (kv.Store, error)
• type EntriesIterator
  • func (e *EntriesIterator) Close()
  • func (e *EntriesIterator) Entry() *kv.Entry
  • func (e *EntriesIterator) Err() error
  • func (e *EntriesIterator) Next() bool
• type MigrateFunc
• type Params
• type Store
  • func (s *Store) Close()
  • func (s *Store) Delete(ctx context.Context, partitionKey, key []byte) error
  • func (s *Store) Get(ctx context.Context, partitionKey, key []byte) (*kv.ValueWithPredicate, error)
  • func (s *Store) Scan(ctx context.Context, partitionKey, start []byte) (kv.EntriesIterator, error)
  • func (s *Store) Set(ctx context.Context, partitionKey, key, value []byte) error
  • func (s *Store) SetIf(ctx context.Context, partitionKey, key, value []byte, ...) error

Constants

const (
	DriverName = "postgres"

	DefaultTableName = "kv"

	// DefaultPartitions Changing the below value means repartitioning and probably a migration.
	// Change it only if you really know what you're doing.
	DefaultPartitions = 100

	DefaultMaxOpenConnections    = 25
	DefaultMaxIdleConnections    = 25
	DefaultConnectionMaxLifetime = 5 * time.Minute
	DefaultScanPageSize          = 1000
)

Variables

var (
	ErrAlreadyMigrated          = errors.New("already migrated")
	ErrWrongDriverTypeMigration = errors.New("trying to migrate to non Postgres DB isn't supported")
)

Functions

func Migrate

func Migrate(ctx context.Context, dbPool *pgxpool.Pool, dbParams params.Database, blockParams blockparams.AdapterConfig, postgresParams *kvparams.Postgres) error

Migrate data migration from DB to KV

func RegisterMigrate

func RegisterMigrate(name string, f MigrateFunc, tables []string)

func UnregisterAll

func UnregisterAll()

UnregisterAll remove all loaded migrate callbacks, used for test code.

Types

type Driver

type Driver struct{}

func (*Driver) Open

func (d *Driver) Open(ctx context.Context, kvParams kvparams.KV) (kv.Store, error)

type EntriesIterator

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

func (*EntriesIterator) Close

func (e *EntriesIterator) Close()

func (*EntriesIterator) Entry

func (e *EntriesIterator) Entry() *kv.Entry

func (*EntriesIterator) Err

func (e *EntriesIterator) Err() error

Err return the last scan error or the cursor error

func (*EntriesIterator) Next

func (e *EntriesIterator) Next() bool

Next reads the next key/value.

type MigrateFunc

type MigrateFunc func(ctx context.Context, db *pgxpool.Pool, c blockparams.AdapterConfig, writer io.Writer) error

type Params

type Params struct {
	TableName          string
	SanitizedTableName string
	PartitionsAmount   int
	ScanPageSize       int
	Metrics            bool
}

type Store

type Store struct {
	Pool           *pgxpool.Pool
	Params         *Params
	TableSanitized string
	// contains filtered or unexported fields
}

func (*Store) Close

func (s *Store) Close()

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, partitionKey, key []byte) error

func (*Store) Get

func (s *Store) Get(ctx context.Context, partitionKey, key []byte) (*kv.ValueWithPredicate, error)

func (*Store) Scan

func (s *Store) Scan(ctx context.Context, partitionKey, start []byte) (kv.EntriesIterator, error)

func (*Store) Set

func (s *Store) Set(ctx context.Context, partitionKey, key, value []byte) error

func (*Store) SetIf

func (s *Store) SetIf(ctx context.Context, partitionKey, key, value []byte, valuePredicate kv.Predicate) error