Skip to content

Commit

Permalink
Docs: Prepare plugin and integration docs for 2.0
Browse files Browse the repository at this point in the history
* Centralised plugin docs in docs/plugins/
* Moved integrations into same docs
* Moved community clients into the clients section of the docs
* Removed docs/community

Closes elastic#11734
Closes elastic#11724
Closes elastic#11636
Closes elastic#11635
Closes elastic#11632
Closes elastic#11630
Closes elastic#12046
Closes elastic#12438
Closes elastic#12579
  • Loading branch information
clintongormley committed Aug 15, 2015
1 parent 4230093 commit e143c6e
Show file tree
Hide file tree
Showing 49 changed files with 4,404 additions and 3,463 deletions.
297 changes: 154 additions & 143 deletions docs/community/clients.asciidoc → docs/community-clients/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,223 +1,234 @@
[[clients]]
== Clients
= Community Contributed Clients

:client: https://www.elastic.co/guide/en/elasticsearch/client

Besides the link:/guide[officially supported Elasticsearch clients], there are
a number of clients that have been contributed by the community for various languages:

* <<clojure>>
* <<cold-fusion>>
* <<erlang>>
* <<go>>
* <<groovy>>
* <<haskell>>
* <<java>>
* <<javascript>>
* <<dotnet>>
* <<ocaml>>
* <<perl>>
* <<php>>
* <<python>>
* <<r>>
* <<ruby>>
* <<scala>>
* <<smalltalk>>
* <<vertx>>
[[clojure]]
== Clojure

* http://github.com/clojurewerkz/elastisch[Elastisch]:
Clojure client.

[[community-perl]]
=== Perl

See the {client}/perl-api/current/index.html[official Elasticsearch Perl client].
[[cold-fusion]]
== Cold Fusion

[[community-python]]
=== Python
The following project appears to be abandoned:

See the {client}/python-api/current/index.html[official Elasticsearch Python client].
* https://github.com/jasonfill/ColdFusion-ElasticSearch-Client[ColdFusion-Elasticsearch-Client]
Cold Fusion client for Elasticsearch

* http://github.com/elasticsearch/elasticsearch-dsl-py[elasticsearch-dsl-py]
chainable query and filter construction built on top of official client.
[[erlang]]
== Erlang

* http://github.com/rhec/pyelasticsearch[pyelasticsearch]:
Python client.
* http://github.com/tsloughter/erlastic_search[erlastic_search]:
Erlang client using HTTP.

* https://github.com/eriky/ESClient[ESClient]:
A lightweight and easy to use Python client for Elasticsearch.
* https://github.com/dieswaytoofast/erlasticsearch[erlasticsearch]:
Erlang client using Thrift.

* https://github.com/humangeo/rawes[rawes]:
Python low level client.
* https://github.com/datahogs/tirexs[Tirexs]:
An https://github.com/elixir-lang/elixir[Elixir] based API/DSL, inspired by
http://github.com/karmi/tire[Tire]. Ready to use in pure Erlang
environment.

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

* http://intridea.github.io/surfiki-refine-elasticsearch/[Surfiki Refine]:
Python Map-Reduce engine targeting Elasticsearch indices.
[[go]]
== Go

* http://github.com/aparo/pyes[pyes]:
Python client.
* https://github.com/mattbaird/elastigo[elastigo]:
Go client.

* https://github.com/belogik/goes[goes]:
Go lib.

[[community-ruby]]
=== Ruby
* https://github.com/olivere/elastic[elastic]:
Elasticsearch client for Google Go.

See the {client}/ruby-api/current/index.html[official Elasticsearch Ruby client].

* http://github.com/karmi/retire[Retire]:
Ruby API & DSL, with ActiveRecord/ActiveModel integration (retired since Sep 2013).
[[groovy]]
== Groovy

* https://github.com/PoseBiz/stretcher[stretcher]:
Ruby client.
See the {client}/groovy-api/current/index.html[official Elasticsearch Groovy client].

