diff options
| author | Runxi Yu <me@runxiyu.org> | 2025-04-06 09:58:02 +0800 |
|---|---|---|
| committer | Runxi Yu <me@runxiyu.org> | 2025-04-06 09:58:02 +0800 |
| commit | 6f5e22e764283262ae8c6519bb030766db0fd35b (patch) | |
| tree | c56038bd7b5dc31d5bae5dd6e323688725c5262e /forged/internal/database/database.go | |
| parent | Fix load ordering issue that causes the forge title to disappear (diff) | |
| download | forge-6f5e22e764283262ae8c6519bb030766db0fd35b.tar.gz forge-6f5e22e764283262ae8c6519bb030766db0fd35b.tar.zst forge-6f5e22e764283262ae8c6519bb030766db0fd35b.zip | |
Add more documentation comments
Diffstat (limited to 'forged/internal/database/database.go')
| -rw-r--r-- | forged/internal/database/database.go | 5 |
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 |