git.m6w6.name Git - m6w6/ext-pq/blob - README.md

   1 # pecl/pq
   2
   3 [![Build Status](https://travis-ci.org/m6w6/ext-pq.svg?branch=master)](https://travis-ci.org/m6w6/ext-pq)
   4
   5 ## About:
   6
   7 This is a modern binding to the mature [libpq](http://www.postgresql.org/docs/current/static/libpq.html), the official PostgreSQL C-client library.
   8
   9 ### Highlights:
  10
  11 * Nearly 100% support for [asynchronous usage](https://mdref.m6w6.name/pq/Connection/:+Asynchronous+Usage).
  12 * Extended [type support by pg_type](https://mdref.m6w6.name/pq/Types/:+Overview).
  13 * Fetching simple [multi-dimensional array maps](https://mdref.m6w6.name/pq/Result/map).
  14 * Working [Gateway implementation](https://github.com/m6w6/pq-gateway).
  15
  16 ## Documentation
  17
  18 See the [online markdown reference](https://mdref.m6w6.name/pq).
  19
  20 Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO).
  21
  22 ## Installing
  23
  24 ### PECL
  25
  26         pecl install pq
  27
  28 ### PHARext
  29
  30 Watch out for [PECL replicates](https://replicator.pharext.org?pq)
  31 and pharext packages attached to [releases](https://github.com/m6w6/ext-pq/releases).
  32
  33 ### Checkout
  34
  35         git clone github.com:m6w6/ext-pq
  36         cd ext-pq
  37         /path/to/phpize
  38         ./configure --with-php-config=/path/to/php-config
  39         make
  40         sudo make install
  41
  42 ## Dependencies:
  43
  44 This extension unconditionally depends on the pre-loaded presence of the following PHP extensions:
  45
  46 - [raphf](http://pecl.php.net/package/raphf)
  47 - [spl](http://php.net/spl)
  48
  49 It optionally depends on the following extensions:
  50
  51 * [json](http://php.net/json)
  52
  53 ## ChangeLog
  54
  55 A comprehensive list of changes can be obtained from the
  56 [PECL website](https://pecl.php.net/package-changelog.php?package=pq).
  57
  58 ## License
  59
  60 ext-pq is licensed under the 2-Clause-BSD license, which can be found in
  61 the accompanying [LICENSE](./LICENSE) file.
  62
  63 ## Contributing
  64
  65 All forms of contribution are welcome! Please see the bundled
  66 [CONTRIBUTING](./CONTRIBUTING.md) note for the general principles followed.
  67
  68 The list of past and current contributors is maintained in [THANKS](./THANKS).