* https://github.com/wireframe/elastic_searchable/[elastic_searchable]:
Ruby client + Rails integration.
[[haskell]]
== Haskell
* https://github.com/bitemyapp/bloodhound[bloodhound]:
Haskell client and DSL.

* https://github.com/ddnexus/flex[Flex]:
Ruby Client.

* https://github.com/printercu/elastics-rb[elastics]:
Tiny client with built-in zero-downtime migrations and ActiveRecord integration.
[[java]]
== Java

* https://github.com/toptal/chewy[chewy]:
Chewy is ODM and wrapper for official elasticsearch client
Also see the {client}/java-api/current/index.html[official Elasticsearch Java client].

* https://github.com/ankane/searchkick[Searchkick]:
Intelligent search made easy
* https://github.com/searchbox-io/Jest[Jest]:
Java Rest client.

[[javascript]]
== JavaScript

[[community-php]]
=== PHP
Also see the {client}/javascript-api/current/index.html[official Elasticsearch JavaScript client].

See the {client}/php-api/current/index.html[official Elasticsearch PHP client].
* https://github.com/fullscale/elastic.js[Elastic.js]:
A JavaScript implementation of the Elasticsearch Query DSL and Core API.

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

* http://github.com/nervetattoo/elasticsearch[elasticsearch] PHP client.
* 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

* http://github.com/polyfractal/Sherlock[Sherlock]:
PHP client, one-to-one mapping with query DSL, fluid interface.
The following project appears to be abandoned:

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

[[community-java]]
=== Java

* https://github.com/searchbox-io/Jest[Jest]:
Java Rest client.
* There is of course the {client}/java-api/current/index.html[native ES Java client]
[[dotnet]]
== .NET

[[community-javascript]]
=== JavaScript
Also see the {client}/net-api/current/index.html[official Elasticsearch .NET client].

See the {client}/javascript-api/current/index.html[official Elasticsearch JavaScript client].
* https://github.com/Yegoroff/PlainElastic.Net[PlainElastic.Net]:
.NET client.

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

* https://github.com/phillro/node-elasticsearch-client[node-elasticsearch-client]:
A NodeJS client for Elasticsearch.
The following project appears to be abandoned:

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

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

[[community-groovy]]
=== Groovy
Also see the {client}/perl-api/current/index.html[official Elasticsearch Perl client].

See the {client}/groovy-api/current/index.html[official Elasticsearch Groovy client]
* https://metacpan.org/pod/Elastijk[Elastijk]: A low level minimal HTTP client.

[[community-dotnet]]
=== .NET

See the {client}/net-api/current/index.html[official Elasticsearch .NET client].
[[php]]
== PHP

* https://github.com/Yegoroff/PlainElastic.Net[PlainElastic.Net]:
.NET client.
Also see the {client}/php-api/current/index.html[official Elasticsearch PHP client].

* https://github.com/medcl/ElasticSearch.Net[ElasticSearch.NET]:
.NET client.
* http://github.com/ruflin/Elastica[Elastica]:
PHP client.

* http://github.com/nervetattoo/elasticsearch[elasticsearch] PHP client.

[[community-haskell]]
=== Haskell
* https://github.com/bitemyapp/bloodhound[bloodhound]:
Haskell client and DSL.
[[python]]
== Python

Also see the {client}/python-api/current/index.html[official Elasticsearch Python client].

[[community-scala]]
=== Scala
* http://github.com/elasticsearch/elasticsearch-dsl-py[elasticsearch-dsl-py]
chainable query and filter construction built on top of official client.

* https://github.com/sksamuel/elastic4s[elastic4s]:
Scala DSL.
* http://github.com/rhec/pyelasticsearch[pyelasticsearch]:
Python client.

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

* https://github.com/bsadeh/scalastic[scalastic]:
Scala client.
* https://github.com/mozilla/elasticutils/[elasticutils]:
A friendly chainable Elasticsearch interface for Python.

* https://github.com/gphat/wabisabi[wabisabi]:
Asynchronous REST API Scala client.
* http://github.com/aparo/pyes[pyes]:
Python client.

The following projects appear to be abandoned:

