From 6f5e22e764283262ae8c6519bb030766db0fd35b Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 6 Apr 2025 09:58:02 +0800 Subject: Add more documentation comments --- forged/internal/database/database.go | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'forged/internal/database/database.go') 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 -- cgit v1.2.3