pgsx

Documentation

Index

• Variables
• type Client
  • func NewClient(cfg Config, fs *embed.FS) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Execs(ctx context.Context, queries []string) error
  • func (c *Client) Migrate(cfg Config) (err error)
  • func (c *Client) RunWithinTx(ctx context.Context, f func(tx *sqlx.Tx) error) error
• type Config
  • func (c *Config) ConnURL() *url.URL

Variables

var (
	ErrNilDBClient         = errors.New("db client is nil")
	ErrNilPostgresClient   = errors.New("postgres client is nil")
	ErrDuplicateKey        = errors.New("duplicate key")
	ErrCheckViolation      = errors.New("check constraint violation")
	ErrForeignKeyViolation = errors.New("foreign key violation")
)

Types

type Client

type Client struct {
	DB *sqlx.DB
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg Config, fs *embed.FS) (*Client, error)

NewClient initializes database connection

func (*Client) Close

func (c *Client) Close() error

func (*Client) Execs

func (c *Client) Execs(ctx context.Context, queries []string) error

Execs is used for executing list of db query

func (*Client) Migrate

func (c *Client) Migrate(cfg Config) (err error)

func (*Client) RunWithinTx

func (c *Client) RunWithinTx(ctx context.Context, f func(tx *sqlx.Tx) error) error

type Config

type Config struct {
	Host     string `yaml:"host"`
	Port     int    `yaml:"port"`
	Name     string `yaml:"name"`
	User     string `yaml:"user"`
	Password string `yaml:"password"`
	SSLMode  string `yaml:"sslmode"`
}

func (*Config) ConnURL

func (c *Config) ConnURL() *url.URL

ConnURL returns the connection URL for the Postgres database.