db

package

v1.1.3 Latest Latest Go to latest Published: Sep 23, 2022 License: Unlicense Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package db implements a Postgres client for applying, querying, and recording migrations.

This section is empty.

This section is empty.

This section is empty.

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

Client is a migration database connection.

func ClientFromPool(ctx context.Context, pool *pgxpool.Pool) (*Client, error)

func Connect(ctx context.Context, uri string) (*Client, error)

Connect connects to the Postgres database at the given uri.

func (c *Client) Close() error

Close closes the underlying database connection.

func (c *Client) Exec(ctx context.Context, sql string) error

Exec executes the given statements against the database, and then records that the migration has been applied.

func (c *Client) GetMigrations(ctx context.Context) ([]Migration, error)

GetMigrations returns all migrations that have been applied to the database.

func (c *Client) LogCompletedMigration(ctx context.Context, name string) error

LogCompletedMigration saves migration into the migration table.

func (c *Client) TryLock(ctx context.Context) (bool, error)

TryLock attempts to acquire an exclusive lock for running migrations on this database.

func (c *Client) Unlock(ctx context.Context) (bool, error)

Unlock unlocks the exclusive migration lock. If the provided context is cancelled this might leave the lock behind.

type Migration struct {
	Name string
}

Migration is a migration that's been applied to the database.