elastic/elasticsearch


Open Source, Distributed, RESTful Search Engine

https://www.elastic.co/products/elasticsearch

License: Other

Language: Java

Keywords: elasticsearch, java, search-engine


Elasticsearch

A Distributed RESTful Search Engine

https://www.elastic.co/products/elasticsearch

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.
    • Support for more than one 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 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.

Getting Started

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

Requirements

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

Installation

  • 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 …

Indexing

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

curl -XPUT 'http://localhost:9200/twitter/_doc/1?pretty' -H 'Content-Type: application/json' -d '
{
    "user": "kimchy",
    "post_date": "2009-11-15T13:12:00",
    "message": "Trying out Elasticsearch, so far so good?"
}'

curl -XPUT 'http://localhost:9200/twitter/_doc/2?pretty' -H 'Content-Type: application/json' -d '
{
    "user": "kimchy",
    "post_date": "2009-11-15T14:12:12",
    "message": "Another tweet, will it be indexed?"
}'

curl -XPUT 'http://localhost:9200/twitter/_doc/3?pretty' -H 'Content-Type: application/json' -d '
{
    "user": "elastic",
    "post_date": "2010-01-15T01:46:38",
    "message": "Building the site, should be kewl"
}'

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

curl -XGET 'http://localhost:9200/twitter/_doc/1?pretty=true'
curl -XGET 'http://localhost:9200/twitter/_doc/2?pretty=true'
curl -XGET 'http://localhost:9200/twitter/_doc/3?pretty=true'

Searching

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

curl -XGET 'http://localhost:9200/twitter/_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/_search?pretty=true' -H 'Content-Type: application/json' -d '
{
    "query" : {
        "match" : { "user": "kimchy" }
    }
}'

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

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

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

curl -XGET 'http://localhost:9200/twitter/_search?pretty=true' -H 'Content-Type: application/json' -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

Man, 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. In the previous example we used an index called twitter that stored tweets for every user.

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/_doc/1?pretty' -H 'Content-Type: application/json' -d '
{
    "user": "kimchy",
    "post_date": "2009-11-15T13:12:00",
    "message": "Trying out Elasticsearch, so far so good?"
}'

curl -XPUT 'http://localhost:9200/kimchy/_doc/2?pretty' -H 'Content-Type: application/json' -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. Each user will get their own special index.

Complete control on the index level is allowed. As an example, in the above case, we might want to change from the default 1 shard with 1 replica per index, to 2 shards with 1 replica per index (because this user tweets a lot). Here is how this can be done (the configuration can be in yaml as well):

