OpenSearch/docs/groovy-api/index.asciidoc

50 lines
1.3 KiB
Plaintext

= Groovy API
:ref: http://www.elastic.co/guide/en/elasticsearch/reference/current
:java: http://www.elastic.co/guide/en/elasticsearch/client/java-api/current
:version: 5.0.0-alpha4
[preface]
== Preface
This section describes the http://groovy-lang.org/[Groovy] API
elasticsearch provides. All elasticsearch APIs are executed using a
<<client,GClient>>, and are completely
asynchronous in nature (they either accept a listener, or return a
future).
The Groovy API is a wrapper on top of the
{java}[Java API] exposing it in a groovier
manner. The execution options for each API follow a similar manner and
covered in <<anatomy>>.
[[maven]]
=== Maven Repository
The Groovy API is hosted on
http://search.maven.org/#search%7Cga%7C1%7Ca%3A%22elasticsearch-groovy%22[Maven
Central].
For example, you can define the latest version in your `pom.xml` file:
["source","xml",subs="attributes"]
--------------------------------------------------
<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch-groovy</artifactId>
<version>{version}</version>
</dependency>
--------------------------------------------------
include::anatomy.asciidoc[]
include::client.asciidoc[]
include::index_.asciidoc[]
include::get.asciidoc[]
include::delete.asciidoc[]
include::search.asciidoc[]