mirror of https://github.com/perkeep/perkeep.git
104 lines
2.8 KiB
Markdown
104 lines
2.8 KiB
Markdown
|
# pq - A pure Go postgres driver for Go's database/sql package
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
go get github.com/lib/pq
|
||
|
|
|
||
|
|
## Docs
|
||
|
|
|
||
|
|
<http://godoc.org/github.com/lib/pq>
|
||
|
|
|
||
|
|
## Use
|
||
|
|
|
||
|
|
package main
|
||
|
|
|
||
|
|
import (
|
||
|
|
_ "github.com/lib/pq"
|
||
|
|
"database/sql"
|
||
|
|
)
|
||
|
|
|
||
|
|
func main() {
|
||
|
|
db, err := sql.Open("postgres", "user=pqgotest dbname=pqgotest sslmode=verify-full")
|
||
|
|
// ...
|
||
|
|
}
|
||
|
|
|
||
|
|
**Connection String Parameters**
|
||
|
|
|
||
|
|
These are a subset of the libpq connection parameters. In addition, a
|
||
|
|
number of the [environment
|
||
|
|
variables](http://www.postgresql.org/docs/9.1/static/libpq-envars.html)
|
||
|
|
supported by libpq are also supported. Just like libpq, these have
|
||
|
|
lower precedence than explicitly provided connection parameters.
|
||
|
|
|
||
|
|
See http://www.postgresql.org/docs/9.1/static/libpq-connect.html.
|
||
|
|
|
||
|
|
* `dbname` - The name of the database to connect to
|
||
|
|
* `user` - The user to sign in as
|
||
|
|
* `password` - The user's password
|
||
|
|
* `host` - The host to connect to. Values that start with `/` are for unix domain sockets. (default is `localhost`)
|
||
|
|
* `port` - The port to bind to. (default is `5432`)
|
||
|
|
* `sslmode` - Whether or not to use SSL (default is `require`, this is not the default for libpq)
|
||
|
|
Valid values are:
|
||
|
|
* `disable` - No SSL
|
||
|
|
* `require` - Always SSL (skip verification)
|
||
|
|
* `verify-full` - Always SSL (require verification)
|
||
|
|
|
||
|
|
See http://golang.org/pkg/database/sql to learn how to use with `pq` through the `database/sql` package.
|
||
|
|
|
||
|
|
## Tests
|
||
|
|
|
||
|
|
`go test` is used for testing. A running PostgreSQL server is
|
||
|
|
required, with the ability to log in. The default database to connect
|
||
|
|
to test with is "pqgotest," but it can be overridden using environment
|
||
|
|
variables.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
PGHOST=/var/run/postgresql go test pq
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
* SSL
|
||
|
|
* Handles bad connections for `database/sql`
|
||
|
|
* Scan `time.Time` correctly (i.e. `timestamp[tz]`, `time[tz]`, `date`)
|
||
|
|
* Scan binary blobs correctly (i.e. `bytea`)
|
||
|
|
* pq.ParseURL for converting urls to connection strings for sql.Open.
|
||
|
|
* Many libpq compatible environment variables
|
||
|
|
* Unix socket support
|
||
|
|
|
||
|
|
## Future / Things you can help with
|
||
|
|
|
||
|
|
* Notifications: `LISTEN`/`NOTIFY`
|
||
|
|
* `hstore` sugar (i.e. handling hstore in `rows.Scan`)
|
||
|
|
|
||
|
|
## Thank you (alphabetical)
|
||
|
|
|
||
|
|
Some of these contributors are from the original library `bmizerany/pq.go` whose
|
||
|
|
code still exists in here.
|
||
|
|
|
||
|
|
* Andy Balholm (andybalholm)
|
||
|
|
* Ben Berkert (benburkert)
|
||
|
|
* Bill Mill (llimllib)
|
||
|
|
* Bjørn Madsen (aeons)
|
||
|
|
* Blake Gentry (bgentry)
|
||
|
|
* Brad Fitzpatrick (bradfitz)
|
||
|
|
* Chris Walsh (cwds)
|
||
|
|
* Daniel Farina (fdr)
|
||
|
|
* Everyone at The Go Team
|
||
|
|
* Ewan Chou (coocood)
|
||
|
|
* Federico Romero (federomero)
|
||
|
|
* Gary Burd (garyburd)
|
||
|
|
* Heroku (heroku)
|
||
|
|
* Jason McVetta (jmcvetta)
|
||
|
|
* Joakim Sernbrant (serbaut)
|
||
|
|
* John Gallagher (jgallagher)
|
||
|
|
* Kamil Kisiel (kisielk)
|
||
|
|
* Keith Rarick (kr)
|
||
|
|
* Maciek Sakrejda (deafbybeheading)
|
||
|
|
* Marc Brinkmann (mbr)
|
||
|
|
* Martin Olsen (martinolsen)
|
||
|
|
* Mike Lewis (mikelikespie)
|
||
|
|
* Ryan Smith (ryandotsmith)
|
||
|
|
* Samuel Stauffer (samuel)
|
||
|
|
* notedit (notedit)
|