Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check if Postgres database exists prior to creation #49746

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions lib/backend/pgbk/common/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,51 @@ func ConnectPostgres(ctx context.Context, poolConfig *pgxpool.Config) (*pgx.Conn
return conn, nil
}

// Performs a best-effort check to see if the specified database exists. It will return 'true' if the
// database is guaranteed to exist, false otherwise. An error will only be returned if it is known to
// not stem from the database not existing.
func CheckIfDatabaseExists(ctx context.Context, poolConfig *pgxpool.Config, log *slog.Logger) (bool, error) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would unexport this until such a time that it needs to be used in other packages.

if poolConfig.BeforeConnect != nil {
if err := poolConfig.BeforeConnect(ctx, poolConfig.ConnConfig); err != nil {
return false, trace.Wrap(err)
}
}

conn, err := pgx.ConnectConfig(ctx, poolConfig.ConnConfig)
if err != nil {
errMsg := fmt.Sprintf("Failed to verify that the %q database already exists",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here and below - use structured log fields instead of sprintf.

poolConfig.ConnConfig.Database)
log.DebugContext(ctx, errMsg, "error", err)
return false, nil
}

if poolConfig.AfterConnect != nil {
if err := poolConfig.AfterConnect(ctx, conn); err != nil {
conn.Close(ctx)
return false, trace.Wrap(err)
}
}

// If the connection succeeds, then the database must exist. If the database does not exist,
// the connection attempt will fail with a `pgconn.ConnectError`, which makes authentication
// problems and missing database problems indistinguishable.
return true, nil
}

// TryEnsureDatabase will connect to the "postgres" database and attempt to
// create the database named in the pool's configuration.
func TryEnsureDatabase(ctx context.Context, poolConfig *pgxpool.Config, log *slog.Logger) {
doesDatabaseExist, err := CheckIfDatabaseExists(ctx, poolConfig, log)
if err != nil {
errMsg := fmt.Sprintf("An error occurred while checking if the %q database already exists",
poolConfig.ConnConfig.Database)
log.WarnContext(ctx, errMsg, "error", err)
return
}
if doesDatabaseExist {
return
}

pgConn, err := ConnectPostgres(ctx, poolConfig)
if err != nil {
log.WarnContext(ctx, "Failed to connect to the \"postgres\" database.", "error", err)
Expand Down
Loading