[ https://issues.apache.org/jira/browse/ACCUMULO-4511?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15730064#comment-15730064
]
ASF GitHub Bot commented on ACCUMULO-4511:
------------------------------------------
Github user ctubbsii commented on a diff in the pull request:
https://github.com/apache/accumulo-examples/pull/1#discussion_r91394902
--- Diff: README.md ---
@@ -1 +1,107 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
# Apache Accumulo Examples
+
+## Setup instructions
+
+Before running any of the examples, the following steps must be performed.
+
+1. Clone and build this repository
+
+ git clone https://github.com/apache/accumulo-examples.git
+ mvn clean package
+
+2. Install and run Accumulo via the instructions found in INSTALL.md.
+ Remember the instance name. It will be referred to as "instance" throughout
+ the examples. A comma-separated list of zookeeper servers will be referred
+ to as "zookeepers".
+
+3. Create an Accumulo user (for help see the 'User Administration' section of the
+ [user manual][manual]), or use the root user. This user and their password
+ should replace any reference to "username" or "password" in the examples. This
+ user needs the ability to create tables.
+
+In all commands, you will need to replace "instance", "zookeepers",
+"username", and "password" with the values you set for your Accumulo instance.
+
+Commands intended to be run in bash are prefixed by '$'. These are always
+assumed to be run the from the root of this repository.
+
+It is expected that the `accumulo` and `tool.sh` commands are your `PATH`.
+These commands are found in the `bin/` and `contrib/` directories of your
+Accumulo installation.
+
+Commands intended to be run in the Accumulo shell are prefixed by '>'.
+
+## Available Examples
+
+Each example below highlights a feature of Apache Accumulo.
+
+| Example | Description |
+|---------|-------------|
+| [batch] | Using the batch writer and batch scanner |
+| [bloom] | Creating a bloom filter enabled table to increase query performance |
+| [bulkIngest] | Ingesting bulk data using map/reduce jobs on Hadoop |
+| [classpath] | Using per-table classpaths |
+| [client] | Using table operations, reading and writing data in Java. |
+| [combiner] | Using example StatsCombiner to find min, max, sum, and count. |
+| [compactionStrategy] | Configuring a compaction strategy |
+| [constraints] | Using constraints with tables. |
+| [dirlist] | Storing filesystem information. |
+| [export] | Exporting and importing tables. |
+| [filedata] | Storing file data. |
+| [filter] | Using the AgeOffFilter to remove records more than 30 seconds old. |
+| [helloworld] | Inserting records both inside map/reduce jobs and outside. And reading
records between two rows. |
+| [isolation] | Using the isolated scanner to ensure partial changes are not seen. |
+| [mapred] | Using MapReduce to read from and write to Accumulo tables. |
+| [maxmutation] | Limiting mutation size to avoid running out of memory. |
+| [regex] | Using MapReduce and Accumulo to find data using regular expressions. |
+| [reservations] | Using conditional mutations to implement simple reservation system.
|
+| [rgbalancer] | Using a balancer to spread groups of tablets within a table evenly |
+| [rowhash] | Using MapReduce to read a table and write to a new column in the same table.
|
+| [sample] | Building and using sample data in Accumulo. |
+| [shard] | Using the intersecting iterator with a term index partitioned by document.
|
+| [tabletofile] | Using MapReduce to read a table and write one of its columns to a file
in HDFS. |
+| [terasort] | Generating random data and sorting it using Accumulo. |
+| [visibility] | Using visibilities (or combinations of authorizations). Also shows user
permissions. |
--- End diff --
A list might be more readable than a table.
> Put examples in their own git repo
> ----------------------------------
>
> Key: ACCUMULO-4511
> URL: https://issues.apache.org/jira/browse/ACCUMULO-4511
> Project: Accumulo
> Issue Type: Task
> Components: examples
> Reporter: Christopher Tubbs
> Priority: Minor
> Fix For: 2.0.0
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> Accumulo examples can be put in their own repo.
> The examples (if they were to depend solely on the public API) could be on a separate
release cadence than the rest of Accumulo and work across multiple versions. They do not need
to be versioned with, or contained within the Accumulo convenience binary tarball. Instead,
they could be part of a series of instructional tours on the Accumulo website.
> We can request a new git repo easily at https://reporeq.apache.org
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)