Documentation and code updates (#17)

* Moved namespace code from the Accumulo website to
* Renamed existing python client to
* Moved Java client code/docs from website to docs/
* Updated
4 files changed
tree: f49bef0f56fdabd455aeb3d16975fd316b2ffcc1
  1. .gitignore
  2. .travis.yml
  6. contrib/
  7. docs/
  8. pom.xml
  9. 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 and run the proxy.

    cd /path/to/install/accumulo-proxy-2.0.0-SNAPSHOT
    ./bin/accumulo-proxy -p conf/

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 Python client:

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

Create an Accumulo client using Ruby

Run the command below to create an example Ruby client:

mkdir accumulo-client/
cd accumulo-client/
cp /path/to/accumulo-proxy/src/main/ruby/Gemfile .
vim Gemfile # Set correct path
cp /path/to/accumulo-proxy/src/main/ruby/client.rb .
gem install bundler
bundle install
bundle exec client.rb

Java clients to Proxy

Java clients to the Proxy can be written to limit access to the cluster. The proxy can be placed on a server in the cluster and clients can communicate with proxy from outside of the cluster.