Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Mirror of Apache Accumulo
Java C++ Python JavaScript Ruby Shell Other

ACCUMULO-3949 Formatting

Apply formatting changes from previous change
latest commit a9e6d73488
@ctubbsii ctubbsii authored
Failed to load latest commit information.
assemble ACCUMULO-2788: Fixup examples on VFS regex usage
contrib ACCUMULO-2606 Remove system-level packaging stuff
core ACCUMULO-3920 Convert more tests from mock
docs ACCUMULO-3951: Provide some information about the script command in t…
examples/simple ACCUMULO-3920 Convert more tests from mock
fate ACCUMULO-3925 Wrap expected exceptions in a special class for better …
maven-plugin ACCUMULO-3942 Fix failing PluginIT
minicluster ACCUMULO-3920 Deprecate mock components
proxy ACCUMULO-3920 Deprecate mock components
server ACCUMULO-3949 Formatting
shell ACCUMULO-3920 Convert more tests from mock
src/site Merge branch '1.4.5-SNAPSHOT' into 1.5.1-SNAPSHOT
start Merge branch '1.7'
test ACCUMULO-3920 Convert more tests from mock
trace ACCUMULO-3929 Separate performance tests from integration tests by an…
.gitignore ACCUMULO-2927 More targeted git ignores (per-module)
.travis.yml ACCUMULO-2959 Remove assemble profile activation.
DEPENDENCIES ACCUMULO-3800 Add DEPENDENCIES file
INSTALL.md ACCUMULO-3409 Move fixed ports out of ephemeral range
LICENSE Merge branch '1.6'
NOTICE Merge branch '1.6'
README.md ACCUMULO-3657 ACCUMULO-3548 Clarify Accumulo API
TESTING.md ACCUMULO-3936 First pass of documentation improvements for performanc…
UPGRADING.md ACCUMULO-3551 1.7 upgrade instructions.
pom.xml ACCUMULO-3942 Fix failing PluginIT

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.