postgres

package

v1.0.0 Latest Latest Go to latest Published: Jul 6, 2022 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jeamon/sample-rest-api

Links

Open Source Insights

Documentation ¶

Index ¶

func Connect(c *Config) (*pgxpool.Pool, *sql.DB, error)
func Migrate(db *sql.DB, path, action string) error
type Config
type Handler
- func (h *Handler) Shutdown(ctx context.Context) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Connect ¶

func Connect(c *Config) (*pgxpool.Pool, *sql.DB, error)

func Migrate ¶

func Migrate(db *sql.DB, path, action string) error

Types ¶

type Config ¶

type Config struct {
	Host          string
	Port          string
	User          string
	Password      string
	Database      string
	MigrationPath string
}

Config holds all values used to configure and connect to a postgres db.

func (*Config) Check ¶

func (c *Config) Check() func(ctx context.Context) error

Check allows to probe the liveness of postgres database.

func (*Config) ConnectAndMigrate ¶

func (c *Config) ConnectAndMigrate(logger *zap.Logger) (*Handler, error)

ConnectAndMigrate establishes a connection to the database based on the configuration provided. Additionally it performs a data migration to ensure that the schema is on the latest version.

func (*Config) ToDSN ¶

func (c *Config) ToDSN() string

type Handler ¶

type Handler struct {
	StdDB *sql.DB
	PGx   *pgxpool.Pool
}

Handler holds two connections to the database. sqlx connection and original pgx connection. PGx is primarily used for PostgreSQL and StdDB for migration and integration testing.

func (*Handler) Shutdown ¶

func (h *Handler) Shutdown(ctx context.Context) error

Shutdown closes all connections.

Source Files ¶

View all Source files

handler.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL