gopkg/pgx
2
0
Fork 0
Code Activity

Fix minor errors and reword some sentences for readability

Browse Source
This commit is contained in:
Francis Chuang
2019-10-03 09:49:12 +10:00
committed by GitHub
parent 3f377acc1e
commit 6c195c17b2
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -3,7 +3,7 @@
# pgconn # pgconn
Package pgconn is a low-level PostgreSQL database driver. It operates at nearly the same level is the C library libpq. 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. 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 Applications should handle normal queries with a higher level library and only use pgconn directly when required for
low-level access to PostgreSQL functionality. low-level access to PostgreSQL functionality.
@@ -17,7 +17,7 @@ if err != nil {
} }
defer pgConn.Close() defer pgConn.Close()
result := pgConn.ExecParams(context.Background(), "select email from users where id=$1", [][]byte{[]byte("123")}, nil, nil, nil) result := pgConn.ExecParams(context.Background(), "SELECT email FROM users WHERE id=$1", [][]byte{[]byte("123")}, nil, nil, nil)
for result.NextRow() { for result.NextRow() {
fmt.Println("User 123 has email:", string(result.Values()[0])) fmt.Println("User 123 has email:", string(result.Values()[0]))
} }
@@ -29,7 +29,7 @@ if err != nil {
## Testing ## Testing
pgconn tests need a PostgreSQL database. It will connect to the database specified in the `PGX_TEST_CONN_STRING` 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 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 variables will be respected. Consider using [direnv](https://github.com/direnv/direnv) to simplify
environment variable handling. environment variable handling.
@@ -44,13 +44,13 @@ create database pgx_test;
Now you can run the tests: Now you can run the tests:
``` ```bash
PGX_TEST_CONN_STRING="host=/var/run/postgresql dbname=pgx_test" go test ./... PGX_TEST_CONN_STRING="host=/var/run/postgresql dbname=pgx_test" go test ./...
``` ```
### Connection and Authentication Tests ### Connection and Authentication Tests
There are multiple connection types and means of authentication that pgconn supports. These tests are optional. They 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 will only run if the appropriate environment variable is set. Run `go test -v | grep SKIP` to see if any tests are being
skipped. Typical developers will not need to enable these tests. See travis.yml for example setup if you need change skipped. Most developers will not need to enable these tests. See `travis.yml` for an example set up if you need change
authentication code. authentication code.