testdb

Documentation

Index

• type TestDB
  • func New(ctx context.Context) (*TestDB, error)
  • func (db *TestDB) Close(ctx context.Context) error
  • func (db *TestDB) ConnectionString() (string, error)
  • func (db *TestDB) Migrate(migrationsPath string) error
  • func (db *TestDB) Open(ctx context.Context) (*pgxpool.Pool, error)

Types

type TestDB

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

func New

func New(ctx context.Context) (*TestDB, error)

New launches a new TestDB. The caller should call Close when finished to shut it down.

func (*TestDB) Close

func (db *TestDB) Close(ctx context.Context) error

Close closes the test DB connection pool and shuts down the test DB instance.

func (*TestDB) ConnectionString

func (db *TestDB) ConnectionString() (string, error)

ConnectionString returns the connection string for connecting to the test database instance

func (*TestDB) Migrate

func (db *TestDB) Migrate(migrationsPath string) error

Migrate runs DB migrations found in the migrationsPath file path

func (*TestDB) Open

func (db *TestDB) Open(ctx context.Context) (*pgxpool.Pool, error)

Open returns a connection pool for the test database instance. If the connection pool is not closed explicitly, it will be closed when the TestDB.Close method is called.