#10 - Created instructions for using proxy with python (#11)

10 files changed
tree: 5c5a7b481b1b9069cdbb652b9223b3cdf51ec200
  1. .gitignore
  2. .travis.yml
  5. README.md
  6. contrib/
  7. pom.xml
  8. src/

Apache Accumulo Proxy

Build Status Maven Central Javadoc Apache License

This application acts as an Apache Accumulo Java client, and exposes its API as an Apache Thrift service so that users can use their preferred programming language to communicate with Accumulo (provided that language has a supported Thrift language binding).

Running the Accumulo proxy

  1. Build the proxy tarball and install it.

    cd /path/to/accumulo-proxy
    mvn clean package -Ptarball
    tar xzvf ./target/accumulo-proxy-2.0.0-SNAPSHOT-bin.tar.gz -C /path/to/install
  2. Edit proxy.properties and accumulo-client.properties and run the proxy.

    cd /path/to/install/accumulo-proxy-2.0.0-SNAPSHOT
    ./bin/accumulo-proxy -p conf/proxy.properties -c $ACCUMULO_HOME/conf/accumulo-client.properties

Build language specific bindings

Bindings have been built in src/main/ for Java, python, and ruby.

Bindings for other languages can be built using the Thrift compiler. Follow the Thrift tutorial to install a Thrift compiler and use the following command to generate language bindings.

thrift -r --gen <language> <Thrift filename>

Create an Accumulo client using Python

Run the commands below to install the Python bindings and create an example client:

mkdir accumulo-client/
cd accumulo-client/
pipenv --python 2.7
pipenv install -e /path/to/accumulo-proxy/src/main/python
cp /path/to/accumulo-proxy/src/main/python/example.py .
# Edit credentials if needed
vim example.py
pipenv run python2 example.py