db

Documentation

Index

• Variables
• func InitContext(ctx context.Context, cfg Config) (*sqlx.DB, error)
• func RunMigrationsUp(pg *sqlx.DB) error
• type Config
• type DB
  • func New(pg *sqlx.DB) DB
• type Tx

Variables

var (
	// ErrStateNotSynchronized indicates the state database may be empty
	ErrStateNotSynchronized = errors.New("state not synchronized")
)

Functions

func InitContext

func InitContext(ctx context.Context, cfg Config) (*sqlx.DB, error)

InitContext initializes DB connection by the given config

func RunMigrationsUp

func RunMigrationsUp(pg *sqlx.DB) error

RunMigrationsUp runs migrate-up for the given config.

Types

type Config

type Config struct {
	// Database name
	Name string `mapstructure:"Name"`

	// Database User name
	User string `mapstructure:"User"`

	// Database Password of the user
	Password string `mapstructure:"Password"`

	// Host address of database
	Host string `mapstructure:"Host"`

	// Port Number of database
	Port string `mapstructure:"Port"`

	// EnableLog
	// DEPRECATED
	EnableLog bool `mapstructure:"EnableLog"`

	// MaxConns is the maximum number of connections in the pool.
	MaxConns int `mapstructure:"MaxConns"`
}

Config provide fields to configure the pool

type DB

type DB interface {
	BeginStateTransaction(ctx context.Context) (Tx, error)

	StoreLastProcessedBlock(ctx context.Context, task string, block uint64, dbTx sqlx.ExecerContext) error
	GetLastProcessedBlock(ctx context.Context, task string) (uint64, error)

	StoreUnresolvedBatchKeys(ctx context.Context, bks []types.BatchKey, dbTx sqlx.ExecerContext) error
	GetUnresolvedBatchKeys(ctx context.Context) ([]types.BatchKey, error)
	DeleteUnresolvedBatchKeys(ctx context.Context, bks []types.BatchKey, dbTx sqlx.ExecerContext) error

	Exists(ctx context.Context, key common.Hash) bool
	GetOffChainData(ctx context.Context, key common.Hash, dbTx sqlx.QueryerContext) (types.ArgBytes, error)
	ListOffChainData(ctx context.Context, keys []common.Hash, dbTx sqlx.QueryerContext) (map[common.Hash]types.ArgBytes, error)
	StoreOffChainData(ctx context.Context, od []types.OffChainData, dbTx sqlx.ExecerContext) error
}

DB defines functions that a DB instance should implement

func New

func New(pg *sqlx.DB) DB

New instantiates a DB

type Tx

type Tx interface {
	sqlx.ExecerContext
	sqlx.QueryerContext
	driver.Tx
}

Tx is the interface that defines functions a db tx has to implement