Open Source, Distributed, RESTful Search Engine
Java Groovy Shell Python Batchfile ANTLR
Latest commit 44c3b04 Oct 25, 2016 @nik9000 nik9000 Convert more docs to // CONSOLE
Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories`
from `curl` to `// CONSOLE` so they are tested as part of the build and
are cleaner to use in Console. They should work fine with `curl` with
the `COPY AS CURL` link.

Also swaps the `source` type of the response from `js` to `txt` because
that is more correct. The syntax highlighter doesn't care. It looks at
the text to figure out the language. So it looks a little funny for `_cat`
responses regardless.

Relates to #18160
Failed to load latest commit information.
.github Add field for plugins installed on issue template Aug 5, 2016
benchmarks Use 'pipe' instead of of 'comma' to separate benchmark params Oct 10, 2016
buildSrc Pass executor name to request interceptor to support async intercept … Oct 24, 2016
client Merge branch 'master' into cleanup/transport_bulk Oct 11, 2016
core Fix empty <p> tag warning in o/e/m/o/ Oct 25, 2016
dev-tools Testing: Fix smoke tester (#21018) Oct 19, 2016
distribution Change permissions on config files (#20966) Oct 24, 2016
docs Convert more docs to // CONSOLE Oct 25, 2016
modules Fix reindex-from-remote for parent/child from <2.0 Oct 21, 2016
plugins Fix s3 repository when used with IAM profiles Oct 21, 2016
qa Change permissions on config files (#20966) Oct 24, 2016
rest-api-spec `ip_range` aggregation should accept null bounds. (#21043) Oct 21, 2016
test Consolidate code for equals/hashCode testing in central utility class Oct 24, 2016
.dir-locals.el reduce length of compile command Feb 3, 2016
.editorconfig Add simple EditorConfig Nov 30, 2015
.gitignore Only ignore gradle wrapper in root dir (#20341) Sep 6, 2016
.projectile Plugin: Remove multicast plugin Jan 30, 2016 Updated documentation to include precise version of gradle currently … Oct 7, 2016
GRADLE.CHEATSHEET install -> publishToMavenLocal Sep 21, 2016
LICENSE.txt Create elasticsearch-cloud-azure project Aug 22, 2013
NOTICE.txt Updated copyright years to include 2016 (#17808) Apr 18, 2016
README.textile Updated documentation to include precise version of gradle currently … Oct 7, 2016
TESTING.asciidoc Deprecate EOL'ed Ubuntu 15.04 from Vagrantfile Oct 17, 2016
Vagrantfile Deprecate EOL'ed Ubuntu 15.04 from Vagrantfile Oct 17, 2016
build.gradle Build: Remove old maven deploy support (#20403) Sep 19, 2016 Gradle daemon is a demon Nov 25, 2015 Bump Elasticsearch version to 5.0.0-SNAPSHOT Mar 1, 2016
settings.gradle Merge pull request #20532 from rjernst/rolling_upgrades Sep 19, 2016



A Distributed RESTful Search Engine

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.
    • Each shard can have one or more replicas.
    • Read / Search operations performed on any of the replica shards.
  • Multi Tenant with Multi Types.
    • Support for more than one index.
    • Support for more than one type per index.
    • Index level configuration (number of shards, index storage, …).
  • Various set of APIs
    • HTTP RESTful API
    • Native Java API.
    • All APIs perform automatic node operation rerouting.
  • Document oriented
    • No need for upfront schema definition.
    • Schema can be defined per type for customization of the indexing process.
  • Reliable, Asynchronous Write Behind for long term persistency.
  • (Near) Real Time Search.
  • Built on top of Lucene
    • Each shard is a fully functional Lucene index
    • All the power of Lucene easily exposed through simple configuration / plugins.
  • Per operation consistency
    • Single document level operations are atomic, consistent, isolated and durable.
  • Open Source under the Apache License, version 2 (“ALv2”)

Getting Started

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


You need to have a recent version of Java installed. See the Setup page for more information.


  • Download and unzip the Elasticsearch official distribution.
  • Run bin/elasticsearch on unix, or bin\elasticsearch.bat on windows.
  • Run curl -X GET http://localhost:9200/.
  • Start more servers …


Let’s try and index some twitter like information. First, let’s create a twitter user, and add some tweets (the twitter index will be created automatically):

curl -XPUT 'http://localhost:9200/twitter/user/kimchy?pretty' -d '{ "name" : "Shay Banon" }'

curl -XPUT 'http://localhost:9200/twitter/tweet/1?pretty' -d '
    "user": "kimchy",
    "post_date": "2009-11-15T13:12:00",
    "message": "Trying out Elasticsearch, so far so good?"

curl -XPUT 'http://localhost:9200/twitter/tweet/2?pretty' -d '
    "user": "kimchy",
    "post_date": "2009-11-15T14:12:12",
    "message": "Another tweet, will it be indexed?"

Now, let’s see if the information was added by GETting it:

curl -XGET 'http://localhost:9200/twitter/user/kimchy?pretty=true'
curl -XGET 'http://localhost:9200/twitter/tweet/1?pretty=true'
curl -XGET 'http://localhost:9200/twitter/tweet/2?pretty=true'


Mmm search…, shouldn’t it be elastic?
Let’s find all the tweets that kimchy posted:

curl -XGET 'http://localhost:9200/twitter/tweet/_search?q=user:kimchy&pretty=true'

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

curl -XGET 'http://localhost:9200/twitter/tweet/_search?pretty=true' -d '
    "query" : {
        "match" : { "user": "kimchy" }

Just for kicks, let’s get all the documents stored (we should see the user as well):

curl -XGET 'http://localhost:9200/twitter/_search?pretty=true' -d '
    "query" : {
        "match_all" : {}

We can also do range search (the postDate was automatically identified as date)

curl -XGET 'http://localhost:9200/twitter/_search?pretty=true' -d '
    "query" : {
        "range" : {
            "post_date" : { "from" : "2009-11-15T13:00:00", "to" : "2009-11-15T14:00:00" }

There are many more options to perform search, after all, it’s a search product no? All the familiar Lucene queries are available through the JSON query language, or through the query parser.

Multi Tenant – Indices and Types

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

Elasticsearch supports 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 (note, though that each index has an overhead). Here is the indexing curl’s in this case:

curl -XPUT 'http://localhost:9200/kimchy/info/1?pretty' -d '{ "name" : "Shay Banon" }'

curl -XPUT 'http://localhost:9200/kimchy/tweet/1?pretty' -d '
    "user": "kimchy",
    "post_date": "2009-11-15T13:12:00",
    "message": "Trying out Elasticsearch, so far so good?"

curl -XPUT 'http://localhost:9200/kimchy/tweet/2?pretty' -d '
    "user": "kimchy",
    "post_date": "2009-11-15T14:12:12",
    "message": "Another tweet, will it be indexed?"

The above will index information into the kimchy index, with two types, info and tweet. Each user will get their own special index.

Complete control on the index level is allowed. As an example, in the above case, we would want to change from the default 5 shards with 1 replica per index, to only 1 shard with 1 replica per index (== per twitter user). Here is how this can be done (the configuration can be in yaml as well):

curl -XPUT http://localhost:9200/another_user?pretty -d '
    "index" : {
        "number_of_shards" : 1,
        "number_of_replicas" : 1

Search (and similar operations) are multi index aware. This means that we can easily search on more than one
index (twitter user), for example:

curl -XGET 'http://localhost:9200/kimchy,another_user/_search?pretty=true' -d '
    "query" : {
        "match_all" : {}

Or on all the indices:

curl -XGET 'http://localhost:9200/_search?pretty=true' -d '
    "query" : {
        "match_all" : {}

{One liner teaser}: And the cool part about that? You can easily search on multiple twitter users (indices), with different boost levels per user (index), making social search so much simpler (results from my friends rank higher than results from friends of my friends).

Distributed, Highly Available

Let’s 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).

In order to play with the distributed nature of Elasticsearch, 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.

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 website. General questions can be asked on the Elastic Discourse forum or on IRC on Freenode at #elasticsearch. The Elasticsearch GitHub repository is reserved for bug reports and feature requests only.

Building from Source

Elasticsearch uses Gradle for its build system. You’ll need to have version 2.13 of Gradle installed.

In order to create a distribution, simply run the gradle assemble command in the cloned directory.

The distribution for each project will be created under the build/distributions directory in that project.

See the TESTING file for more information about
running the Elasticsearch test suite.

Upgrading from Elasticsearch 1.x?

In order to ensure a smooth upgrade process from earlier versions of
Elasticsearch (1.x), it is required to perform a full cluster restart. Please
see the “setup reference”:
for more details on the upgrade process.


This software is licensed under the Apache License, version 2 ("ALv2"), quoted below.

Copyright 2009-2016 Elasticsearch <>

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

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.