From f6bbf4bc3b0b3e7be568bc8d702a1bfb632a9131 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Mon, 2 Sep 2019 12:18:30 -0500 Subject: [PATCH] Add package docs for pgxpool --- pgxpool/doc.go | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 pgxpool/doc.go diff --git a/pgxpool/doc.go b/pgxpool/doc.go new file mode 100644 index 00000000..95debeed --- /dev/null +++ b/pgxpool/doc.go @@ -0,0 +1,25 @@ +// Package pgxpool is a connection pool for pgx. +/* +pgxpool implements a nearly identical interface to pgx connections. + +Establishing a Connection + +The primary way of establishing a connection is with `pgxpool.Connect`. + + pool, err := pgxpool.Connect(context.Background(), os.Getenv("DATABASE_URL")) + +The database connection string can be in URL or DSN format. PostgreSQL settings, pgx settings, and pool settings can be +specified here. In addition, a config struct can be created by `ParseConfig` and modified before establishing the +connection with `ConnectConfig`. + + config, err := pgxpool.ParseConfig(os.Getenv("DATABASE_URL")) + if err != nil { + // ... + } + config.AfterConnect = func(ctx context.Context, conn *pgx.Conn) error { + // do something with every new connection + } + + pool, err := pgxpool.ConnectConfig(context.Background(), config) +*/ +package pgxpool