psql

Documentation

Index

• Constants
• type Config
• type Driver
  • func New(cfg Config) *Driver
  • func (d *Driver) Close(_ context.Context) error
  • func (d *Driver) Connect(_ context.Context) error
  • func (d *Driver) GetDB() *sqlx.DB
  • func (d *Driver) Migrate(ctx context.Context, migrationsPath string) error
  • func (d *Driver) RevertMigrations(ctx context.Context, migrationsPath string) error

Constants

const (
	// ErrDriverInit is returned when we cannot initialize the driver.
	ErrDriverInit = errors.Error("failed to initialize db driver")
	// ErrMigrateInit is returned when we cannot initialize migration driver.
	ErrMigrateInit = errors.Error("failed to initialize migration driver")
	// ErrMigration is returned when we cannot run a migration.
	ErrMigration = errors.Error("failed to migrate database")
)

const (
	// ErrConnect is returned when we cannot connect to the database.
	ErrConnect = errors.Error("failed to connect to db")
	// ErrClose is returned when we cannot close the database.
	ErrClose = errors.Error("failed to close db connection")
)

Types

type Config

type Config struct {
	DSN string `env:"DSN" validate:"required"`
}

Config represents the configuration for our database.

type Driver

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

Driver provides an implementation for connecting to a database.

func New

func New(cfg Config) *Driver

New instantiates an instance of the Driver.

func (*Driver) Close

func (d *Driver) Close(_ context.Context) error

Close closes the database connection.

func (*Driver) Connect

func (d *Driver) Connect(_ context.Context) error

Connect connects to the database.

func (*Driver) GetDB

func (d *Driver) GetDB() *sqlx.DB

GetDB returns the underlying database connection.

func (*Driver) Migrate

func (d *Driver) Migrate(ctx context.Context, migrationsPath string) error

Migrate migrates the database to the latest version.

func (*Driver) RevertMigrations

func (d *Driver) RevertMigrations(ctx context.Context, migrationsPath string) error

RevertMigrations reverts the database to the previous version.