Skip to content
Mirror of Apache Accumulo
Java C++ Python Ruby JavaScript Shell Other
Latest commit 9703234 May 27, 2016 @ctubbsii ctubbsii Merge branch '1.8'

README.md

Apache Accumulo

Build Status Maven Central Javadoc Apache License

Apache Accumulo is a sorted, distributed key/value store that provides robust, scalable data storage and retrieval.

Apache Accumulo is based on Google's BigTable design and is built on top of Apache Hadoop, Zookeeper, and Thrift. It has several novel features such as cell-based access control and a server-side programming mechanism that can modify key/value pairs at various points in the data management process.

Installation

Follow these instructions to install and run an Accumulo binary distribution.

Documentation

Accumulo has the following documentation which is viewable on the Accumulo website using the links below:

  • User Manual - In-depth developer and administrator documentation.
  • Examples - Code with corresponding README files that give step by step instructions for running the example.

This documentation can also be found in Accumulo distributions:

  • Binary distribution - The User Manual can be found in the docs directory. The Examples Readmes can be found in docs/examples. While the source for the Examples is not included, the distribution has a jar with the compiled examples. This makes it easy to run them after following the install instructions.

  • Source distribution - The Example Source, Example Readmes, and User Manual Source are available.

Building

Accumulo uses Maven to compile, test, and package its source. The following command will build the binary tar.gz from source. Note, these instructions will not work for the Accumulo binary distribution as it does not include source.

mvn package -P assemble

This command produces a file at the following location.

assemble/target/accumulo-X.Y.Z-SNAPSHOT-bin.tar.gz

This will not include documentation, adding the -P docs option to the maven command will build documentation.

API

The public Accumulo API is composed of :

All public types in the following packages and their subpackages excluding those named impl, thrift, or crypto.

  • org.apache.accumulo.core.client
  • org.apache.accumulo.core.data
  • org.apache.accumulo.core.security
  • org.apache.accumulo.minicluster

A type is a class, interface, or enum. Anything with public or protected acccess in an API type is in the API. This includes, but is not limited to: methods, members classes, interfaces, and enums. Package-private types in the above packages are not considered public API.

The following regex matches imports that are not Accumulo public API. This regex can be used with RegexpSingleline to automatically find suspicious imports in a project using Accumulo.

import\s+org\.apache\.accumulo\.(.*\.(impl|thrift|crypto)\..*|(?!core|minicluster).*|core\.(?!client|data|security).*)

The Accumulo project maintains binary compatibility across this API within a major release, as defined in the Java Language Specification 3rd ed. Starting with Accumulo 1.6.2 and 1.7.0 all API changes will follow semver 2.0

Something went wrong with that request. Please try again.