honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Chunk depth now configurable, so [float] not required

This commit is contained in:
Clinton Gormley 2013-09-03 16:15:07 +02:00
parent 2f10f94c13
commit e6127fc082
16 changed files with 123 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/community/clients.asciidoc
View File

@ -1,13 +1,13 @@
[[clients]] [[clients]]
== Clients == Clients
[float]
=== Perl === Perl
* http://github.com/clintongormley/ElasticSearch.pm[ElasticSearch.pm]: * http://github.com/clintongormley/ElasticSearch.pm[ElasticSearch.pm]:
Perl client. Perl client.
[float]
=== Python === Python
* http://github.com/aparo/pyes[pyes]: * http://github.com/aparo/pyes[pyes]:
@ -28,7 +28,7 @@
* http://intridea.github.io/surfiki-refine-elasticsearch/[Surfiki Refine]: * http://intridea.github.io/surfiki-refine-elasticsearch/[Surfiki Refine]:
Python Map-Reduce engine targeting Elasticsearch indices. Python Map-Reduce engine targeting Elasticsearch indices.
[float]
=== Ruby === Ruby
* http://github.com/karmi/tire[Tire]: * http://github.com/karmi/tire[Tire]:
@ -43,7 +43,7 @@
* https://github.com/wireframe/elastic_searchable/[elastic_searchable]: * https://github.com/wireframe/elastic_searchable/[elastic_searchable]:
Ruby client + Rails integration. Ruby client + Rails integration.
[float]
=== PHP === PHP
* http://github.com/ruflin/Elastica[Elastica]: * http://github.com/ruflin/Elastica[Elastica]:
@ -54,13 +54,13 @@
* http://github.com/polyfractal/Sherlock[Sherlock]: * http://github.com/polyfractal/Sherlock[Sherlock]:
PHP client, one-to-one mapping with query DSL, fluid interface. PHP client, one-to-one mapping with query DSL, fluid interface.
[float]
=== Java === Java
* https://github.com/searchbox-io/Jest[Jest]: * https://github.com/searchbox-io/Jest[Jest]:
Java Rest client. Java Rest client.
[float]
=== Javascript === Javascript
* https://github.com/fullscale/elastic.js[Elastic.js]: * https://github.com/fullscale/elastic.js[Elastic.js]:
@ -72,7 +72,7 @@
* https://github.com/ramv/node-elastical[node-elastical]: * https://github.com/ramv/node-elastical[node-elastical]:
Node.js client for the ElasticSearch REST API Node.js client for the ElasticSearch REST API
[float]
=== .Net === .Net
* https://github.com/Yegoroff/PlainElastic.Net[PlainElastic.Net]: * https://github.com/Yegoroff/PlainElastic.Net[PlainElastic.Net]:
@ -84,7 +84,7 @@
* https://github.com/medcl/ElasticSearch.Net[ElasticSearch.NET]: * https://github.com/medcl/ElasticSearch.Net[ElasticSearch.NET]:
.NET client. .NET client.
[float]
=== Scala === Scala
* https://github.com/sksamuel/elastic4s[elastic4s]: * https://github.com/sksamuel/elastic4s[elastic4s]:
@ -96,13 +96,13 @@
* https://github.com/bsadeh/scalastic[scalastic]: * https://github.com/bsadeh/scalastic[scalastic]:
Scala client. Scala client.
[float]
=== Clojure === Clojure
* http://github.com/clojurewerkz/elastisch[Elastisch]: * http://github.com/clojurewerkz/elastisch[Elastisch]:
Clojure client. Clojure client.
[float]
=== Go === Go
* https://github.com/mattbaird/elastigo[elastigo]: * https://github.com/mattbaird/elastigo[elastigo]:
@ -111,7 +111,7 @@
* https://github.com/belogik/goes[goes]: * https://github.com/belogik/goes[goes]:
Go lib. Go lib.
[float]
=== Erlang === Erlang
* http://github.com/tsloughter/erlastic_search[erlastic_search]: * http://github.com/tsloughter/erlastic_search[erlastic_search]:
@ -125,13 +125,13 @@
http://github.com/karmi/tire[Tire]. Ready to use in pure Erlang http://github.com/karmi/tire[Tire]. Ready to use in pure Erlang
environment. environment.
[float]
=== EventMachine === EventMachine
* http://github.com/vangberg/em-elasticsearch[em-elasticsearch]: * http://github.com/vangberg/em-elasticsearch[em-elasticsearch]:
elasticsearch library for eventmachine. elasticsearch library for eventmachine.
[float]
=== Command Line === Command Line
* https://github.com/elasticsearch/es2unix[es2unix]: * https://github.com/elasticsearch/es2unix[es2unix]:
@ -140,13 +140,13 @@
* https://github.com/javanna/elasticshell[elasticshell]: * https://github.com/javanna/elasticshell[elasticshell]:
command line shell for elasticsearch. command line shell for elasticsearch.
[float]
=== OCaml === OCaml
* https://github.com/tovbinm/ocaml-elasticsearch[ocaml-elasticsearch]: * https://github.com/tovbinm/ocaml-elasticsearch[ocaml-elasticsearch]:
OCaml client for Elasticsearch OCaml client for Elasticsearch
[float]
=== Smalltalk === Smalltalk
* http://ss3.gemstone.com/ss/Elasticsearch.html[Elasticsearch] - * http://ss3.gemstone.com/ss/Elasticsearch.html[Elasticsearch] -

6
docs/groovy-api/anatomy.asciidoc
View File

