summaryrefslogtreecommitdiff
path: root/docs/groovy-api/index.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/groovy-api/index.asciidoc')
-rw-r--r--docs/groovy-api/index.asciidoc51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/groovy-api/index.asciidoc b/docs/groovy-api/index.asciidoc
new file mode 100644
index 0000000..87f9a73
--- /dev/null
+++ b/docs/groovy-api/index.asciidoc
@@ -0,0 +1,51 @@
+= Groovy API
+:ref: http://www.elasticsearch.org/guide/en/elasticsearch/reference/current
+:java: http://www.elasticsearch.org/guide/en/elasticsearch/client/java-api/current
+
+[preface]
+== Preface
+
+This section describes the http://groovy.codehaus.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-client-groovy%22[Maven
+Central].
+
+For example, you can define the latest version in your `pom.xml` file:
+
+[source,xml]
+--------------------------------------------------
+<dependency>
+ <groupId>org.elasticsearch</groupId>
+ <artifactId>elasticsearch-client-groovy</artifactId>
+ <version>${es.version}</version>
+</dependency>
+--------------------------------------------------
+
+include::anatomy.asciidoc[]
+
+include::client.asciidoc[]
+
+include::index_.asciidoc[]
+
+include::get.asciidoc[]
+
+include::delete.asciidoc[]
+
+include::search.asciidoc[]
+
+include::count.asciidoc[]
+