diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-01-06 11:30:47 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-01-06 11:30:47 -0500 |
| commit | 89148cfc25722ac6fb6ef609449566039c31285a (patch) | |
| tree | d129c2d878c2925abcae37ea69d4a788d0dc865b /internal/storage/storage.go | |
| parent | Rename job (diff) | |
| download | cli-89148cfc25722ac6fb6ef609449566039c31285a.zip | |
Tweak a few comments
Diffstat (limited to 'internal/storage/storage.go')
| -rw-r--r-- | internal/storage/storage.go | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/internal/storage/storage.go b/internal/storage/storage.go index cd6e514..25db283 100644 --- a/internal/storage/storage.go +++ b/internal/storage/storage.go @@ -8,8 +8,10 @@ import ( _ "github.com/lib/pq" ) -// DBConnect to the database using the driver and connection -// information. +// DBConnect establishes a connection to the database using the driver +// and connection information. +// +// Note that only "postgres" is supported as the driver right now. func DBConnect(driver string, connectionInfo string) (*sql.DB, error) { db, err := sql.Open(driver, connectionInfo) if err != nil { @@ -29,9 +31,8 @@ func DBConnect(driver string, connectionInfo string) (*sql.DB, error) { } // DBConnectionString generates a properly formatted connection -// string to be passed to a database management system to initiate -// a connection. It uses the passed in configuration values to create -// the string. Note that sslmode is always disabled. +// string that can be used to establish a database connection. +// Note that it always creates a connection string with sslmode disabled. func DBConnectionString(cfg *configloader.ConnectionConfig) string { return fmt.Sprintf( "host=%s port=%d user=%s password=%s dbname=%s sslmode=disable", |