You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-2Lines changed: 21 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,15 @@ The toolkit component is a related set of packages that implement PostgreSQL fun
12
12
and type mapping between PostgreSQL and Go. These underlying packages can be used to implement alternative drivers,
13
13
proxies, load balancers, logical replication clients, etc.
14
14
15
-
## Example Usage
15
+
## Quick Start
16
+
17
+
### Installation
18
+
19
+
```bash
20
+
go get github.com/jackc/pgx/v5
21
+
```
22
+
23
+
### Example Usage
16
24
17
25
```go
18
26
package main
@@ -46,7 +54,18 @@ func main() {
46
54
}
47
55
```
48
56
49
-
See the [getting started guide](https://github.com/jackc/pgx/wiki/Getting-started-with-pgx) for more information.
57
+
### Connection Configuration
58
+
59
+
`pgx.Connect` and `pgxpool.New` accept PostgreSQL connection URLs (such as `postgres://user:pass@host:5432/db?sslmode=verify-full`) as well as `key=value` strings. See [`pgconn.ParseConfig`](https://pkg.go.dev/github.com/jackc/pgx/v5/pgconn#ParseConfig) and the [PostgreSQL connection string documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) for supported options and environment variables.
60
+
61
+
For a step-by-step walkthrough, see the [getting started guide](https://github.com/jackc/pgx/wiki/Getting-started-with-pgx).
62
+
63
+
## Documentation
64
+
65
+
Package documentation and API reference are available on [pkg.go.dev](https://pkg.go.dev/github.com/jackc/pgx/v5):
66
+
*[`pgx`](https://pkg.go.dev/github.com/jackc/pgx/v5) — base PostgreSQL driver
67
+
*[`pgxpool`](https://pkg.go.dev/github.com/jackc/pgx/v5/pgxpool) — concurrency-safe connection pool
0 commit comments