aboutsummaryrefslogtreecommitdiff
path: root/forged/internal/database/database.go
diff options
context:
space:
mode:
Diffstat (limited to 'forged/internal/database/database.go')
-rw-r--r--forged/internal/database/database.go5
1 files changed, 5 insertions, 0 deletions
diff --git a/forged/internal/database/database.go b/forged/internal/database/database.go
index a482624..b995adc 100644
--- a/forged/internal/database/database.go
+++ b/forged/internal/database/database.go
@@ -10,10 +10,15 @@ import (
"github.com/jackc/pgx/v5/pgxpool"
)
+// Database is a wrapper around pgxpool.Pool to provide a common interface for
+// other packages in the forge.
type Database struct {
*pgxpool.Pool
}
+// Open opens a new database connection pool using the provided connection
+// string. It returns a Database instance and an error if any occurs.
+// It is run indefinitely in the background.
func Open(connString string) (Database, error) {
db, err := pgxpool.New(context.Background(), connString)
return Database{db}, err