Skip to content
Mirror of Apache Accumulo
Java C++ Python Ruby JavaScript Shell Other
Latest commit a605d22 Apr 25, 2016 @joshelser joshelser Merge branch '1.7'
Failed to load latest commit information.
assemble Merge branch '1.7' Mar 31, 2016
contrib ACCUMULO-2606 Remove system-level packaging stuff Apr 1, 2014
core Merge branch 'ACCUMULO-4187' of github:shawnwalker/accumulo Apr 19, 2016
docs ACCUMULO-4152 add fate dump command Mar 3, 2016
examples/simple ACCUMULO-4145 Eliminate Text wrapping of tableIDs Feb 19, 2016
fate ACCUMULO-4152 add fate dump command Mar 4, 2016
iterator-test-harness Merge branch '1.7' Feb 3, 2016
maven-plugin ACCUMULO-4168 Fix failsafe error with explicit junit dependency Mar 16, 2016
minicluster Merge branch '1.7' Feb 3, 2016
proxy ACCUMULO-4147 Add Accumulo Namespace Operations to Proxy Apr 4, 2016
server Merge branch 'ACCUMULO-4187' of github:shawnwalker/accumulo Apr 19, 2016
shell ACCUMULO-4188 Fix PowerMock issue in ShellSetInstanceTest Apr 12, 2016
src/site Merge branch '1.4.5-SNAPSHOT' into 1.5.1-SNAPSHOT Jan 23, 2014
start Merge branch '1.7' Apr 25, 2016
test ACCUMULO-4187: Added rate limiting for major compactions. Apr 19, 2016
trace Merge branch '1.7' Jan 29, 2016
.gitignore Merge branch '1.6' into 1.7 Jan 29, 2016
.travis.yml Merge branch '1.6' into 1.7 Apr 18, 2016
DEPENDENCIES ACCUMULO-3800 Add DEPENDENCIES file May 12, 2015
INSTALL.md ACCUMULO-3409 Move fixed ports out of ephemeral range Jul 8, 2015
LICENSE ACCUMULO-4012 possible infinite loop when the base transaction is rem… Sep 29, 2015
NOTICE Merge branch '1.6' into 1.7 Feb 11, 2016
README.md ACCUMULO-3657 ACCUMULO-3548 Clarify Accumulo API Apr 21, 2015
TESTING.md ACCUMULO-3936 First pass of documentation improvements for performanc… Jul 7, 2015
UPGRADING.md ACCUMULO-3551 1.7 upgrade instructions. May 11, 2015
pom.xml Merge branch '1.7' Mar 3, 2016

README.md

Apache Accumulo

The Apache Accumulo™ sorted, distributed key/value store is a robust, scalable, high performance data storage and retrieval system. Apache Accumulo is based on Google's BigTable design and is built on top of Apache Hadoop, Zookeeper, and Thrift. Apache Accumulo features a few novel improvements on the BigTable design in the form of cell-based access control and a server-side programming mechanism that can modify key/value pairs at various points in the data management process. Other notable improvements and feature are outlined here.

To install and run an Accumulo binary distribution, follow the install instructions.

Documentation

Accumulo provides the following documentation :

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

This documentation is available on the Accumulo site. In the source and binary distributions of Accumulo, the documentation is at different locations.

In the Accumulo binary distribution, all documentation is in the docs directory. The binary distribution does not include example source code, but it does include a jar with the compiled examples. This examples jar makes it easy to step through the example readmes, after following the install instructions.

In the Accumulo source, documentations is found at the following locations.

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.