Browse Source

[Docs] update reference to remove documentation about percolating during an index, bulk or update request.

Martijn van Groningen 12 years ago
parent
commit
b7c4adeea3

+ 0 - 1
docs/java-api/index_.asciidoc

@@ -182,7 +182,6 @@ you percolator that have matched:
 --------------------------------------------------
 IndexResponse response = client.prepareIndex("twitter", "tweet", "1")
         .setSource(json)
-        .setPercolate("*")
         .execute()
         .actionGet();
 

+ 6 - 4
docs/java-api/percolate.asciidoc

@@ -14,7 +14,7 @@ documentation before reading this guide.
 QueryBuilder qb = termQuery("content", "amazing");
 
 //Index the query = register it in the percolator
-client.prepareIndex("_percolator", "myIndexName", "myDesignatedQueryName")
+client.prepareIndex("myIndexName", "_percolator", "myDesignatedQueryName")
     .setSource(jsonBuilder()
         .startObject()
             .field("query", qb) // Register the query
@@ -38,10 +38,12 @@ docBuilder.field("content", "This is amazing!");
 docBuilder.endObject(); //End of the doc field
 docBuilder.endObject(); //End of the JSON root object
 //Percolate
-PercolateResponse response = 
-    client.preparePercolate("myIndexName", "myDocumentType").setSource(docBuilder).execute().actionGet();
+PercolateResponse response = client.preparePercolate()
+                        .setIndices("myIndexName")
+                        .setDocumentType("myDocumentType")
+                        .setSource(docBuilder).execute().actionGet();
 //Iterate over the results
-for(String result : response) {
+for(PercolateResponse.Match match : response) {
     //Handle the result which is the name of
     //the query in the percolator
 }

+ 0 - 7
docs/reference/docs/bulk.asciidoc

@@ -102,13 +102,6 @@ Each bulk item can include the routing value using the
 `_routing`/`routing` field. It automatically follows the behavior of the
 index / delete operation based on the `_routing` mapping.
 
-[float]
-[[percolator]]
-=== Percolator
-
-Each bulk index action can include a percolate value using the
-`_percolate`/`percolate` field.
-
 [float]
 [[bulk-parent]]
 === Parent

+ 0 - 34
docs/reference/docs/index_.asciidoc

@@ -286,40 +286,6 @@ curl -XPUT 'http://localhost:9200/twitter/tweet/1' -d '{
 More information can be found on the
 <<mapping-ttl-field,_ttl mapping page>>.
 
-[float]
-[[percolate]]
-=== Percolate
-
-<<search-percolate,Percolation>> can be performed
-at index time by passing the `percolate` parameter. Setting it to `*`
-will cause all percolation queries registered against the index to be
-checked against the provided document, for example:
-
-[source,js]
---------------------------------------------------
-curl -XPUT localhost:9200/test/type1/1?percolate=* -d '{
-    "field1" : "value1"
-}'
---------------------------------------------------
-
-To filter out which percolator queries will be executed, pass the query
-string syntax to the `percolate` parameter:
-
-[source,js]
---------------------------------------------------
-curl -XPUT localhost:9200/test/type1/1?percolate=color:green -d '{
-    "field1" : "value1",
-    "field2" : "value2"
-}'
---------------------------------------------------
-
-*NOTE:* In a distributed cluster, percolation during the index operation
-is performed on the primary shard, as soon as the index operation
-completes. The operation executes on the primary while the replicas are
-updating, concurrently. Percolation during the index operation somewhat
-cuts down on parsing overhead, as the parse tree for the document is
-simply re-used for percolation.
-
 [float]
 [[index-distributed]]
 === Distributed

+ 0 - 3
docs/reference/docs/update.asciidoc

@@ -157,9 +157,6 @@ including:
 
 `consistency`:: The write consistency of the index/delete operation.
 
-`percolate`::   Enables percolation and filters out which percolator
-                queries will be executed.
-
 `refresh`::     Refresh the index immediately after the operation occurs,
                 so that the updated document appears in search results 
                 immediately.

+ 1 - 3
docs/reference/query-dsl/queries/query-string-syntax.asciidoc

@@ -4,9 +4,7 @@
 
 The query string ``mini-language'' is used by the
 <<query-dsl-query-string-query>> and <<query-dsl-field-query>>, by the
-`q` query string parameter in the <<search-search,`search` API>> and
-by the `percolate` parameter  in the <<docs-index_,`index`>> and
-<<docs-bulk,`bulk`>> APIs.
+`q` query string parameter in the <<search-search,`search` API>>.
 
 The query string is parsed into a series of _terms_ and _operators_. A
 term can be a single word -- `quick` or `brown` -- or a phrase, surrounded by

+ 1 - 1
docs/reference/search.asciidoc

@@ -5,7 +5,7 @@
 --
 
 Most search APIs are <<search-multi-index-type,multi-index&#44; multi-type>>, with the
-exception of the <<search-explain>> and <<search-percolate>> endpoints.
+exception of the <<search-explain>> endpoints.
 
 [float]
 [[search-routing]]