summaryrefslogtreecommitdiff
path: root/vendor/github.com/jackc/pgconn/README.md
diff options
context:
space:
mode:
authorLibravatar dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>2023-10-23 10:47:11 +0100
committerLibravatar GitHub <noreply@github.com>2023-10-23 10:47:11 +0100
commit3dcc94940de1408663d2258474472983549584c8 (patch)
tree25c642e7e2bcfe3f589ba0c06d36661e5b9e3405 /vendor/github.com/jackc/pgconn/README.md
parent[bugfix/frontend] fix typo and other oddness in patchRemoteEmojis (#2281) (diff)
downloadgotosocial-3dcc94940de1408663d2258474472983549584c8.tar.xz
[chore]: Bump github.com/coreos/go-oidc/v3 from 3.6.0 to 3.7.0 (#2284)
Bumps [github.com/coreos/go-oidc/v3](https://github.com/coreos/go-oidc) from 3.6.0 to 3.7.0. - [Release notes](https://github.com/coreos/go-oidc/releases) - [Commits](https://github.com/coreos/go-oidc/compare/v3.6.0...v3.7.0) --- updated-dependencies: - dependency-name: github.com/coreos/go-oidc/v3 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Diffstat (limited to 'vendor/github.com/jackc/pgconn/README.md')
-rw-r--r--vendor/github.com/jackc/pgconn/README.md62
1 files changed, 0 insertions, 62 deletions
diff --git a/vendor/github.com/jackc/pgconn/README.md b/vendor/github.com/jackc/pgconn/README.md
deleted file mode 100644
index 9af04fe74..000000000
--- a/vendor/github.com/jackc/pgconn/README.md
+++ /dev/null
@@ -1,62 +0,0 @@
-[![](https://godoc.org/github.com/jackc/pgconn?status.svg)](https://godoc.org/github.com/jackc/pgconn)
-![CI](https://github.com/jackc/pgconn/workflows/CI/badge.svg)
-
----
-
-This version is used with pgx `v4`. In pgx `v5` it is part of the https://github.com/jackc/pgx repository.
-
----
-
-# pgconn
-
-Package pgconn is a low-level PostgreSQL database driver. It operates at nearly the same level as the C library libpq.
-It is primarily intended to serve as the foundation for higher level libraries such as https://github.com/jackc/pgx.
-Applications should handle normal queries with a higher level library and only use pgconn directly when required for
-low-level access to PostgreSQL functionality.
-
-## Example Usage
-
-```go
-pgConn, err := pgconn.Connect(context.Background(), os.Getenv("DATABASE_URL"))
-if err != nil {
- log.Fatalln("pgconn failed to connect:", err)
-}
-defer pgConn.Close(context.Background())
-
-result := pgConn.ExecParams(context.Background(), "SELECT email FROM users WHERE id=$1", [][]byte{[]byte("123")}, nil, nil, nil)
-for result.NextRow() {
- fmt.Println("User 123 has email:", string(result.Values()[0]))
-}
-_, err = result.Close()
-if err != nil {
- log.Fatalln("failed reading result:", err)
-}
-```
-
-## Testing
-
-The pgconn tests require a PostgreSQL database. It will connect to the database specified in the `PGX_TEST_CONN_STRING`
-environment variable. The `PGX_TEST_CONN_STRING` environment variable can be a URL or DSN. In addition, the standard `PG*`
-environment variables will be respected. Consider using [direnv](https://github.com/direnv/direnv) to simplify
-environment variable handling.
-
-### Example Test Environment
-
-Connect to your PostgreSQL server and run:
-
-```
-create database pgx_test;
-```
-
-Now you can run the tests:
-
-```bash
-PGX_TEST_CONN_STRING="host=/var/run/postgresql dbname=pgx_test" go test ./...
-```
-
-### Connection and Authentication Tests
-
-Pgconn supports multiple connection types and means of authentication. These tests are optional. They
-will only run if the appropriate environment variable is set. Run `go test -v | grep SKIP` to see if any tests are being
-skipped. Most developers will not need to enable these tests. See `ci/setup_test.bash` for an example set up if you need change
-authentication code.