summaryrefslogtreecommitdiff
path: root/vendor/github.com/jackc/pgx/v5/pgxpool/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/jackc/pgx/v5/pgxpool/doc.go')
-rw-r--r--vendor/github.com/jackc/pgx/v5/pgxpool/doc.go27
1 files changed, 0 insertions, 27 deletions
diff --git a/vendor/github.com/jackc/pgx/v5/pgxpool/doc.go b/vendor/github.com/jackc/pgx/v5/pgxpool/doc.go
deleted file mode 100644
index 099443bca..000000000
--- a/vendor/github.com/jackc/pgx/v5/pgxpool/doc.go
+++ /dev/null
@@ -1,27 +0,0 @@
-// Package pgxpool is a concurrency-safe connection pool for pgx.
-/*
-pgxpool implements a nearly identical interface to pgx connections.
-
-Creating a Pool
-
-The primary way of creating a pool is with [pgxpool.New]:
-
- pool, err := pgxpool.New(context.Background(), os.Getenv("DATABASE_URL"))
-
-The database connection string can be in URL or keyword/value format. PostgreSQL settings, pgx settings, and pool settings can be
-specified here. In addition, a config struct can be created by [ParseConfig].
-
- 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.NewWithConfig(context.Background(), config)
-
-A pool returns without waiting for any connections to be established. Acquire a connection immediately after creating
-the pool to check if a connection can successfully be established.
-*/
-package pgxpool