Browse Source

Remove groovy client docs (#42731)

The groovy client api was a wrapper around the transport client.
However, it has not been published since 2.4, as it had many issues with
the java security manager. This commit removes the docs from master for
the groovy client.

relates #42638
Ryan Ernst 6 years ago
parent
commit
622cfa80e7

+ 0 - 102
docs/groovy-api/anatomy.asciidoc

@@ -1,102 +0,0 @@
-[[anatomy]]
-== API Anatomy
-
-Once a <<client,GClient>> has been
-obtained, all of Elasticsearch APIs can be executed on it. Each Groovy
-API is exposed using three different mechanisms.
-
-
-[[closure]]
-=== Closure Request
-
-The first type is to simply provide the request as a Closure, which
-automatically gets resolved into the respective request instance (for
-the index API, its the `IndexRequest` class). The API returns a special
-future, called `GActionFuture`. This is a groovier version of
-Elasticsearch Java `ActionFuture` (in turn a nicer extension to Java own
-`Future`) which allows to register listeners (closures) on it for
-success and failures, as well as blocking for the response. For example:
-
-[source,groovy]
---------------------------------------------------
-def indexR = client.index {
-    index "test"
-    type "_doc"
-    id "1"
-    source {
-        test = "value"
-        complex {
-            value1 = "value1"
-            value2 = "value2"
-        }
-    }
-}
-
-println "Indexed $indexR.response.id into $indexR.response.index/$indexR.response.type"
---------------------------------------------------
-
-In the above example, calling `indexR.response` will simply block for
-the response. We can also block for the response for a specific timeout:
-
-[source,groovy]
---------------------------------------------------
-IndexResponse response = indexR.response "5s" // block for 5 seconds, same as:
-response = indexR.response 5, TimeValue.SECONDS //
---------------------------------------------------
-
-We can also register closures that will be called on success and on
-failure:
-
-[source,groovy]
---------------------------------------------------
-indexR.success = {IndexResponse response ->
-    println "Indexed $response.id into $response.index/$response.type"
-}
-indexR.failure = {Throwable t ->
-    println "Failed to index: $t.message"
-}
---------------------------------------------------
-
-
-[[request]]
-=== Request
-
-This option allows to pass the actual instance of the request (instead
-of a closure) as a parameter. The rest is similar to the closure as a
-parameter option (the `GActionFuture` handling). For example:
-
-[source,groovy]
---------------------------------------------------
-def indexR = client.index (new IndexRequest(
-        index: "test",
-        type: "_doc",
-        id: "1",
-        source: {
-            test = "value"
-            complex {
-                value1 = "value1"
-                value2 = "value2"
-            }
-        }))
-
-println "Indexed $indexR.response.id into $indexR.response.index/$indexR.response.type"
---------------------------------------------------
-
-
-[[java-like]]
-=== Java Like
-
-The last option is to provide an actual instance of the API request, and
-an `ActionListener` for the callback. This is exactly like the Java API
-with the added `gexecute` which returns the `GActionFuture`:
-
-[source,groovy]
---------------------------------------------------
-def indexR = node.client.prepareIndex("test", "_doc", "1").setSource({
-    test = "value"
-    complex {
-        value1 = "value1"
-        value2 = "value2"
-    }
-}).gexecute()
---------------------------------------------------

+ 0 - 59
docs/groovy-api/client.asciidoc

@@ -1,59 +0,0 @@
-[[client]]
-== Client
-
-Obtaining an Elasticsearch Groovy `GClient` (a `GClient` is a simple
-wrapper on top of the Java `Client`) is simple. The most common way to
-get a client is by starting an embedded `Node` which acts as a node
-within the cluster.
-
-
-[[node-client]]
-=== Node Client
-
-A Node based client is the simplest form to get a `GClient` to start
-executing operations against Elasticsearch.
-
-[source,groovy]
---------------------------------------------------
-import org.elasticsearch.groovy.client.GClient
-import org.elasticsearch.groovy.node.GNode
-import static org.elasticsearch.groovy.node.GNodeBuilder.nodeBuilder
-
-// on startup
-
-GNode node = nodeBuilder().node();
-GClient client = node.client();
-
-// on shutdown
-
-node.close();
---------------------------------------------------
-
-Since Elasticsearch allows to configure it using JSON based settings,
-the configuration itself can be done using a closure that represent the
-JSON:
-
-[source,groovy]
---------------------------------------------------
-import org.elasticsearch.groovy.node.GNode
-import org.elasticsearch.groovy.node.GNodeBuilder
-import static org.elasticsearch.groovy.node.GNodeBuilder.*
-
-// on startup
-
-GNodeBuilder nodeBuilder = nodeBuilder();
-nodeBuilder.settings {
-    node {
-        client = true
-    }
-    cluster {
-        name = "test"
-    }
-}
-
-GNode node = nodeBuilder.node()
-
-// on shutdown
-
-node.stop().close()
---------------------------------------------------

+ 0 - 16
docs/groovy-api/delete.asciidoc

@@ -1,16 +0,0 @@
-[[delete]]
-== Delete API
-
-The delete API is very similar to the
-// {javaclient}/java-docs-delete.html[]
-Java delete API, here is an
-example:
-
-[source,groovy]
---------------------------------------------------
-def deleteF = node.client.delete {
-    index "test"
-    type "_doc"
-    id "1"
-}
---------------------------------------------------

+ 0 - 19
docs/groovy-api/get.asciidoc

@@ -1,19 +0,0 @@
-[[get]]
-== Get API
-
-The get API is very similar to the
-// {javaclient}/java-docs-get.html[]
-Java get API. The main benefit
-of using groovy is handling the source content. It can be automatically
-converted to a `Map` which means using Groovy to navigate it is simple:
-
-[source,groovy]
---------------------------------------------------
-def getF = node.client.get {
-    index "test"
-    type "_doc"
-    id "1"
-}
-
-println "Result of field2: $getF.response.source.complex.field2"
---------------------------------------------------

+ 0 - 48
docs/groovy-api/index.asciidoc

@@ -1,48 +0,0 @@
-= Groovy API
-
-include::../Versions.asciidoc[]
-
-[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
-{javaclient}[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[]

+ 0 - 32
docs/groovy-api/index_.asciidoc

@@ -1,32 +0,0 @@
-[[index_]]
-== Index API
-
-The index API is very similar to the
-// {javaclient}/java-docs-index.html[]
-Java index API. The Groovy
-extension to it is the ability to provide the indexed source using a
-closure. For example:
-
-[source,groovy]
---------------------------------------------------
-def indexR = client.index {
-    index "test"
-    type "_doc"
-    id "1"
-    source {
-        test = "value"
-        complex {
-            value1 = "value1"
-            value2 = "value2"
-        }
-    }
-}
---------------------------------------------------
-
-In the above example, the source closure itself gets transformed into an
-XContent (defaults to JSON). In order to change how the source closure
-is serialized, a global (static) setting can be set on the `GClient` by
-changing the `indexContentType` field.
-
-Note also that the `source` can be set using the typical Java based
-APIs, the `Closure` option is a Groovy extension.

+ 0 - 116
docs/groovy-api/search.asciidoc

@@ -1,116 +0,0 @@
-[[search]]
-== Search API
-
-The search API is very similar to the
-// {javaclient}/java-search.html[]
-Java search API. The Groovy
-extension allows to provide the search source to execute as a `Closure`
-including the query itself (similar to GORM criteria builder):
-
-[source,groovy]
---------------------------------------------------
-def search = node.client.search {
-    indices "test"
-    types "_doc"
-    source {
-        query {
-            term(test: "value")
-        }
-    }
-}
-
-search.response.hits.each {SearchHit hit ->
-    println "Got hit $hit.id from $hit.index/$hit.type"
-}
---------------------------------------------------
-
-It can also be executed using the "Java API" while still using a closure
-for the query:
-
-[source,groovy]
---------------------------------------------------
-def search = node.client.prepareSearch("test").setQuery({
-        term(test: "value")
-}).gexecute();
-
-search.response.hits.each {SearchHit hit ->
-    println "Got hit $hit.id from $hit.index/$hit.type"
-}
---------------------------------------------------
-
-The format of the search `Closure` follows the same JSON syntax as the
-{ref}/search-search.html[Search API] request.
-
-
-[[more-examples]]
-=== More examples
-
-Term query where multiple values are provided (see
-{ref}/query-dsl-terms-query.html[terms]):
-
-[source,groovy]
---------------------------------------------------
-def search = node.client.search {
-    indices "test"
-    types "_doc"
-    source {
-        query {
-            terms(test: ["value1", "value2"])
-        }
-    }
-}
---------------------------------------------------
-
-Query string (see
-{ref}/query-dsl-query-string-query.html[query string]):
-
-[source,groovy]
---------------------------------------------------
-def search = node.client.search {
-    indices "test"
-    types "_doc"
-    source {
-        query {
-            query_string(
-                fields: ["test"],
-                query: "value1 value2")
-        }
-    }
-}
---------------------------------------------------
-
-Pagination (see
-{ref}/search-request-from-size.html[from/size]):
-
-[source,groovy]
---------------------------------------------------
-def search = node.client.search {
-    indices "test"
-    types "_doc"
-    source {
-        from = 0
-        size = 10
-        query {
-            term(test: "value")
-        }
-    }
-}
---------------------------------------------------
-
-Sorting (see {ref}/search-request-sort.html[sort]):
-
-[source,groovy]
---------------------------------------------------
-def search = node.client.search {
-    indices "test"
-    types "_doc"
-    source {
-        query {
-            term(test: "value")
-        }
-        sort = [
-            date : [ order: "desc"]
-        ]
-    }
-}
---------------------------------------------------