search

lalinsky / python-phoenixdb

Phoenix database adapter for Python (migrated to the Apache Phoenix repo)
https://issues.apache.org/jira/browse/PHOENIX-4636
Apache License 2.0
26 stars 24 forks source link

readme

Phoenix database adapter for Python

.. image:: https://code.oxygene.sk/lukas/python-phoenixdb/badges/master/pipeline.svg :target: https://code.oxygene.sk/lukas/python-phoenixdb/commits/master :alt: Build Status

.. image:: https://readthedocs.org/projects/python-phoenixdb/badge/?version=latest :target: http://python-phoenixdb.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

phoenixdb is a Python library for accessing the Phoenix SQL database <http://phoenix.apache.org/> using the remote query server <http://phoenix.apache.org/server.html>. The library implements the standard DB API 2.0 <https://www.python.org/dev/peps/pep-0249/>_ interface, which should be familiar to most Python programmers.

Installation

The easiest way to install the library is using pip <https://pip.pypa.io/en/stable/>_::

pip install phoenixdb

You can also download the source code from GitHub <https://github.com/lalinsky/python-phoenixdb/releases>_, extract the archive and then install it manually::

cd /path/to/python-phoenix-x.y.z/
python setup.py install

Usage

The library implements the standard DB API 2.0 interface, so it can be used the same way you would use any other SQL database from Python, for example::

import phoenixdb
import phoenixdb.cursor

database_url = 'http://localhost:8765/'
conn = phoenixdb.connect(database_url, autocommit=True)

cursor = conn.cursor()
cursor.execute("CREATE TABLE users (id INTEGER PRIMARY KEY, username VARCHAR)")
cursor.execute("UPSERT INTO users VALUES (?, ?)", (1, 'admin'))
cursor.execute("SELECT * FROM users")
print(cursor.fetchall())

cursor = conn.cursor(cursor_factory=phoenixdb.cursor.DictCursor)
cursor.execute("SELECT * FROM users WHERE id=1")
print(cursor.fetchone()['USERNAME'])

Setting up a development environment

If you want to quickly try out the included examples, you can set up a local virtualenv <https://virtualenv.pypa.io/en/latest/>_ with all the necessary requirements::

virtualenv e
source e/bin/activate
pip install -r requirements.txt
python setup.py develop

To create or update the Avatica protobuf classes, change the tag in gen-protobuf.sh and run the script.

If you need a Phoenix query server for experimenting, you can get one running quickly using Docker <https://www.docker.com/>_::

docker-compose up

Or if you need an older version of Phoenix::

PHOENIX_VERSION=4.9 docker-compose up

Interactive SQL shell

There is a Python-based interactive shell include in the examples folder, which can be used to connect to Phoenix and execute queries::

./examples/shell.py http://localhost:8765/
db=> CREATE TABLE test (id INTEGER PRIMARY KEY, name VARCHAR);
no rows affected (1.363 seconds)
db=> UPSERT INTO test (id, name) VALUES (1, 'Lukas');
1 row affected (0.004 seconds)
db=> SELECT * FROM test;
+------+-------+
|   ID | NAME  |
+======+=======+
|    1 | Lukas |
+------+-------+
1 row selected (0.019 seconds)

Running the test suite

The library comes with a test suite for testing Python DB API 2.0 compliance and various Phoenix-specific features. In order to run the test suite, you need a working Phoenix database and set the PHOENIXDB_TEST_DB_URL environment variable::

export PHOENIXDB_TEST_DB_URL='http://localhost:8765/'
nosetests

Commits to the master branch are automatically tested against all supported versions of Phoenix. You can see the results here <https://code.oxygene.sk/lukas/python-phoenixdb/pipelines>_.

Known issues