1# pq - A pure Go postgres driver for Go's database/sql package
2
3[![Build Status](https://travis-ci.org/lib/pq.svg?branch=master)](https://travis-ci.org/lib/pq)
4
5## Install
6
7	go get github.com/lib/pq
8
9## Docs
10
11For detailed documentation and basic usage examples, please see the package
12documentation at <http://godoc.org/github.com/lib/pq>.
13
14## Tests
15
16`go test` is used for testing.  A running PostgreSQL server is
17required, with the ability to log in.  The default database to connect
18to test with is "pqgotest," but it can be overridden using environment
19variables.
20
21Example:
22
23	PGHOST=/run/postgresql go test github.com/lib/pq
24
25Optionally, a benchmark suite can be run as part of the tests:
26
27	PGHOST=/run/postgresql go test -bench .
28
29## Features
30
31* SSL
32* Handles bad connections for `database/sql`
33* Scan `time.Time` correctly (i.e. `timestamp[tz]`, `time[tz]`, `date`)
34* Scan binary blobs correctly (i.e. `bytea`)
35* Package for `hstore` support
36* COPY FROM support
37* pq.ParseURL for converting urls to connection strings for sql.Open.
38* Many libpq compatible environment variables
39* Unix socket support
40* Notifications: `LISTEN`/`NOTIFY`
41* pgpass support
42
43## Future / Things you can help with
44
45* Better COPY FROM / COPY TO (see discussion in #181)
46
47## Thank you (alphabetical)
48
49Some of these contributors are from the original library `bmizerany/pq.go` whose
50code still exists in here.
51
52* Andy Balholm (andybalholm)
53* Ben Berkert (benburkert)
54* Benjamin Heatwole (bheatwole)
55* Bill Mill (llimllib)
56* Bjørn Madsen (aeons)
57* Blake Gentry (bgentry)
58* Brad Fitzpatrick (bradfitz)
59* Charlie Melbye (cmelbye)
60* Chris Bandy (cbandy)
61* Chris Gilling (cgilling)
62* Chris Walsh (cwds)
63* Dan Sosedoff (sosedoff)
64* Daniel Farina (fdr)
65* Eric Chlebek (echlebek)
66* Eric Garrido (minusnine)
67* Eric Urban (hydrogen18)
68* Everyone at The Go Team
69* Evan Shaw (edsrzf)
70* Ewan Chou (coocood)
71* Fazal Majid (fazalmajid)
72* Federico Romero (federomero)
73* Fumin (fumin)
74* Gary Burd (garyburd)
75* Heroku (heroku)
76* James Pozdena (jpoz)
77* Jason McVetta (jmcvetta)
78* Jeremy Jay (pbnjay)
79* Joakim Sernbrant (serbaut)
80* John Gallagher (jgallagher)
81* Jonathan Rudenberg (titanous)
82* Joël Stemmer (jstemmer)
83* Kamil Kisiel (kisielk)
84* Kelly Dunn (kellydunn)
85* Keith Rarick (kr)
86* Kir Shatrov (kirs)
87* Lann Martin (lann)
88* Maciek Sakrejda (uhoh-itsmaciek)
89* Marc Brinkmann (mbr)
90* Marko Tiikkaja (johto)
91* Matt Newberry (MattNewberry)
92* Matt Robenolt (mattrobenolt)
93* Martin Olsen (martinolsen)
94* Mike Lewis (mikelikespie)
95* Nicolas Patry (Narsil)
96* Oliver Tonnhofer (olt)
97* Patrick Hayes (phayes)
98* Paul Hammond (paulhammond)
99* Ryan Smith (ryandotsmith)
100* Samuel Stauffer (samuel)
101* Timothée Peignier (cyberdelia)
102* Travis Cline (tmc)
103* TruongSinh Tran-Nguyen (truongsinh)
104* Yaismel Miranda (ympons)
105* notedit (notedit)
106