Skip to content

Commit

Permalink
Cleanup comments and class names s/ElasticSearch/Elasticsearch
Browse files Browse the repository at this point in the history
 * Clean up s/ElasticSearch/Elasticsearch on docs/*
 * Clean up s/ElasticSearch/Elasticsearch on src/* bin/* & pom.xml
 * Clean up s/ElasticSearch/Elasticsearch on NOTICE.txt and README.textile

Closes elastic#4634
  • Loading branch information
s1monw authored and brusic committed Jan 19, 2014
1 parent 46f8ae9 commit 574cb9a
Show file tree
Hide file tree
Showing 680 changed files with 2,381 additions and 2,409 deletions.
4 changes: 2 additions & 2 deletions NOTICE.txt
@@ -1,5 +1,5 @@
ElasticSearch
Copyright 2009-2014 ElasticSearch and Shay Banon
Elasticsearch
Copyright 2009-2014 Elasticsearch and Shay Banon

This product includes software developed by The Apache Software
Foundation (http://www.apache.org/).
26 changes: 13 additions & 13 deletions README.textile
@@ -1,10 +1,10 @@
h1. ElasticSearch
h1. Elasticsearch

h2. A Distributed RESTful Search Engine

h3. "http://www.elasticsearch.org":http://www.elasticsearch.org

ElasticSearch is a distributed RESTful search engine built for the cloud. Features include:
Elasticsearch is a distributed RESTful search engine built for the cloud. Features include:

* Distributed and Highly Available Search Engine.
** Each index is fully sharded with a configurable number of shards.
Expand Down Expand Up @@ -32,11 +32,11 @@ ElasticSearch is a distributed RESTful search engine built for the cloud. Featur

h2. Getting Started

First of all, DON'T PANIC. It will take 5 minutes to get the gist of what ElasticSearch is all about.
First of all, DON'T PANIC. It will take 5 minutes to get the gist of what Elasticsearch is all about.

h3. Installation

* "Download":http://www.elasticsearch.org/download and unzip the ElasticSearch official distribution.
* "Download":http://www.elasticsearch.org/download and unzip the Elasticsearch official distribution.
* Run @bin/elasticsearch -f@ on unix, or @bin/elasticsearch.bat@ on windows.
* Run @curl -X GET http://localhost:9200/@.
* Start more servers ...
Expand All @@ -52,7 +52,7 @@ curl -XPUT 'http://localhost:9200/twitter/tweet/1' -d '
{
"user": "kimchy",
"postDate": "2009-11-15T13:12:00",
"message": "Trying out Elastic Search, so far so good?"
"message": "Trying out Elasticsearch, so far so good?"
}'

curl -XPUT 'http://localhost:9200/twitter/tweet/2' -d '
Expand Down Expand Up @@ -80,7 +80,7 @@ Lets find all the tweets that @kimchy@ posted:
curl -XGET 'http://localhost:9200/twitter/tweet/_search?q=user:kimchy&pretty=true'
</pre>

We can also use the JSON query language ElasticSearch provides instead of a query string:
We can also use the JSON query language Elasticsearch provides instead of a query string:

<pre>
curl -XGET 'http://localhost:9200/twitter/tweet/_search?pretty=true' -d '
Expand Down Expand Up @@ -121,7 +121,7 @@ h3. Multi Tenant - Indices and Types

Maan, that twitter index might get big (in this case, index size == valuation). Lets see if we can structure our twitter system a bit differently in order to support such large amount of data.

ElasticSearch support multiple indices, as well as multiple types per index. In the previous example we used an index called @twitter@, with two types, @user@ and @tweet@.
Elasticsearch support multiple indices, as well as multiple types per index. In the previous example we used an index called @twitter@, with two types, @user@ and @tweet@.

Another way to define our simple twitter system is to have a different index per user (though note that an index has an overhead). Here is the indexing curl's in this case:

Expand All @@ -132,7 +132,7 @@ curl -XPUT 'http://localhost:9200/kimchy/tweet/1' -d '
{
"user": "kimchy",
"postDate": "2009-11-15T13:12:00",
"message": "Trying out Elastic Search, so far so good?"
"message": "Trying out Elasticsearch, so far so good?"
}'

curl -XPUT 'http://localhost:9200/kimchy/tweet/2' -d '
Expand Down Expand Up @@ -186,17 +186,17 @@ h3. Distributed, Highly Available

Lets face it, things will fail....

ElasticSearch is a highly available and distributed search engine. Each index is broken down into shards, and each shard can have one or more replica. By default, an index is created with 5 shards and 1 replica per shard (5/1). There are many topologies that can be used, including 1/10 (improve search performance), or 20/1 (improve indexing performance, with search executed in a map reduce fashion across shards).
Elasticsearch is a highly available and distributed search engine. Each index is broken down into shards, and each shard can have one or more replica. By default, an index is created with 5 shards and 1 replica per shard (5/1). There are many topologies that can be used, including 1/10 (improve search performance), or 20/1 (improve indexing performance, with search executed in a map reduce fashion across shards).

In order to play with Elastic Search distributed nature, simply bring more nodes up and shut down nodes. The system will continue to serve requests (make sure you use the correct http port) with the latest data indexed.
In order to play with Elasticsearch distributed nature, simply bring more nodes up and shut down nodes. The system will continue to serve requests (make sure you use the correct http port) with the latest data indexed.

h3. Where to go from here?

We have just covered a very small portion of what ElasticSearch is all about. For more information, please refer to the "elasticsearch.org":http://www.elasticsearch.org website.
We have just covered a very small portion of what Elasticsearch is all about. For more information, please refer to the "elasticsearch.org":http://www.elasticsearch.org website.

h3. Building from Source

ElasticSearch uses "Maven":http://maven.apache.org for its build system.
Elasticsearch uses "Maven":http://maven.apache.org for its build system.

In order to create a distribution, simply run the @mvn clean package
-DskipTests@ command in the cloned directory.
Expand All @@ -211,7 +211,7 @@ h1. License
<pre>
This software is licensed under the Apache 2 license, quoted below.

Copyright 2009-2013 Shay Banon and ElasticSearch <http://www.elasticsearch.org>
Copyright 2009-2013 Shay Banon and Elasticsearch <http://www.elasticsearch.org>

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
Expand Down
8 changes: 4 additions & 4 deletions bin/elasticsearch
Expand Up @@ -135,17 +135,17 @@ launch_service()
es_parms="$es_parms -Des.pidfile=$pidpath"
fi

# The es-foreground option will tell ElasticSearch not to close stdout/stderr, but it's up to us not to daemonize.
# The es-foreground option will tell Elasticsearch not to close stdout/stderr, but it's up to us not to daemonize.
if [ "x$daemonized" = "x" ]; then
es_parms="$es_parms -Des.foreground=yes"
exec "$JAVA" $JAVA_OPTS $ES_JAVA_OPTS $es_parms -Des.path.home="$ES_HOME" -cp "$ES_CLASSPATH" $props \
org.elasticsearch.bootstrap.ElasticSearch
org.elasticsearch.bootstrap.Elasticsearch
# exec without running it in the background, makes it replace this shell, we'll never get here...
# no need to return something
else
# Startup ElasticSearch, background it, and write the pid.
# Startup Elasticsearch, background it, and write the pid.
exec "$JAVA" $JAVA_OPTS $ES_JAVA_OPTS $es_parms -Des.path.home="$ES_HOME" -cp "$ES_CLASSPATH" $props \
org.elasticsearch.bootstrap.ElasticSearch <&- &
org.elasticsearch.bootstrap.Elasticsearch <&- &
return $?
fi
}
Expand Down
4 changes: 2 additions & 2 deletions bin/elasticsearch.bat
Expand Up @@ -65,7 +65,7 @@ REM JAVA_OPTS=%JAVA_OPTS% -XX:HeapDumpPath=$ES_HOME/logs/heapdump.hprof
set ES_CLASSPATH=%ES_CLASSPATH%;%ES_HOME%/lib/${project.build.finalName}.jar;%ES_HOME%/lib/*;%ES_HOME%/lib/sigar/*
set ES_PARAMS=-Delasticsearch -Des-foreground=yes -Des.path.home="%ES_HOME%"

"%JAVA_HOME%\bin\java" %JAVA_OPTS% %ES_JAVA_OPTS% %ES_PARAMS% %* -cp "%ES_CLASSPATH%" "org.elasticsearch.bootstrap.ElasticSearch"
"%JAVA_HOME%\bin\java" %JAVA_OPTS% %ES_JAVA_OPTS% %ES_PARAMS% %* -cp "%ES_CLASSPATH%" "org.elasticsearch.bootstrap.Elasticsearch"
goto finally


Expand All @@ -76,4 +76,4 @@ pause

:finally

ENDLOCAL
ENDLOCAL
4 changes: 2 additions & 2 deletions bin/service.bat
Expand Up @@ -179,7 +179,7 @@ if not "%ES_JAVA_OPTS%" == "" set JVM_OPTS=%JVM_OPTS%;%JVM_ES_JAVA_OPTS%
if "%ES_START_TYPE%" == "" set ES_START_TYPE=manual
if "%ES_STOP_TIMEOUT%" == "" set ES_STOP_TIMEOUT=0

"%EXECUTABLE%" //IS//%SERVICE_ID% --Startup %ES_START_TYPE% --StopTimeout %ES_STOP_TIMEOUT% --StartClass org.elasticsearch.bootstrap.ElasticSearch --StopClass org.elasticsearch.bootstrap.ElasticSearch --StartMethod main --StopMethod close --Classpath "%ES_CLASSPATH%" --JvmSs %JVM_SS% --JvmMs %JVM_XMS% --JvmMx %JVM_XMX% --JvmOptions %JVM_OPTS% ++JvmOptions %ES_PARAMS% %LOG_OPTS% --PidFile "%SERVICE_ID%.pid" --DisplayName "Elasticsearch %ES_VERSION% (%SERVICE_ID%)" --Description "Elasticsearch %ES_VERSION% Windows Service - http://elasticsearch.org" --Jvm "%JVM_DLL%" --StartMode jvm --StopMode jvm --StartPath "%ES_HOME%"
"%EXECUTABLE%" //IS//%SERVICE_ID% --Startup %ES_START_TYPE% --StopTimeout %ES_STOP_TIMEOUT% --StartClass org.elasticsearch.bootstrap.Elasticsearch --StopClass org.elasticsearch.bootstrap.Elasticsearch --StartMethod main --StopMethod close --Classpath "%ES_CLASSPATH%" --JvmSs %JVM_SS% --JvmMs %JVM_XMS% --JvmMx %JVM_XMX% --JvmOptions %JVM_OPTS% ++JvmOptions %ES_PARAMS% %LOG_OPTS% --PidFile "%SERVICE_ID%.pid" --DisplayName "Elasticsearch %ES_VERSION% (%SERVICE_ID%)" --Description "Elasticsearch %ES_VERSION% Windows Service - http://elasticsearch.org" --Jvm "%JVM_DLL%" --StartMode jvm --StopMode jvm --StartPath "%ES_HOME%"


if not errorlevel 1 goto installed
Expand Down Expand Up @@ -228,4 +228,4 @@ set /a conv=%conv% * 1024
set "%~2=%conv%"
goto:eof

ENDLOCAL
ENDLOCAL
14 changes: 7 additions & 7 deletions config/elasticsearch.yml
@@ -1,4 +1,4 @@
##################### ElasticSearch Configuration Example #####################
##################### Elasticsearch Configuration Example #####################

# This file contains an overview of various configuration settings,
# targeted at operations staff. Application developers should
Expand All @@ -7,7 +7,7 @@
# The installation procedure is covered at
# <http://elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html>.
#
# ElasticSearch comes with reasonable defaults for most settings,
# Elasticsearch comes with reasonable defaults for most settings,
# so you can try it out without bothering with configuration.
#
# Most of the time, these defaults are just fine for running a production
Expand Down Expand Up @@ -128,7 +128,7 @@
# The "number_of_replicas" can be increased or decreased anytime,
# by using the Index Update Settings API.
#
# ElasticSearch takes care about load balancing, relocating, gathering the
# Elasticsearch takes care about load balancing, relocating, gathering the
# results from nodes, etc. Experiment with different settings to fine-tune
# your setup.

Expand Down Expand Up @@ -174,7 +174,7 @@

################################### Memory ####################################

# ElasticSearch performs poorly when JVM starts swapping: you should ensure that
# Elasticsearch performs poorly when JVM starts swapping: you should ensure that
# it _never_ swaps.
#
# Set this property to true to lock the memory:
Expand All @@ -183,15 +183,15 @@

# Make sure that the ES_MIN_MEM and ES_MAX_MEM environment variables are set
# to the same value, and that the machine has enough memory to allocate
# for ElasticSearch, leaving enough memory for the operating system itself.
# for Elasticsearch, leaving enough memory for the operating system itself.
#
# You should also make sure that the ElasticSearch process is allowed to lock
# You should also make sure that the Elasticsearch process is allowed to lock
# the memory, eg. by using `ulimit -l unlimited`.


############################## Network And HTTP ###############################

# ElasticSearch, by default, binds itself to the 0.0.0.0 address, and listens
# Elasticsearch, by default, binds itself to the 0.0.0.0 address, and listens
# on port [9200-9300] for HTTP traffic and on port [9300-9400] for node-to-node
# communication. (the range means that if the port is busy, it will automatically
# try the next port).
Expand Down
12 changes: 6 additions & 6 deletions docs/community/clients.asciidoc
Expand Up @@ -16,13 +16,13 @@ See the {client}/python-api/current/index.html[official Elasticsearch Python cli
Python client.

* https://github.com/eriky/ESClient[ESClient]:
A lightweight and easy to use Python client for ElasticSearch.
A lightweight and easy to use Python client for Elasticsearch.

* https://github.com/humangeo/rawes[rawes]:
Python low level client.

* https://github.com/mozilla/elasticutils/[elasticutils]:
A friendly chainable ElasticSearch interface for Python.
A friendly chainable Elasticsearch interface for Python.

* http://intridea.github.io/surfiki-refine-elasticsearch/[Surfiki Refine]:
Python Map-Reduce engine targeting Elasticsearch indices.
Expand Down Expand Up @@ -76,13 +76,13 @@ See the {client}/php-api/current/index.html[official Elasticsearch PHP client].
See the {client}/javascript-api/current/index.html[official Elasticsearch JavaScript client].

* https://github.com/fullscale/elastic.js[Elastic.js]:
A JavaScript implementation of the ElasticSearch Query DSL and Core API.
A JavaScript implementation of the Elasticsearch Query DSL and Core API.

* https://github.com/phillro/node-elasticsearch-client[node-elasticsearch-client]:
A NodeJS client for elastic search.
A NodeJS client for Elasticsearch.

* https://github.com/ramv/node-elastical[node-elastical]:
Node.js client for the ElasticSearch REST API
Node.js client for the Elasticsearch REST API

* https://github.com/printercu/elastics[elastics]: Simple tiny client that just works

Expand Down Expand Up @@ -181,6 +181,6 @@ See the {client}/javascript-api/current/index.html[official Elasticsearch JavaSc
[[community-cold-fusion]]
=== Cold Fusion

* https://github.com/jasonfill/ColdFusion-ElasticSearch-Client[ColdFusion-ElasticSearch-Client]
* https://github.com/jasonfill/ColdFusion-ElasticSearch-Client[ColdFusion-Elasticsearch-Client]
Cold Fusion client for Elasticsearch

2 changes: 1 addition & 1 deletion docs/community/frontends.asciidoc
Expand Up @@ -5,7 +5,7 @@
Chrome curl-like plugin for runninq requests against an Elasticsearch node

* https://github.com/mobz/elasticsearch-head[elasticsearch-head]:
A web front end for an elastic search cluster.
A web front end for an Elasticsearch cluster.

* https://github.com/OlegKunitsyn/elasticsearch-browser[browser]:
Web front-end over elasticsearch data.
Expand Down
22 changes: 11 additions & 11 deletions docs/community/integrations.asciidoc
Expand Up @@ -3,19 +3,19 @@


* http://grails.org/plugin/elasticsearch[Grails]:
ElasticSearch Grails plugin.
Elasticsearch Grails plugin.

* https://github.com/carrot2/elasticsearch-carrot2[carrot2]:
Results clustering with carrot2

* https://github.com/angelf/escargot[escargot]:
ElasticSearch connector for Rails (WIP).
Elasticsearch connector for Rails (WIP).

* https://metacpan.org/module/Catalyst::Model::Search::ElasticSearch[Catalyst]:
ElasticSearch and Catalyst integration.
* https://metacpan.org/module/Catalyst::Model::Search::Elasticsearch[Catalyst]:
Elasticsearch and Catalyst integration.

* http://github.com/aparo/django-elasticsearch[django-elasticsearch]:
Django ElasticSearch Backend.
Django Elasticsearch Backend.

* http://github.com/Aconex/elasticflume[elasticflume]:
http://github.com/cloudera/flume[Flume] sink implementation.
Expand All @@ -33,7 +33,7 @@
Symfony2 Bundle wrapping Elastica.

* http://drupal.org/project/elasticsearch[Drupal]:
Drupal ElasticSearch integration.
Drupal Elasticsearch integration.

* https://github.com/refuge/couch_es[couch_es]:
elasticsearch helper for couchdb based products (apache couchdb, bigcouch & refuge)
Expand All @@ -51,11 +51,11 @@
Elasticsearch Java annotations for unit testing with
http://www.junit.org/[JUnit]

* http://searchbox-io.github.com/wp-elasticsearch/[Wp-ElasticSearch]:
ElasticSearch WordPress Plugin
* http://searchbox-io.github.com/wp-elasticsearch/[Wp-Elasticsearch]:
Elasticsearch WordPress Plugin

* https://github.com/OlegKunitsyn/eslogd[eslogd]:
Linux daemon that replicates events to a central ElasticSearch server in real-time
Linux daemon that replicates events to a central Elasticsearch server in real-time

* https://github.com/drewr/elasticsearch-clojure-repl[elasticsearch-clojure-repl]:
Plugin that embeds nREPL for run-time introspective adventure! Also
Expand All @@ -65,11 +65,11 @@
Modular search for Django

* https://github.com/cleverage/play2-elasticsearch[play2-elasticsearch]:
ElasticSearch module for Play Framework 2.x
Elasticsearch module for Play Framework 2.x

* https://github.com/fullscale/dangle[dangle]:
A set of AngularJS directives that provide common visualizations for elasticsearch based on
D3.

* https://github.com/roundscope/ember-data-elasticsearch-kit[ember-data-elasticsearch-kit]:
An ember-data kit for both pushing and querying objects to ElasticSearch cluster
An ember-data kit for both pushing and querying objects to Elasticsearch cluster
2 changes: 1 addition & 1 deletion docs/community/misc.asciidoc
Expand Up @@ -11,7 +11,7 @@
RPMs for elasticsearch.

* http://www.github.com/neogenix/daikon[daikon]:
Daikon ElasticSearch CLI
Daikon Elasticsearch CLI

* https://github.com/Aconex/scrutineer[Scrutineer]:
A high performance consistency checker to compare what you've indexed
Expand Down
8 changes: 4 additions & 4 deletions docs/community/monitoring.asciidoc
Expand Up @@ -7,22 +7,22 @@
* https://github.com/karmi/elasticsearch-paramedic[paramedic]:
Live charts with cluster stats and indices/shards information.

* http://www.elastichq.org/[ElasticSearchHQ]:
* http://www.elastichq.org/[ElasticsearchHQ]:
Free cluster health monitoring tool

* http://sematext.com/spm/index.html[SPM for ElasticSearch]:
* http://sematext.com/spm/index.html[SPM for Elasticsearch]:
Performance monitoring with live charts showing cluster and node stats, integrated
alerts, email reports, etc.

* https://github.com/radu-gheorghe/check-es[check-es]:
Nagios/Shinken plugins for checking on elasticsearch

* https://github.com/anchor/nagios-plugin-elasticsearch[check_elasticsearch]:
An ElasticSearch availability and performance monitoring plugin for
An Elasticsearch availability and performance monitoring plugin for
Nagios.

* https://github.com/rbramley/Opsview-elasticsearch[opsview-elasticsearch]:
Opsview plugin written in Perl for monitoring ElasticSearch
Opsview plugin written in Perl for monitoring Elasticsearch

* https://github.com/polyfractal/elasticsearch-segmentspy[SegmentSpy]:
Plugin to watch Lucene segment merges across your cluster
Expand Down
2 changes: 1 addition & 1 deletion docs/groovy-api/anatomy.asciidoc
Expand Up @@ -2,7 +2,7 @@
== API Anatomy

Once a <<client,GClient>> has been
obtained, all of ElasticSearch APIs can be executed on it. Each Groovy
obtained, all of Elasticsearch APIs can be executed on it. Each Groovy
API is exposed using three different mechanisms.


Expand Down
2 changes: 1 addition & 1 deletion docs/java-api/bulk.asciidoc
Expand Up @@ -16,7 +16,7 @@ bulkRequest.add(client.prepareIndex("twitter", "tweet", "1")
.startObject()
.field("user", "kimchy")
.field("postDate", new Date())
.field("message", "trying out Elastic Search")
.field("message", "trying out Elasticsearch")
.endObject()
)
);
Expand Down

0 comments on commit 574cb9a

Please sign in to comment.