database

package

v1.5.3 Latest Latest Go to latest Published: Oct 14, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Details

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

Repository

github.com/stacklok/toolhive-registry-server

Links

Open Source Insights

Documentation ¶

Overview ¶

Package database provides functions to migrate the database.

Index ¶

Constants
func GetMigrate(connString string) (*migrate.Migrate, error)
func GetPrimeTemplate() ([]byte, error)
func GetVersion(connString string) (uint, bool, error)
func MigrateDown(_ context.Context, db *pgx.Conn, steps int) error
func MigrateUp(_ context.Context, db *pgx.Conn) error
func RegisterEnumArrayCodecs(ctx context.Context, conn *pgx.Conn) error
func SetupTestDB(t *testing.T) (*pgx.Conn, func())
func SetupTestDBContainer(t *testing.T, ctx context.Context) (*pgx.Conn, func())

Constants ¶

View Source

const (
	// DBName is the name of the test database.
	DBName = "testdb"
	// DBUser is the username for the root user of the test database.
	DBUser = "testuser"
	// DBPass is the password for the root user of the test database.
	DBPass = "testpass"
)

Variables ¶

This section is empty.

Functions ¶

func GetMigrate ¶

func GetMigrate(connString string) (*migrate.Migrate, error)

GetMigrate creates a new migrate instance using the embedded migrations

func GetPrimeTemplate ¶ added in v0.3.0

func GetPrimeTemplate() ([]byte, error)

GetPrimeTemplate returns the contents of the prime.sql.tmpl template file

func GetVersion ¶

func GetVersion(connString string) (uint, bool, error)

GetVersion returns the current migration version

func MigrateUp ¶

func MigrateUp(_ context.Context, db *pgx.Conn) error

MigrateUp executes all pending database migrations

func RegisterEnumArrayCodecs ¶ added in v1.4.6

func RegisterEnumArrayCodecs(ctx context.Context, conn *pgx.Conn) error

RegisterEnumArrayCodecs registers pgx array codecs for the schema's custom enum types. It is the AfterConnect hook used by both the production connection pool and the test database setup, so both encode enum-array parameters identically.

The codecs are resolved from the live database — the enum OIDs are assigned at migration time — so this must run after migrations, on a connection that can read pg_type.

func SetupTestDB ¶

func SetupTestDB(t *testing.T) (*pgx.Conn, func())

SetupTestDB returns an isolated, migrated database on a package-shared Postgres process.

func SetupTestDBContainer ¶ added in v0.3.0

func SetupTestDBContainer(t *testing.T, ctx context.Context) (*pgx.Conn, func())

SetupTestDBContainer starts a dedicated embedded Postgres process and returns a connection to the database. The name is retained for compatibility with existing tests.

Types ¶