[[community-clojure]]
=== Clojure
* https://github.com/humangeo/rawes[rawes]:
Python low level client.

* http://github.com/clojurewerkz/elastisch[Elastisch]:
Clojure client.
* http://intridea.github.io/surfiki-refine-elasticsearch/[Surfiki Refine]:
Python Map-Reduce engine targeting Elasticsearch indices.

[[r]]
== R
* https://github.com/Tomesch/elasticsearch[elasticsearch]
R client for Elasticsearch

[[community-go]]
=== Go
* https://github.com/ropensci/elastic[elastic]:
A general purpose R client for Elasticsearch

* https://github.com/mattbaird/elastigo[elastigo]:
Go client.
[[ruby]]
== Ruby

* https://github.com/belogik/goes[goes]:
Go lib.
Also see the {client}/ruby-api/current/index.html[official Elasticsearch Ruby client].

* https://github.com/olivere/elastic[elastic]:
Elasticsearch client for Google Go.
* https://github.com/PoseBiz/stretcher[stretcher]:
Ruby client.

[[community-erlang]]
=== Erlang
* https://github.com/printercu/elastics-rb[elastics]:
Tiny client with built-in zero-downtime migrations and ActiveRecord integration.

* http://github.com/tsloughter/erlastic_search[erlastic_search]:
Erlang client using HTTP.
* https://github.com/toptal/chewy[chewy]:
Chewy is ODM and wrapper for official elasticsearch client

* https://github.com/dieswaytoofast/erlasticsearch[erlasticsearch]:
Erlang client using Thrift.
* https://github.com/ankane/searchkick[Searchkick]:
Intelligent search made easy

* https://github.com/datahogs/tirexs[Tirexs]:
An https://github.com/elixir-lang/elixir[Elixir] based API/DSL, inspired by
http://github.com/karmi/tire[Tire]. Ready to use in pure Erlang
environment.
The following projects appear to be abandoned:

* https://github.com/wireframe/elastic_searchable/[elastic_searchable]:
Ruby client + Rails integration.

[[community-eventmachine]]
=== EventMachine
* https://github.com/ddnexus/flex[Flex]:
Ruby Client.

* http://github.com/vangberg/em-elasticsearch[em-elasticsearch]:
elasticsearch library for eventmachine.


[[community-command-line]]
=== Command Line
[[scala]]
== Scala

* https://github.com/elasticsearch/es2unix[es2unix]:
Elasticsearch API consumable by the Linux command line.
* https://github.com/sksamuel/elastic4s[elastic4s]:
Scala DSL.

* https://github.com/javanna/elasticshell[elasticshell]:
command line shell for elasticsearch.
* https://github.com/scalastuff/esclient[esclient]:
Thin Scala client.

* https://github.com/gphat/wabisabi[wabisabi]:
Asynchronous REST API Scala client.

[[community-ocaml]]
=== OCaml
The following project appears to be abandoned:

* https://github.com/tovbinm/ocaml-elasticsearch[ocaml-elasticsearch]:
OCaml client for Elasticsearch
* https://github.com/bsadeh/scalastic[scalastic]:
Scala client.


[[community-smalltalk]]
=== Smalltalk
[[smalltalk]]
== Smalltalk

* http://ss3.gemstone.com/ss/Elasticsearch.html[Elasticsearch] -
Smalltalk client for Elasticsearch

[[community-cold-fusion]]
=== Cold Fusion

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

[[community-nodejs]]
=== NodeJS
* https://github.com/phillro/node-elasticsearch-client[Node-Elasticsearch-Client]
A node.js client for elasticsearch
[[vertx]]
== Vert.x

[[community-r]]
=== R
* https://github.com/Tomesch/elasticsearch[elasticsearch]
R client for Elasticsearch

* https://github.com/ropensci/elastic[elastic]:
A general purpose R client for Elasticsearch
* https://github.com/goodow/realtime-search[realtime-search]:
Elasticsearch module for Vert.x
20 changes: 0 additions & 20 deletions docs/community/frontends.asciidoc

This file was deleted.

Loading

0 comments on commit e143c6e

Please sign in to comment.