Skip to content

Latest commit

 

History

History
114 lines (81 loc) · 3.34 KB

README.creole

File metadata and controls

114 lines (81 loc) · 3.34 KB
Raw

aiopg8000

aiopg8000 is a fork of pg8000 to support asyncio. pg8000 is a pure-Python PostgreSQL driver that complies with DB-API 2.0. The driver communicates with the database using the PostgreSQL Backend / Frontend Protocol.

CircleCI Build Status: CircleCI

Links:

Regression Tests

To run the regression tests, install tox:

pip3 install tox

then install all the supported Python versions (using the APT Repository if you're using Ubuntu. Install all the currently supported versions of PostgreSQL (using the APT Repository if you're using Ubuntu. Then for each of them, enable the hstore extension by running the SQL command:

create extension hstore;

and add a line to pg_hba.conf for the various authentication options, eg.

host    pg8000_md5      all             127.0.0.1/32            md5
host    pg8000_gss      all             127.0.0.1/32            gss
host    pg8000_password all             127.0.0.1/32            password
host    all             all             127.0.0.1/32            trust

Set the following environment variables for the databases, for example:

export PG8000_TEST_NAME="PG8000_TEST_9_4"
export PG8000_TEST_9_0="{'user': 'postgres', 'password': 'pw', 'port': 5432}"
export PG8000_TEST_9_1="{'user': 'postgres', 'password': 'pw', 'port': 5433}"
export PG8000_TEST_9_2="{'user': 'postgres', 'password': 'pw', 'port': 5434}"
export PG8000_TEST_9_3="{'user': 'postgres', 'password': 'pw', 'port': 5435}"
export PG8000_TEST_9_4="{'user': 'postgres', 'password': 'pw', 'port': 5436}"

then run tox from the aiopg8000 directory:

tox

Unfortunately, tox doesn't support Python 2.5, so to test CPython 2.5 and Jython 2.5, run the run_25 script.

Performance Tests

To run the performance tests from the aiopg8000 directory:

python3 -m aiopg8000.tests.performance

Stress Test

There's a stress test that is run by doing:

./multi

The idea is to set shared_buffers in postgresql.conf to 128kB, and then run the stress test, and you should get no unpinned buffers errors.

Building The Documentation

The docs are written using Sphinx. To build them, install sphinx:

pip3 install sphinx

Then type:

python3 setup.py build_sphinx

and the docs will appear in build/sphinx/html.

Doing A Release Of aiopg8000

Run tox and run_25 to make sure all tests pass, then update doc/release_notes.rst then do:

git tag -a x.y.z -m "Version x.y.z"
python3 setup.py register sdist bdist_wheel upload build_sphinx upload_docs

Then post a message to the forum.