curl -XPUT http://localhost:9200/another_user?pretty -H 'Content-Type: application/json' -d '
{
    "index" : {
        "number_of_shards" : 2,
        "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' -H 'Content-Type: application/json' -d '
{
    "query" : {
        "match_all" : {}
    }
}'

Or on all the indices:

curl -XGET 'http://localhost:9200/_search?pretty=true' -H 'Content-Type: application/json' -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 replicas. By default, an index is created with 1 shards and 1 replica per shard (1/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 elastic.co 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.

In order to create a distribution, simply run the ./gradlew 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 older Elasticsearch versions

In order to ensure a smooth upgrade process from earlier versions of Elasticsearch, please see our upgrade documentation for more details on the upgrade process.

Project Statistics

Sourcerank 21
Repository Size 657 MB
Stars 45,640
Forks 15,413
Watchers 2,791
Open issues 2,293
Dependencies 424
Contributors 837
Tags 251
Created
Last updated
Last pushed

Top Contributors See all

Shay Banon Simon Willnauer Jason Tedor Martijn van Groningen Luca Cavanna Ryan Ernst Nik Everett David Pilato Adrien Grand Robert Muir Christoph Büscher Boaz Leskes Clinton Gormley Alexander Reelsen Jay Modi Colin Goodheart-Smithe Lee Hinman Tanguy Leroux Igor Motov Yannick Welsch

Packages Referencing this Repo

org.elasticsearch:elasticsearch-ssl-config
Elasticsearch subproject :libs:elasticsearch-ssl-config
Latest release 7.4.2 - Updated - 45.6K stars
org.elasticsearch:elasticsearch-core
Elasticsearch subproject :libs:core
Latest release 7.0.0-rc2 - Updated - 45.6K stars
org.elasticsearch.client:elasticsearch-rest-client
Elasticsearch subproject :client:rest
Latest release 7.2.0 - Updated - 45.6K stars
org.elasticsearch:elasticsearch-client-groovy
Groovy Plugin for ElasticSearch
Latest release 0.10.0 - Updated - 45.6K stars
org.elasticsearch:elasticsearch-cli
Elasticsearch subproject :libs:cli
Latest release 7.0.0-rc2 - Updated - 45.6K stars
org.elasticsearch.client:elasticsearch-rest-client-sniffer
Elasticsearch subproject :client:sniffer
Latest release 7.2.0 - Updated - 45.6K stars
org.elasticsearch.plugin:aggs-matrix-stats-client
Adds aggregations whose input are a list of numeric fields and output includes a matrix.
Latest release 7.3.2 - Updated - 45.6K stars
org.elasticsearch.plugin:lang-mustache-client
Mustache scripting integration for Elasticsearch
Latest release 7.3.2 - Updated - 45.6K stars
org.elasticsearch:elasticsearch-nio
Elasticsearch subproject :libs:nio
Latest release 7.0.0-alpha1 - Published - 45.6K stars
org.elasticsearch:elasticsearch-secure-sm
Elasticsearch subproject :libs:secure-sm
Latest release 7.0.0-alpha1 - Updated - 45.6K stars
org.elasticsearch.distribution.integ-test-zip:elasticsearch
Open Source, Distributed, RESTful Search Engine
Latest release 6.3.0 - Updated - 45.6K stars
org.elasticsearch.plugin:rank-eval-client
The Rank Eval module adds APIs to evaluate ranking quality.
Latest release 7.0.0-alpha1 - Updated - 45.6K stars
org.elasticsearch.client:elasticsearch-rest-high-level-client
Elasticsearch subproject :client:rest-high-level
Latest release 7.3.2 - Updated - 45.6K stars
org.elasticsearch.plugin:parent-join-client
This module adds the support parent-child queries and aggregations
Latest release 7.0.0-rc2 - Updated - 45.6K stars
org.elasticsearch.plugin:reindex-client
The Reindex module adds APIs to reindex from one index to another or update documents in place.
Latest release 7.3.2 - Updated - 45.6K stars
org.elasticsearch.test:framework
Elasticsearch subproject :test:framework
Latest release 7.0.0-rc2 - Updated - 45.6K stars
org.elasticsearch.client:transport
Elasticsearch subproject :client:transport
Latest release 7.3.2 - Updated - 45.6K stars
org.elasticsearch.qa:smoke-test-shaded
Runs a simple
Latest release 2.0.0-beta1 - Published - 45.6K stars
org.elasticsearch.qa:elasticsearch-qa
Open Source, Distributed, RESTful Search Engine
Latest release 2.4.5 - Updated - 45.6K stars
org.elasticsearch.plugin:analysis-phonetic
The Phonetic Analysis plugin integrates phonetic token filter analysis with elasticsearch.
Latest release 5.0.0 - Updated - 45.6K stars

Recent Tags See all

v7.2.0 June 25, 2019
v6.8.1 June 20, 2019
v7.1.1 May 28, 2019
v7.1.0 May 20, 2019
v6.8.0 May 20, 2019
v6.7.2 May 02, 2019
v7.0.1 May 01, 2019
v7.0.0 April 10, 2019
v6.7.1 April 04, 2019
v7.0.0-rc2 April 02, 2019
v7.0.0-rc1 March 27, 2019
v6.7.0 March 26, 2019
v5.6.16 March 19, 2019
v6.6.2 March 12, 2019
v5.6.15 February 22, 2019

Interesting Forks See all

Orbiter/elasticsearch
Open Source, Distributed, RESTful Search Engine
Java - Apache-2.0 - Updated - 123 stars
aparo/elasticsearch
Open Source, Distributed, RESTful Search Engine - Paro Edition - I add opinionated stuff that wil...
Java - Apache-2.0 - Last pushed - 33 stars - 4 forks
Microsoft/elasticsearch
Open Source, Distributed, RESTful Search Engine
Java - Apache-2.0 - Updated - 28 stars - 8 forks
kimchy/elasticsearch
Open Source, Distributed, RESTful Search Engine
Java - Apache-2.0 - Last pushed - 13 stars - 3 forks
medcl/elasticsearch
Open Source, Distributed, RESTful Search Engine
Java - Other - Last pushed - 11 stars - 2 forks

Something wrong with this page? Make a suggestion

Last synced: 2018-12-05 10:33:40 UTC

Login to resync this repository