wonderdog 0.0.1

data/.gitignore

@@ -0,0 +1,49 @@
+\#*
+.\#*
+*~
+.DS_Store
+Icon?
+REVISION
+TAGS*
+nohup.out
+.bzr
+.hg
+.svn
+
+a.out
+*.o
+*.pyc
+*.so
+*.stackdump
+*.sw?
+*.tmproj
+*_flymake.*
+.project
+.pydevproject
+.settings
+.tasks-cache
+.yardoc
+
+*.log
+
+*private*
+/log/*
+/pkg/*
+/tmp/*
+/coverage
+
+/db/*.sqlite3
+/config/database.yml
+/config/private.yml
+/config/settings.yml
+/config/sphinx.yml
+/public/stylesheets/compiled/*
+
+/webrat.log
+/vendor/webrat/vendor
+
+doc
+
+/config/apeyeye.yaml
+/config/routes.rb
+/target

data/.rspec

@@ -0,0 +1,2 @@
+--format=progress
+--color

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+Wonderdog has been updated to work with Elasticsearch v17 or greater. Previous code was moved into the branch v17_pre and will be deprecated. All changes going forward will be based upon compatibility with Elasticsearch v17 or greater and will live in the master branch.
+
+* estool has been redone completely for enhanced usability. Run ```bin/estool --help``` for examples.
+
+* Updated and cleaned up test directory.

data/LICENSE.md

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed 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.

data/README.md

@@ -0,0 +1,175 @@
+# Wonderdog
+
+Wonderdog is a Hadoop interface to Elastic Search. While it is specifically intended for use with Apache Pig, it does include all the necessary Hadoop input and output formats for Elastic Search. That is, it's possible to skip Pig en
+tirely and write custom Hadoop jobs if you prefer.
+
+## Requirements
+
+## Usage
+
+### Using ElasticSearchStorage for Apache Pig
+
+The most up-to-date (and simplest) way to store data into elasticsearch with hadoop is to use the Pig Store Function. You can write both delimited and json data to elasticsearch as well as read data from elasticsearch.
+
+#### Storing tabular data:
+
+This allows you to store tabular data (eg. tsv, csv) into elasticsearch.
+
+```pig
+%default ES_JAR_DIR '/usr/local/share/elasticsearch/lib'
+%default INDEX      'ufo_sightings'
+%default OBJ        'sighting'        
+
+register target/wonderdog*.jar;
+register $ES_JAR_DIR/*.jar;
+
+ufo_sightings = LOAD '/data/domestic/aliens/ufo_awesome.tsv' AS (sighted_at:long, reported_at:long, location:chararray, shape:chararray, duration:chararray, description:chararray);
+STORE ufo_sightings INTO 'es://$INDEX/$OBJ?json=false&size=1000' USING com.infochimps.elasticsearch.pig.ElasticSearchStorage();
+```
+
+Here the fields that you set in Pig (eg. 'sighted_at') are used as the field names when creating json records for elasticsearch.
+
+#### Storing json data:
+
+You can store json data just as easily.
+
+```pig
+ufo_sightings = LOAD '/data/domestic/aliens/ufo_awesome.tsv.json' AS (json_record:chararray);
+STORE ufo_sightings INTO 'es://$INDEX/$OBJ?json=true&size=1000' USING com.infochimps.elasticsearch.pig.ElasticSearchStorage();
+```
+
+#### Reading data:
+
+Easy too.
+
+```pig
+-- dump some of the ufo sightings index based on free text query
+alien_sightings = LOAD 'es://ufo_sightings/ufo_sightings?q=alien' USING com.infochimps.elasticsearch.pig.ElasticSearchStorage() AS (doc_id:chararray, contents:chararray);
+DUMP alien_sightings;
+```
+
+#### ElasticSearchStorage Constructor
+
+The constructor to the UDF can take two arguments (in the following order):
+
+* ```esConfig``` - The full path to where elasticsearch.yml lives on the machine launching the hadoop job
+* ```esPlugins``` - The full path to where the elasticsearch plugins directory lives on the machine launching the hadoop job
+
+#### Query Parameters
+
+There are a few query paramaters available:
+
+* ```json``` - (STORE only) When 'true' indicates to the StoreFunc that pre-rendered json records are being indexed. Default is false.
+* ```size``` - When storing, this is used as the bulk request size (the number of records to stack up before indexing to elasticsearch). When loading, this is the number of records to fetch per request. Default 1000.
+* ```q``` - (LOAD only) A free text query determining which records to load. If empty, matches all documents in the index.
+* ```id``` - (STORE only) The name of the field to use as a document id. If blank (or -1) the documents are assumed to have no id and are assigned one by elasticsearch.
+* ```tasks``` - (LOAD only) The number of map tasks to launch. Default 100.
+
+Note that elasticsearch.yml and the plugins directory are distributed to every machine in the cluster automatically via hadoop's distributed cache mechanism.
+
+### Native Hadoop TSV Loader
+
+**Note**: the tsv loader is deprecated. Instead, use the ElasticSearchOutputFormat coupled with either Apache Pig storefunc (ElasticSearchIndex or ElasticSearchJsonIndex).
+
+Once you've got a working set up you should be ready to launch your bulkload process. The best way to explain is with an example. Say you've got a tsv file of user records (name,login,email,description) and you want to index all the fields. Assuming you're going to write to an index called ```users``` with objects of type ```user``` (elasticsearch will create this object automatically the first time you upload one). The workflow is as follows:
+
+* Create the ```users``` index:
+
+```
+bin/estool create --index users
+```
+
+* Upload the data
+
+```
+# Will only work if the hadoop elasticsearch processes can discover the running elasticsearch cluster
+bin/wonderdog --rm --index_name=users --bulk_size=4096 --object_type=user --field_names=name,login,email,description --id_field=1 /hdfs/path/to/users.tsv /tmp/failed_records/users
+```
+
+Notice the output path. When the bulk indexing job runs it is possible for index requests to fail for various reasons (too much load, etc). In this case the documents that failed are simply written to the hdfs so they can be retried in a later job.
+
+* Refresh Index
+
+After the bulk load is finished you'll want to refresh the index so your documents will actually be searchable:
+
+```
+bin/estool refresh --index users
+```
+
+* Snapshot Index
+
+You'll definitely want to do this after the bulk load finishes so you don't lose any data in case of cluster failure:
+
+```
+bin/estool snapshot --index users	
+```
+
+* Bump the replicas for the index up to at least one.
+
+```
+bin/estool set_replication --index users --replicas=1
+```
+
+This will take a while to finish and the cluster health will show yellow until it does.
+
+* Optimize the index
+
+```
+bin/estool optimize --index users -s 3
+```
+
+This will also take a while to finish.
+
+#### TSV loader command-line options
+
+* ```index_name``` - Index to write data to. It does not have to exist ahead of time
+* ```object_type``` - Type of object to index. The mapping for this object does not have to exist ahead of time. Fields will be updated dynamically by elasticsearch.
+* ```field_names``` - A comma separated list of field names describing the tsv record input
+* ```id_field``` - Index of field to use as object id (counting from 0; default 1), use -1 if there is no id field
+* ```bulk_size``` - Number of records per bulk request sent to elasticsearch cluster
+* ```es_home``` - Path to elasticsearch installation, read from the ES_HOME environment variable if it's set
+* ```es_config``` - Path to elasticsearch config file (@elasticsearch.yml@)
+* ```rm``` - Remove existing output? (true or leave blank)
+* ```hadoop_home``` - Path to hadoop installation, read from the HADOOP_HOME environment variable if it's set
+* ```min_split_size``` - Min split size for maps
+
+## Admin
+
+There are a number of convenience commands in ```bin/estool```. Most of the common rest api operations have be mapped. Enumerating a few:
+
+* Print status of all indices as a json hash to the terminal
+
+```
+# See everything (tmi)
+bin/estool -c <elasticsearch_host> status
+```
+
+* Check cluster health (red,green,yellow,relocated shards, etc)
+
+```
+bin/estool -c <elasticsearch_host>  health
+```
+
+* Set replicas for an index
+
+```
+bin/estool set_replication -c <elasticsearch_host> --index <index_name> --replicas <num_replicas>
+```
+
+* Optimize an index
+
+```
+bin/estool optimize -c <elasticsearch_host> --index <index_name>
+```
+
+* Snapshot an index
+
+```
+bin/estool snapshot -c <elasticsearch_host> --index <index_name> 
+```
+
+* Delete an index
+
+```
+bin/estool delete -c <elasticsearch_host> --index <index_name>
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:specs)
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+task :default => [:specs]