@ -5,7 +5,7 @@ Once a <<client,GClient>> has been
obtained, all of ElasticSearch APIs can be executed on it. Each Groovy obtained, all of ElasticSearch APIs can be executed on it. Each Groovy
API is exposed using three different mechanisms. API is exposed using three different mechanisms.
[float]
=== Closure Request === Closure Request
The first type is to simply provide the request as a Closure, which The first type is to simply provide the request as a Closure, which
@ -56,7 +56,7 @@ indexR.failure = {Throwable t ->
} }
-------------------------------------------------- --------------------------------------------------
[float]
=== Request === Request
This option allows to pass the actual instance of the request (instead This option allows to pass the actual instance of the request (instead
@ -80,7 +80,7 @@ def indexR = client.index (new IndexRequest(
println "Indexed $indexR.response.id into $indexR.response.index/$indexR.response.type" println "Indexed $indexR.response.id into $indexR.response.index/$indexR.response.type"
-------------------------------------------------- --------------------------------------------------
[float]
=== Java Like === Java Like
The last option is to provide an actual instance of the API request, and The last option is to provide an actual instance of the API request, and

2
docs/groovy-api/client.asciidoc
View File

@ -6,7 +6,7 @@ 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 get a client is by starting an embedded `Node` which acts as a node
within the cluster. within the cluster.
[float]
=== Node Client === Node Client
A Node based client is the simplest form to get a `GClient` to start A Node based client is the simplest form to get a `GClient` to start

2
docs/groovy-api/index.asciidoc
View File

@ -16,7 +16,7 @@ link:{java}[Java API] exposing it in a groovier
manner. The execution options for each API follow a similar manner and manner. The execution options for each API follow a similar manner and
covered in <<anatomy>>. covered in <<anatomy>>.
[float]
==== Maven Repository ==== Maven Repository
The Groovy API is hosted on The Groovy API is hosted on

2
docs/groovy-api/search.asciidoc
View File

@ -40,7 +40,7 @@ search.response.hits.each {SearchHit hit ->
The format of the search `Closure` follows the same JSON syntax as the The format of the search `Closure` follows the same JSON syntax as the
link:{ref}/search-search.html[Search API] request. link:{ref}/search-search.html[Search API] request.
[float]
=== More examples === More examples
Term query where multiple values are provided (see Term query where multiple values are provided (see

4
docs/java-api/client.asciidoc
View File

@ -28,7 +28,7 @@ and cluster sides. You may hit some incompatibilities issues when mixing
major versions. major versions.
______________________________________________________________________________________________________________________________________________________________ ______________________________________________________________________________________________________________________________________________________________
[float]
=== Node Client === Node Client
Instantiating a node based client is the simplest way to get a `Client` Instantiating a node based client is the simplest way to get a `Client`
@ -119,7 +119,7 @@ Client client = node.client();
node.close(); node.close();
-------------------------------------------------- --------------------------------------------------
[float]
=== Transport Client === Transport Client
The `TransportClient` connects remotely to an elasticsearch cluster The `TransportClient` connects remotely to an elasticsearch cluster

2
docs/java-api/count.asciidoc
View File

@ -20,7 +20,7 @@ CountResponse response = client.prepareCount("test")
For more information on the count operation, check out the REST For more information on the count operation, check out the REST
link:{ref}/search-count.html[count] docs. link:{ref}/search-count.html[count] docs.
[float]
=== Operation Threading === Operation Threading
The count API allows to set the threading model the operation will be The count API allows to set the threading model the operation will be

2
docs/java-api/delete.asciidoc
View File

@ -16,7 +16,7 @@ DeleteResponse response = client.prepareDelete("twitter", "tweet", "1")
For more information on the delete operation, check out the For more information on the delete operation, check out the
link:{ref}/docs-delete.html[delete API] docs. link:{ref}/docs-delete.html[delete API] docs.
[float]
=== Operation Threading === Operation Threading
The delete API allows to set the threading model the operation will be The delete API allows to set the threading model the operation will be

60
docs/java-api/facets.asciidoc
View File

@ -26,17 +26,17 @@ in your class:
import org.elasticsearch.search.facet.FacetBuilders.*; import org.elasticsearch.search.facet.FacetBuilders.*;
-------------------------------------------------- --------------------------------------------------
[float]
=== Facets === Facets
[float]
==== Terms Facet ==== Terms Facet
Here is how you can use Here is how you can use
link:{ref}/search-facets-terms-facet.html[Terms Facet] link:{ref}/search-facets-terms-facet.html[Terms Facet]
with Java API. with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -48,7 +48,7 @@ FacetBuilders.termsFacet("f")
.size(10); .size(10);
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -74,14 +74,14 @@ for (TermsFacet.Entry entry : f) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
==== Range Facet ==== Range Facet
Here is how you can use Here is how you can use
link:{ref}/search-facets-range-facet.html[Range Facet] link:{ref}/search-facets-range-facet.html[Range Facet]
with Java API. with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -95,7 +95,7 @@ FacetBuilders.rangeFacet("f")
.addUnboundedTo(6); // from 6 to +infinity .addUnboundedTo(6); // from 6 to +infinity
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -122,14 +122,14 @@ for (RangeFacet.Entry entry : f) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
==== Histogram Facet ==== Histogram Facet
Here is how you can use Here is how you can use
link:{ref}/search-facets-histogram-facet.html[Histogram link:{ref}/search-facets-histogram-facet.html[Histogram
Facet] with Java API. Facet] with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -141,7 +141,7 @@ HistogramFacetBuilder facet = FacetBuilders.histogramFacet("f")
.interval(1); .interval(1);
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -163,14 +163,14 @@ for (HistogramFacet.Entry entry : f) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
==== Date Histogram Facet ==== Date Histogram Facet
Here is how you can use Here is how you can use
link:{ref}/search-facets-date-histogram-facet.html[Date link:{ref}/search-facets-date-histogram-facet.html[Date
Histogram Facet] with Java API. Histogram Facet] with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -183,7 +183,7 @@ FacetBuilders.dateHistogramFacet("f")
// "hour" and "minute" or notation like "1.5h" or "2w" // "hour" and "minute" or notation like "1.5h" or "2w"
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -205,7 +205,7 @@ for (DateHistogramFacet.Entry entry : f) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
==== Filter Facet (not facet filter) ==== Filter Facet (not facet filter)
Here is how you can use Here is how you can use
@ -215,7 +215,7 @@ with Java API.
If you are looking on how to apply a filter to a facet, have a look at If you are looking on how to apply a filter to a facet, have a look at
link:#facet-filter[facet filter] using Java API. link:#facet-filter[facet filter] using Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -229,7 +229,7 @@ FacetBuilders.filterFacet("f",
See <<query-dsl-filters,Filters>> to See <<query-dsl-filters,Filters>> to
learn how to build filters using Java. learn how to build filters using Java.
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -247,14 +247,14 @@ FilterFacet f = (FilterFacet) sr.facets().facetsAsMap().get("f");
f.getCount(); // Number of docs that matched f.getCount(); // Number of docs that matched
-------------------------------------------------- --------------------------------------------------
[float]
==== Query Facet ==== Query Facet
Here is how you can use Here is how you can use
link:{ref}/search-facets-query-facet.html[Query Facet] link:{ref}/search-facets-query-facet.html[Query Facet]
with Java API. with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -265,7 +265,7 @@ FacetBuilders.queryFacet("f",
QueryBuilders.matchQuery("brand", "heineken")); QueryBuilders.matchQuery("brand", "heineken"));
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -286,14 +286,14 @@ f.getCount(); // Number of docs that matched
See <<query-dsl-queries,Queries>> to See <<query-dsl-queries,Queries>> to
learn how to build queries using Java. learn how to build queries using Java.
[float]
==== Statistical ==== Statistical
Here is how you can use Here is how you can use
link:{ref}/search-facets-statistical-facet.html[Statistical link:{ref}/search-facets-statistical-facet.html[Statistical
Facet] with Java API. Facet] with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -304,7 +304,7 @@ FacetBuilders.statisticalFacet("f")
.field("price"); .field("price");
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -329,14 +329,14 @@ f.getSumOfSquares(); // Sum of Squares
f.getVariance(); // Variance f.getVariance(); // Variance
-------------------------------------------------- --------------------------------------------------
[float]
==== Terms Stats Facet ==== Terms Stats Facet
Here is how you can use Here is how you can use
link:{ref}/search-facets-terms-stats-facet.html[Terms link:{ref}/search-facets-terms-stats-facet.html[Terms
Stats Facet] with Java API. Stats Facet] with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -348,7 +348,7 @@ FacetBuilders.termsStatsFacet("f")
.valueField("price"); .valueField("price");
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -377,14 +377,14 @@ for (TermsStatsFacet.Entry entry : f) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
==== Geo Distance Facet ==== Geo Distance Facet
Here is how you can use Here is how you can use
link:{ref}/search-facets-geo-distance-facet.html[Geo link:{ref}/search-facets-geo-distance-facet.html[Geo
Distance Facet] with Java API. Distance Facet] with Java API.
[float]
===== Prepare facet request ===== Prepare facet request
Here is an example on how to create the facet request: Here is an example on how to create the facet request:
@ -401,7 +401,7 @@ FacetBuilders.geoDistanceFacet("f")
.unit(DistanceUnit.KILOMETERS); // All distances are in kilometers. Can be MILES .unit(DistanceUnit.KILOMETERS); // All distances are in kilometers. Can be MILES
-------------------------------------------------- --------------------------------------------------
[float]
===== Use facet response ===== Use facet response
Import Facet definition classes: Import Facet definition classes:
@ -428,7 +428,7 @@ for (GeoDistanceFacet.Entry entry : f) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
=== Facet filters (not Filter Facet) === Facet filters (not Filter Facet)
By default, facets are applied on the query resultset whatever filters By default, facets are applied on the query resultset whatever filters
@ -468,7 +468,7 @@ SearchResponse sr = node.client().prepareSearch()
See documentation on how to build See documentation on how to build
<<query-dsl-filters,Filters>>. <<query-dsl-filters,Filters>>.
[float]
=== Scope === Scope
By default, facets are computed within the query resultset. But, you can By default, facets are computed within the query resultset. But, you can

2
docs/java-api/get.asciidoc
View File

@ -15,7 +15,7 @@ GetResponse response = client.prepareGet("twitter", "tweet", "1")
For more information on the index operation, check out the REST For more information on the index operation, check out the REST
link:{ref}/docs-get.html[get] docs. link:{ref}/docs-get.html[get] docs.
[float]
=== Operation Threading === Operation Threading
The get API allows to set the threading model the operation will be The get API allows to set the threading model the operation will be

2
docs/java-api/index.asciidoc
View File

@ -16,7 +16,7 @@ Additionally, operations on a client may be accumulated and executed in
Note, all the APIs are exposed through the Note, all the APIs are exposed through the
Java API (actually, the Java API is used internally to execute them). Java API (actually, the Java API is used internally to execute them).
[float]
== Maven Repository == Maven Repository
Elasticsearch is hosted on Elasticsearch is hosted on

14
docs/java-api/index_.asciidoc
View File

@ -4,7 +4,7 @@
The index API allows one to index a typed JSON document into a specific The index API allows one to index a typed JSON document into a specific
index and make it searchable. index and make it searchable.
[float]
=== Generate JSON document === Generate JSON document
There are different way of generating JSON document: There are different way of generating JSON document:
@ -24,7 +24,7 @@ to a `byte[]`). Therefore, if the object is in this form already, then
use it. The `jsonBuilder` is highly optimized JSON generator that use it. The `jsonBuilder` is highly optimized JSON generator that
directly constructs a `byte[]`. directly constructs a `byte[]`.
[float]
==== Do It Yourself ==== Do It Yourself
Nothing really difficult here but note that you will have to encode Nothing really difficult here but note that you will have to encode
@ -40,7 +40,7 @@ String json = "{" +
"}"; "}";
-------------------------------------------------- --------------------------------------------------
[float]
==== Using Map ==== Using Map
Map is a key:values pair collection. It represents very well a JSON Map is a key:values pair collection. It represents very well a JSON
@ -54,7 +54,7 @@ json.put("postDate",new Date());
json.put("message","trying out Elastic Search"); json.put("message","trying out Elastic Search");
-------------------------------------------------- --------------------------------------------------
[float]
==== Serialize your beans ==== Serialize your beans
Elasticsearch already use Jackson but shade it under Elasticsearch already use Jackson but shade it under
@ -87,7 +87,7 @@ ObjectMapper mapper = new ObjectMapper(); // create once, reuse
String json = mapper.writeValueAsString(yourbeaninstance); String json = mapper.writeValueAsString(yourbeaninstance);
-------------------------------------------------- --------------------------------------------------
[float]
==== Use Elasticsearch helpers ==== Use Elasticsearch helpers
Elasticsearch provides built-in helpers to generate JSON content. Elasticsearch provides built-in helpers to generate JSON content.
@ -117,7 +117,7 @@ If you need to see the generated JSON content, you can use the
String json = builder.string(); String json = builder.string();
-------------------------------------------------- --------------------------------------------------
[float]
=== Index document === Index document
The following example indexes a JSON document into an index called The following example indexes a JSON document into an index called
@ -187,7 +187,7 @@ List<String> matches = response.matches();
For more information on the index operation, check out the REST For more information on the index operation, check out the REST
link:{ref}/docs-index_.html[index] docs. link:{ref}/docs-index_.html[index] docs.
[float]
=== Operation Threading === Operation Threading
The index API allows to set the threading model the operation will be The index API allows to set the threading model the operation will be

50
docs/java-api/query-dsl-filters.asciidoc
View File

@ -19,7 +19,7 @@ import org.elasticsearch.index.query.FilterBuilders.*;
Note that you can easily print (aka debug) JSON generated queries using Note that you can easily print (aka debug) JSON generated queries using
`toString()` method on `FilterBuilder` object. `toString()` method on `FilterBuilder` object.
[float]
=== And Filter === And Filter
See link:{ref}/query-dsl-and-filter.html[And Filter] See link:{ref}/query-dsl-and-filter.html[And Filter]
@ -36,7 +36,7 @@ FilterBuilders.andFilter(
Note that you can cache the result using Note that you can cache the result using
`AndFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `AndFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Bool Filter === Bool Filter
See link:{ref}/query-dsl-bool-filter.html[Bool Filter] See link:{ref}/query-dsl-bool-filter.html[Bool Filter]
@ -54,7 +54,7 @@ FilterBuilders.boolFilter()
Note that you can cache the result using Note that you can cache the result using
`BoolFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `BoolFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Exists Filter === Exists Filter
See link:{ref}/query-dsl-exists-filter.html[Exists Filter]. See link:{ref}/query-dsl-exists-filter.html[Exists Filter].
@ -65,7 +65,7 @@ See link:{ref}/query-dsl-exists-filter.html[Exists Filter].
FilterBuilders.existsFilter("user"); FilterBuilders.existsFilter("user");
-------------------------------------------------- --------------------------------------------------
[float]
=== Ids Filter === Ids Filter
See link:{ref}/query-dsl-ids-filter.html[IDs Filter] See link:{ref}/query-dsl-ids-filter.html[IDs Filter]
@ -79,7 +79,7 @@ FilterBuilders.idsFilter("my_type", "type2").addIds("1", "4", "100");
FilterBuilders.idsFilter().addIds("1", "4", "100"); FilterBuilders.idsFilter().addIds("1", "4", "100");
-------------------------------------------------- --------------------------------------------------
[float]
=== Limit Filter === Limit Filter
See link:{ref}/query-dsl-limit-filter.html[Limit Filter] See link:{ref}/query-dsl-limit-filter.html[Limit Filter]
@ -90,7 +90,7 @@ See link:{ref}/query-dsl-limit-filter.html[Limit Filter]
FilterBuilders.limitFilter(100); FilterBuilders.limitFilter(100);
-------------------------------------------------- --------------------------------------------------
[float]
=== Type Filter === Type Filter
See link:{ref}/query-dsl-type-filter.html[Type Filter] See link:{ref}/query-dsl-type-filter.html[Type Filter]
@ -101,7 +101,7 @@ See link:{ref}/query-dsl-type-filter.html[Type Filter]
FilterBuilders.typeFilter("my_type"); FilterBuilders.typeFilter("my_type");
-------------------------------------------------- --------------------------------------------------
[float]
=== Geo Bounding Box Filter === Geo Bounding Box Filter
See link:{ref}/query-dsl-geo-bounding-box-filter.html[Geo See link:{ref}/query-dsl-geo-bounding-box-filter.html[Geo
@ -118,7 +118,7 @@ Note that you can cache the result using
`GeoBoundingBoxFilterBuilder#cache(boolean)` method. See `GeoBoundingBoxFilterBuilder#cache(boolean)` method. See
<<query-dsl-filters-caching>>. <<query-dsl-filters-caching>>.
[float]
=== GeoDistance Filter === GeoDistance Filter
See link:{ref}/query-dsl-geo-distance-filter.html[Geo See link:{ref}/query-dsl-geo-distance-filter.html[Geo
@ -137,7 +137,7 @@ Note that you can cache the result using
`GeoDistanceFilterBuilder#cache(boolean)` method. See `GeoDistanceFilterBuilder#cache(boolean)` method. See
<<query-dsl-filters-caching>>. <<query-dsl-filters-caching>>.
[float]
=== Geo Distance Range Filter === Geo Distance Range Filter
See link:{ref}/query-dsl-geo-distance-range-filter.html[Geo See link:{ref}/query-dsl-geo-distance-range-filter.html[Geo
@ -159,7 +159,7 @@ Note that you can cache the result using
`GeoDistanceRangeFilterBuilder#cache(boolean)` method. See `GeoDistanceRangeFilterBuilder#cache(boolean)` method. See
<<query-dsl-filters-caching>>. <<query-dsl-filters-caching>>.
[float]
=== Geo Polygon Filter === Geo Polygon Filter
See link:{ref}/query-dsl-geo-polygon-filter.html[Geo Polygon See link:{ref}/query-dsl-geo-polygon-filter.html[Geo Polygon
@ -177,7 +177,7 @@ Note that you can cache the result using
`GeoPolygonFilterBuilder#cache(boolean)` method. See `GeoPolygonFilterBuilder#cache(boolean)` method. See
<<query-dsl-filters-caching>>. <<query-dsl-filters-caching>>.
[float]
=== Geo Shape Filter === Geo Shape Filter
See link:{ref}/query-dsl-geo-shape-filter.html[Geo Shape See link:{ref}/query-dsl-geo-shape-filter.html[Geo Shape
@ -236,7 +236,7 @@ filter = FilterBuilders.geoShapeFilter("location", "New Zealand", "countries")
.relation(ShapeRelation.DISJOINT); .relation(ShapeRelation.DISJOINT);
-------------------------------------------------- --------------------------------------------------
[float]
=== Has Child / Has Parent Filters === Has Child / Has Parent Filters
See: See:
@ -254,7 +254,7 @@ QFilterBuilders.hasParentFilter("blog",
QueryBuilders.termQuery("tag", "something")); QueryBuilders.termQuery("tag", "something"));
-------------------------------------------------- --------------------------------------------------
[float]
=== Match All Filter === Match All Filter
See link:{ref}/query-dsl-match-all-filter.html[Match All Filter] See link:{ref}/query-dsl-match-all-filter.html[Match All Filter]
@ -264,7 +264,7 @@ See link:{ref}/query-dsl-match-all-filter.html[Match All Filter]
FilterBuilders.matchAllFilter(); FilterBuilders.matchAllFilter();
-------------------------------------------------- --------------------------------------------------
[float]
=== Missing Filter === Missing Filter
See link:{ref}/query-dsl-missing-filter.html[Missing Filter] See link:{ref}/query-dsl-missing-filter.html[Missing Filter]
@ -277,7 +277,7 @@ FilterBuilders.missingFilter("user")
.nullValue(true); .nullValue(true);
-------------------------------------------------- --------------------------------------------------
[float]
=== Not Filter === Not Filter
See link:{ref}/query-dsl-not-filter.html[Not Filter] See link:{ref}/query-dsl-not-filter.html[Not Filter]
@ -289,7 +289,7 @@ FilterBuilders.notFilter(
FilterBuilders.rangeFilter("price").from("1").to("2")); FilterBuilders.rangeFilter("price").from("1").to("2"));
-------------------------------------------------- --------------------------------------------------
[float]
=== Numeric Range Filter === Numeric Range Filter
See link:{ref}/query-dsl-numeric-range-filter.html[Numeric See link:{ref}/query-dsl-numeric-range-filter.html[Numeric
@ -308,7 +308,7 @@ Note that you can cache the result using
`NumericRangeFilterBuilder#cache(boolean)` method. See `NumericRangeFilterBuilder#cache(boolean)` method. See
<<query-dsl-filters-caching>>. <<query-dsl-filters-caching>>.
[float]
=== Or Filter === Or Filter
See link:{ref}/query-dsl-or-filter.html[Or Filter] See link:{ref}/query-dsl-or-filter.html[Or Filter]
@ -325,7 +325,7 @@ FilterBuilders.orFilter(
Note that you can cache the result using Note that you can cache the result using
`OrFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `OrFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Prefix Filter === Prefix Filter
See link:{ref}/query-dsl-prefix-filter.html[Prefix Filter] See link:{ref}/query-dsl-prefix-filter.html[Prefix Filter]
@ -339,7 +339,7 @@ FilterBuilders.prefixFilter("user", "ki");
Note that you can cache the result using Note that you can cache the result using
`PrefixFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `PrefixFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Query Filter === Query Filter
See link:{ref}/query-dsl-query-filter.html[Query Filter] See link:{ref}/query-dsl-query-filter.html[Query Filter]
@ -355,7 +355,7 @@ FilterBuilders.queryFilter(
Note that you can cache the result using Note that you can cache the result using
`QueryFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `QueryFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Range Filter === Range Filter
See link:{ref}/query-dsl-range-filter.html[Range Filter] See link:{ref}/query-dsl-range-filter.html[Range Filter]
@ -378,7 +378,7 @@ FilterBuilders.rangeFilter("age")
Note that you can ask not to cache the result using Note that you can ask not to cache the result using
`RangeFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `RangeFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Script Filter === Script Filter
See link:{ref}/query-dsl-script-filter.html[Script Filter] See link:{ref}/query-dsl-script-filter.html[Script Filter]
@ -394,7 +394,7 @@ FilterBuilder filter = FilterBuilders.scriptFilter(
Note that you can cache the result using Note that you can cache the result using
`ScriptFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `ScriptFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Term Filter === Term Filter
See link:{ref}/query-dsl-term-filter.html[Term Filter] See link:{ref}/query-dsl-term-filter.html[Term Filter]
@ -408,7 +408,7 @@ FilterBuilders.termFilter("user", "kimchy");
Note that you can ask not to cache the result using Note that you can ask not to cache the result using
`TermFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `TermFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Terms Filter === Terms Filter
See link:{ref}/query-dsl-terms-filter.html[Terms Filter] See link:{ref}/query-dsl-terms-filter.html[Terms Filter]
@ -424,7 +424,7 @@ FilterBuilders.termsFilter("user", "kimchy", "elasticsearch")
Note that you can ask not to cache the result using Note that you can ask not to cache the result using
`TermsFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `TermsFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[float]
=== Nested Filter === Nested Filter
See link:{ref}/query-dsl-nested-filter.html[Nested Filter] See link:{ref}/query-dsl-nested-filter.html[Nested Filter]
@ -443,7 +443,7 @@ Note that you can ask not to cache the result using
`NestedFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>. `NestedFilterBuilder#cache(boolean)` method. See <<query-dsl-filters-caching>>.
[[query-dsl-filters-caching]] [[query-dsl-filters-caching]]
[float]
=== Caching === Caching
By default, some filters are cached or not cached. You can have a fine By default, some filters are cached or not cached. You can have a fine

54
docs/java-api/query-dsl-queries.asciidoc
View File

@ -21,7 +21,7 @@ Note that you can easily print (aka debug) JSON generated queries using
The `QueryBuilder` can then be used with any API that accepts a query, The `QueryBuilder` can then be used with any API that accepts a query,
such as `count` and `search`. such as `count` and `search`.
[float]
=== Match Query === Match Query
See link:{ref}/query-dsl-match-query.html[Match Query] See link:{ref}/query-dsl-match-query.html[Match Query]
@ -32,7 +32,7 @@ See link:{ref}/query-dsl-match-query.html[Match Query]
QueryBuilder qb = QueryBuilders.matchQuery("name", "kimchy elasticsearch"); QueryBuilder qb = QueryBuilders.matchQuery("name", "kimchy elasticsearch");
-------------------------------------------------- --------------------------------------------------
[float]
=== MultiMatch Query === MultiMatch Query
See link:{ref}/query-dsl-multi-match-query.html[MultiMatch See link:{ref}/query-dsl-multi-match-query.html[MultiMatch
@ -46,7 +46,7 @@ QueryBuilder qb = QueryBuilders.multiMatchQuery(
); );
-------------------------------------------------- --------------------------------------------------
[float]
=== Boolean Query === Boolean Query
See link:{ref}/query-dsl-bool-query.html[Boolean Query] See link:{ref}/query-dsl-bool-query.html[Boolean Query]
@ -62,7 +62,7 @@ QueryBuilder qb = QueryBuilders
.should(termQuery("content", "test3")); .should(termQuery("content", "test3"));
-------------------------------------------------- --------------------------------------------------
[float]
=== Boosting Query === Boosting Query
See link:{ref}/query-dsl-boosting-query.html[Boosting Query] See link:{ref}/query-dsl-boosting-query.html[Boosting Query]
@ -76,7 +76,7 @@ QueryBuilders.boostingQuery()
.negativeBoost(0.2f); .negativeBoost(0.2f);
-------------------------------------------------- --------------------------------------------------
[float]
=== IDs Query === IDs Query
See link:{ref}/query-dsl-ids-query.html[IDs Query] See link:{ref}/query-dsl-ids-query.html[IDs Query]
@ -87,7 +87,7 @@ See link:{ref}/query-dsl-ids-query.html[IDs Query]
QueryBuilders.idsQuery().ids("1", "2"); QueryBuilders.idsQuery().ids("1", "2");
-------------------------------------------------- --------------------------------------------------
[float]
=== Custom Score Query === Custom Score Query
See link:{ref}/query-dsl-custom-score-query.html[Custom Score See link:{ref}/query-dsl-custom-score-query.html[Custom Score
@ -105,7 +105,7 @@ QueryBuilders.customScoreQuery(QueryBuilders.matchAllQuery())
.param("param2", 3.1); .param("param2", 3.1);
-------------------------------------------------- --------------------------------------------------
[float]
=== Custom Boost Factor Query === Custom Boost Factor Query
See See
@ -118,7 +118,7 @@ QueryBuilders.customBoostFactorQuery(QueryBuilders.matchAllQuery()) // Your quer
.boostFactor(3.1f); .boostFactor(3.1f);
-------------------------------------------------- --------------------------------------------------
[float]
=== Constant Score Query === Constant Score Query
See link:{ref}/query-dsl-constant-score-query.html[Constant See link:{ref}/query-dsl-constant-score-query.html[Constant
@ -135,7 +135,7 @@ QueryBuilders.constantScoreQuery(QueryBuilders.termQuery("name","kimchy"))
.boost(2.0f); .boost(2.0f);
-------------------------------------------------- --------------------------------------------------
[float]
=== Disjunction Max Query === Disjunction Max Query
See link:{ref}/query-dsl-dis-max-query.html[Disjunction Max See link:{ref}/query-dsl-dis-max-query.html[Disjunction Max
@ -150,7 +150,7 @@ QueryBuilders.disMaxQuery()
.tieBreaker(0.7f); .tieBreaker(0.7f);
-------------------------------------------------- --------------------------------------------------
[float]
=== Field Query === Field Query
See link:{ref}/query-dsl-field-query.html[Field Query] See link:{ref}/query-dsl-field-query.html[Field Query]
@ -164,7 +164,7 @@ QueryBuilders.fieldQuery("name", "+kimchy -dadoonet");
QueryBuilders.queryString("+kimchy -dadoonet").field("name"); QueryBuilders.queryString("+kimchy -dadoonet").field("name");
-------------------------------------------------- --------------------------------------------------
[float]
=== Fuzzy Like This (Field) Query (flt and flt_field) === Fuzzy Like This (Field) Query (flt and flt_field)
See: See:
@ -185,7 +185,7 @@ QueryBuilders.fuzzyLikeThisFieldQuery("name.first") // Only on singl
.maxQueryTerms(12); .maxQueryTerms(12);
-------------------------------------------------- --------------------------------------------------
[float]
=== FuzzyQuery === FuzzyQuery
See link:{ref}/query-dsl-fuzzy-query.html[Fuzzy Query] See link:{ref}/query-dsl-fuzzy-query.html[Fuzzy Query]
@ -196,7 +196,7 @@ See link:{ref}/query-dsl-fuzzy-query.html[Fuzzy Query]
QueryBuilder qb = QueryBuilders.fuzzyQuery("name", "kimzhy"); QueryBuilder qb = QueryBuilders.fuzzyQuery("name", "kimzhy");
-------------------------------------------------- --------------------------------------------------
[float]
=== Has Child / Has Parent === Has Child / Has Parent
See: See:
@ -214,7 +214,7 @@ QueryBuilders.hasParentQuery("blog",
QueryBuilders.termQuery("tag","something")); QueryBuilders.termQuery("tag","something"));
-------------------------------------------------- --------------------------------------------------
[float]
=== MatchAll Query === MatchAll Query
See link:{ref}/query-dsl-match-all-query.html[Match All See link:{ref}/query-dsl-match-all-query.html[Match All
@ -225,7 +225,7 @@ Query]
QueryBuilder qb = QueryBuilders.matchAllQuery(); QueryBuilder qb = QueryBuilders.matchAllQuery();
-------------------------------------------------- --------------------------------------------------
[float]
=== Fuzzy Like This (Field) Query (flt and flt_field) === Fuzzy Like This (Field) Query (flt and flt_field)
See: See:
@ -248,7 +248,7 @@ QueryBuilders.moreLikeThisFieldQuery("name.first") // Only on singl
.maxQueryTerms(12); .maxQueryTerms(12);
-------------------------------------------------- --------------------------------------------------
[float]
=== Prefix Query === Prefix Query
See link:{ref}/query-dsl-prefix-query.html[Prefix Query] See link:{ref}/query-dsl-prefix-query.html[Prefix Query]
@ -258,7 +258,7 @@ See link:{ref}/query-dsl-prefix-query.html[Prefix Query]
QueryBuilders.prefixQuery("brand", "heine"); QueryBuilders.prefixQuery("brand", "heine");
-------------------------------------------------- --------------------------------------------------
[float]
=== QueryString Query === QueryString Query
See link:{ref}/query-dsl-query-string-query.html[QueryString Query] See link:{ref}/query-dsl-query-string-query.html[QueryString Query]
@ -268,7 +268,7 @@ See link:{ref}/query-dsl-query-string-query.html[QueryString Query]
QueryBuilder qb = QueryBuilders.queryString("+kimchy -elasticsearch"); QueryBuilder qb = QueryBuilders.queryString("+kimchy -elasticsearch");
-------------------------------------------------- --------------------------------------------------
[float]
=== Range Query === Range Query
See link:{ref}/query-dsl-range-query.html[Range Query] See link:{ref}/query-dsl-range-query.html[Range Query]
@ -283,7 +283,7 @@ QueryBuilder qb = QueryBuilders
.includeUpper(false); .includeUpper(false);
-------------------------------------------------- --------------------------------------------------
[float]
=== Span Queries (first, near, not, or, term) === Span Queries (first, near, not, or, term)
See: See:
@ -325,7 +325,7 @@ QueryBuilders.spanOrQuery()
QueryBuilders.spanTermQuery("user","kimchy"); QueryBuilders.spanTermQuery("user","kimchy");
-------------------------------------------------- --------------------------------------------------
[float]
=== Term Query === Term Query
See link:{ref}/query-dsl-term-query.html[Term Query] See link:{ref}/query-dsl-term-query.html[Term Query]
@ -335,7 +335,7 @@ See link:{ref}/query-dsl-term-query.html[Term Query]
QueryBuilder qb = QueryBuilders.termQuery("name", "kimchy"); QueryBuilder qb = QueryBuilders.termQuery("name", "kimchy");
-------------------------------------------------- --------------------------------------------------
[float]
=== Terms Query === Terms Query
See link:{ref}/query-dsl-terms-query.html[Terms Query] See link:{ref}/query-dsl-terms-query.html[Terms Query]
@ -347,7 +347,7 @@ QueryBuilders.termsQuery("tags", // field
.minimumMatch(1); // How many terms must match .minimumMatch(1); // How many terms must match
-------------------------------------------------- --------------------------------------------------
[float]
=== Top Children Query === Top Children Query
See link:{ref}/query-dsl-top-children-query.html[Top Children Query] See link:{ref}/query-dsl-top-children-query.html[Top Children Query]
@ -363,7 +363,7 @@ QueryBuilders.topChildrenQuery(
.incrementalFactor(2); .incrementalFactor(2);
-------------------------------------------------- --------------------------------------------------
[float]
=== Wildcard Query === Wildcard Query
See link:{ref}/query-dsl-wildcard-query.html[Wildcard Query] See link:{ref}/query-dsl-wildcard-query.html[Wildcard Query]
@ -374,7 +374,7 @@ See link:{ref}/query-dsl-wildcard-query.html[Wildcard Query]
QueryBuilders.wildcardQuery("user", "k?mc*"); QueryBuilders.wildcardQuery("user", "k?mc*");
-------------------------------------------------- --------------------------------------------------
[float]
=== Nested Query === Nested Query
See link:{ref}/query-dsl-nested-query.html[Nested Query] See link:{ref}/query-dsl-nested-query.html[Nested Query]
@ -390,7 +390,7 @@ QueryBuilders.nestedQuery("obj1", // Path
.scoreMode("avg"); // max, total, avg or none .scoreMode("avg"); // max, total, avg or none
-------------------------------------------------- --------------------------------------------------
[float]
=== Custom Filters Score Query === Custom Filters Score Query
See See
@ -406,7 +406,7 @@ QueryBuilders.customFiltersScoreQuery(
.scoreMode("first"); // first, min, max, total, avg or multiply .scoreMode("first"); // first, min, max, total, avg or multiply
-------------------------------------------------- --------------------------------------------------
[float]
=== Indices Query === Indices Query
See link:{ref}/query-dsl-indices-query.html[Indices Query] See link:{ref}/query-dsl-indices-query.html[Indices Query]
@ -429,7 +429,7 @@ QueryBuilders.indicesQuery(
.noMatchQuery("all"); // all or none .noMatchQuery("all"); // all or none
-------------------------------------------------- --------------------------------------------------
[float]
=== GeoShape Query === GeoShape Query
See link:{ref}/query-dsl-geo-shape-query.html[GeoShape Query] See link:{ref}/query-dsl-geo-shape-query.html[GeoShape Query]

8
docs/java-api/search.asciidoc
View File

@ -41,7 +41,7 @@ SearchResponse response = client.prepareSearch().execute().actionGet();
For more information on the search operation, check out the REST For more information on the search operation, check out the REST
link:{ref}/search.html[search] docs. link:{ref}/search.html[search] docs.
[float]
=== Using scrolls in Java === Using scrolls in Java
Read the link:{ref}/search-request-scroll.html[scroll documentation] Read the link:{ref}/search-request-scroll.html[scroll documentation]
@ -72,7 +72,7 @@ while (true) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
=== Operation Threading === Operation Threading
The search API allows to set the threading model the operation will be The search API allows to set the threading model the operation will be
@ -89,7 +89,7 @@ thread for each local shard.
The default mode is `SINGLE_THREAD`. The default mode is `SINGLE_THREAD`.
[float]
=== MultiSearch API === MultiSearch API
See link:{ref}/search-multi-search.html[MultiSearch API Query] See link:{ref}/search-multi-search.html[MultiSearch API Query]
@ -115,7 +115,7 @@ for (MultiSearchResponse.Item item : sr.responses()) {
} }
-------------------------------------------------- --------------------------------------------------
[float]
=== Using Facets === Using Facets
The following code shows how to add two facets within your search: The following code shows how to add two facets within your search:

6
docs/river/index.asciidoc
View File

@ -13,7 +13,7 @@ that it is running). The name uniquely identifies the river within the
cluster. For example, one can run a river called `my_river` with type cluster. For example, one can run a river called `my_river` with type
`dummy`, and another river called `my_other_river` with type `dummy`. `dummy`, and another river called `my_other_river` with type `dummy`.
[float]
== How it Works == How it Works
A river instance (and its name) is a type within the `_river` index. All A river instance (and its name) is a type within the `_river` index. All
@ -43,7 +43,7 @@ associated with it):
curl -XDELETE 'localhost:9200/_river/my_river/' curl -XDELETE 'localhost:9200/_river/my_river/'
-------------------------------------------------- --------------------------------------------------
[float]
== Cluster Allocation == Cluster Allocation
Rivers are singletons within the cluster. They get allocated Rivers are singletons within the cluster. They get allocated
@ -56,7 +56,7 @@ it. The `node.river` can also include a comma separated list of either
river names or types controlling the rivers allowed to run on it. For river names or types controlling the rivers allowed to run on it. For
example: `my_river1,my_river2`, or `dummy,twitter`. example: `my_river1,my_river2`, or `dummy,twitter`.
[float]
== Status == Status
Each river (regardless of the implementation) exposes a high level Each river (regardless of the implementation) exposes a high level