From e6127fc082fb38483681173159208493304a76a0 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Tue, 3 Sep 2013 16:15:07 +0200 Subject: [PATCH] [DOCS] Chunk depth now configurable, so [float] not required --- docs/community/clients.asciidoc | 30 ++++++------ docs/groovy-api/anatomy.asciidoc | 6 +-- docs/groovy-api/client.asciidoc | 2 +- docs/groovy-api/index.asciidoc | 2 +- docs/groovy-api/search.asciidoc | 2 +- docs/java-api/client.asciidoc | 4 +- docs/java-api/count.asciidoc | 2 +- docs/java-api/delete.asciidoc | 2 +- docs/java-api/facets.asciidoc | 60 ++++++++++++------------ docs/java-api/get.asciidoc | 2 +- docs/java-api/index.asciidoc | 2 +- docs/java-api/index_.asciidoc | 14 +++--- docs/java-api/query-dsl-filters.asciidoc | 50 ++++++++++---------- docs/java-api/query-dsl-queries.asciidoc | 54 ++++++++++----------- docs/java-api/search.asciidoc | 8 ++-- docs/river/index.asciidoc | 6 +-- 16 files changed, 123 insertions(+), 123 deletions(-) diff --git a/docs/community/clients.asciidoc b/docs/community/clients.asciidoc index 4ab53ce6eb8..b4c01a08476 100644 --- a/docs/community/clients.asciidoc +++ b/docs/community/clients.asciidoc @@ -1,13 +1,13 @@ [[clients]] == Clients -[float] + === Perl * http://github.com/clintongormley/ElasticSearch.pm[ElasticSearch.pm]: Perl client. -[float] + === Python * http://github.com/aparo/pyes[pyes]: @@ -28,7 +28,7 @@ * http://intridea.github.io/surfiki-refine-elasticsearch/[Surfiki Refine]: Python Map-Reduce engine targeting Elasticsearch indices. -[float] + === Ruby * http://github.com/karmi/tire[Tire]: @@ -43,7 +43,7 @@ * https://github.com/wireframe/elastic_searchable/[elastic_searchable]: Ruby client + Rails integration. -[float] + === PHP * http://github.com/ruflin/Elastica[Elastica]: @@ -54,13 +54,13 @@ * http://github.com/polyfractal/Sherlock[Sherlock]: PHP client, one-to-one mapping with query DSL, fluid interface. -[float] + === Java * https://github.com/searchbox-io/Jest[Jest]: Java Rest client. -[float] + === Javascript * https://github.com/fullscale/elastic.js[Elastic.js]: @@ -72,7 +72,7 @@ * https://github.com/ramv/node-elastical[node-elastical]: Node.js client for the ElasticSearch REST API -[float] + === .Net * https://github.com/Yegoroff/PlainElastic.Net[PlainElastic.Net]: @@ -84,7 +84,7 @@ * https://github.com/medcl/ElasticSearch.Net[ElasticSearch.NET]: .NET client. -[float] + === Scala * https://github.com/sksamuel/elastic4s[elastic4s]: @@ -96,13 +96,13 @@ * https://github.com/bsadeh/scalastic[scalastic]: Scala client. -[float] + === Clojure * http://github.com/clojurewerkz/elastisch[Elastisch]: Clojure client. -[float] + === Go * https://github.com/mattbaird/elastigo[elastigo]: @@ -111,7 +111,7 @@ * https://github.com/belogik/goes[goes]: Go lib. -[float] + === Erlang * http://github.com/tsloughter/erlastic_search[erlastic_search]: @@ -125,13 +125,13 @@ http://github.com/karmi/tire[Tire]. Ready to use in pure Erlang environment. -[float] + === EventMachine * http://github.com/vangberg/em-elasticsearch[em-elasticsearch]: elasticsearch library for eventmachine. -[float] + === Command Line * https://github.com/elasticsearch/es2unix[es2unix]: @@ -140,13 +140,13 @@ * https://github.com/javanna/elasticshell[elasticshell]: command line shell for elasticsearch. -[float] + === OCaml * https://github.com/tovbinm/ocaml-elasticsearch[ocaml-elasticsearch]: OCaml client for Elasticsearch -[float] + === Smalltalk * http://ss3.gemstone.com/ss/Elasticsearch.html[Elasticsearch] - diff --git a/docs/groovy-api/anatomy.asciidoc b/docs/groovy-api/anatomy.asciidoc index 4f0f18b4916..f192b6aab48 100644 --- a/docs/groovy-api/anatomy.asciidoc +++ b/docs/groovy-api/anatomy.asciidoc @@ -5,7 +5,7 @@ Once a <> has been obtained, all of ElasticSearch APIs can be executed on it. Each Groovy API is exposed using three different mechanisms. -[float] + === Closure Request The first type is to simply provide the request as a Closure, which @@ -56,7 +56,7 @@ indexR.failure = {Throwable t -> } -------------------------------------------------- -[float] + === Request 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" -------------------------------------------------- -[float] + === Java Like The last option is to provide an actual instance of the API request, and diff --git a/docs/groovy-api/client.asciidoc b/docs/groovy-api/client.asciidoc index 28d5ba00bf0..4be0e2e6c3b 100644 --- a/docs/groovy-api/client.asciidoc +++ b/docs/groovy-api/client.asciidoc @@ -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 within the cluster. -[float] + === Node Client A Node based client is the simplest form to get a `GClient` to start diff --git a/docs/groovy-api/index.asciidoc b/docs/groovy-api/index.asciidoc index f089642400b..0fea8fe30c6 100644 --- a/docs/groovy-api/index.asciidoc +++ b/docs/groovy-api/index.asciidoc @@ -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 covered in <>. -[float] + ==== Maven Repository The Groovy API is hosted on diff --git a/docs/groovy-api/search.asciidoc b/docs/groovy-api/search.asciidoc index 2e2dadf79f0..5f98e753da2 100644 --- a/docs/groovy-api/search.asciidoc +++ b/docs/groovy-api/search.asciidoc @@ -40,7 +40,7 @@ search.response.hits.each {SearchHit hit -> The format of the search `Closure` follows the same JSON syntax as the link:{ref}/search-search.html[Search API] request. -[float] + === More examples Term query where multiple values are provided (see diff --git a/docs/java-api/client.asciidoc b/docs/java-api/client.asciidoc index f6d80cc5c76..1e4047b2d71 100644 --- a/docs/java-api/client.asciidoc +++ b/docs/java-api/client.asciidoc @@ -28,7 +28,7 @@ and cluster sides. You may hit some incompatibilities issues when mixing major versions. ______________________________________________________________________________________________________________________________________________________________ -[float] + === Node Client Instantiating a node based client is the simplest way to get a `Client` @@ -119,7 +119,7 @@ Client client = node.client(); node.close(); -------------------------------------------------- -[float] + === Transport Client The `TransportClient` connects remotely to an elasticsearch cluster diff --git a/docs/java-api/count.asciidoc b/docs/java-api/count.asciidoc index 8dd75f2c61a..dcf9bdfea96 100644 --- a/docs/java-api/count.asciidoc +++ b/docs/java-api/count.asciidoc @@ -20,7 +20,7 @@ CountResponse response = client.prepareCount("test") For more information on the count operation, check out the REST link:{ref}/search-count.html[count] docs. -[float] + === Operation Threading The count API allows to set the threading model the operation will be diff --git a/docs/java-api/delete.asciidoc b/docs/java-api/delete.asciidoc index 52f245d4478..861db502aa5 100644 --- a/docs/java-api/delete.asciidoc +++ b/docs/java-api/delete.asciidoc @@ -16,7 +16,7 @@ DeleteResponse response = client.prepareDelete("twitter", "tweet", "1") For more information on the delete operation, check out the link:{ref}/docs-delete.html[delete API] docs. -[float] + === Operation Threading The delete API allows to set the threading model the operation will be diff --git a/docs/java-api/facets.asciidoc b/docs/java-api/facets.asciidoc index 4920e3cb043..511cf49a743 100644 --- a/docs/java-api/facets.asciidoc +++ b/docs/java-api/facets.asciidoc @@ -26,17 +26,17 @@ in your class: import org.elasticsearch.search.facet.FacetBuilders.*; -------------------------------------------------- -[float] + === Facets -[float] + ==== Terms Facet Here is how you can use link:{ref}/search-facets-terms-facet.html[Terms Facet] with Java API. -[float] + ===== Prepare facet request Here is an example on how to create the facet request: @@ -48,7 +48,7 @@ FacetBuilders.termsFacet("f") .size(10); -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -74,14 +74,14 @@ for (TermsFacet.Entry entry : f) { } -------------------------------------------------- -[float] + ==== Range Facet Here is how you can use link:{ref}/search-facets-range-facet.html[Range Facet] with Java API. -[float] + ===== Prepare 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 -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -122,14 +122,14 @@ for (RangeFacet.Entry entry : f) { } -------------------------------------------------- -[float] + ==== Histogram Facet Here is how you can use link:{ref}/search-facets-histogram-facet.html[Histogram Facet] with Java API. -[float] + ===== Prepare facet request Here is an example on how to create the facet request: @@ -141,7 +141,7 @@ HistogramFacetBuilder facet = FacetBuilders.histogramFacet("f") .interval(1); -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -163,14 +163,14 @@ for (HistogramFacet.Entry entry : f) { } -------------------------------------------------- -[float] + ==== Date Histogram Facet Here is how you can use link:{ref}/search-facets-date-histogram-facet.html[Date Histogram Facet] with Java API. -[float] + ===== Prepare 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" -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -205,7 +205,7 @@ for (DateHistogramFacet.Entry entry : f) { } -------------------------------------------------- -[float] + ==== Filter Facet (not facet filter) 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 link:#facet-filter[facet filter] using Java API. -[float] + ===== Prepare facet request Here is an example on how to create the facet request: @@ -229,7 +229,7 @@ FacetBuilders.filterFacet("f", See <> to learn how to build filters using Java. -[float] + ===== Use facet response Import Facet definition classes: @@ -247,14 +247,14 @@ FilterFacet f = (FilterFacet) sr.facets().facetsAsMap().get("f"); f.getCount(); // Number of docs that matched -------------------------------------------------- -[float] + ==== Query Facet Here is how you can use link:{ref}/search-facets-query-facet.html[Query Facet] with Java API. -[float] + ===== Prepare facet request Here is an example on how to create the facet request: @@ -265,7 +265,7 @@ FacetBuilders.queryFacet("f", QueryBuilders.matchQuery("brand", "heineken")); -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -286,14 +286,14 @@ f.getCount(); // Number of docs that matched See <> to learn how to build queries using Java. -[float] + ==== Statistical Here is how you can use link:{ref}/search-facets-statistical-facet.html[Statistical Facet] with Java API. -[float] + ===== Prepare facet request Here is an example on how to create the facet request: @@ -304,7 +304,7 @@ FacetBuilders.statisticalFacet("f") .field("price"); -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -329,14 +329,14 @@ f.getSumOfSquares(); // Sum of Squares f.getVariance(); // Variance -------------------------------------------------- -[float] + ==== Terms Stats Facet Here is how you can use link:{ref}/search-facets-terms-stats-facet.html[Terms Stats Facet] with Java API. -[float] + ===== Prepare facet request Here is an example on how to create the facet request: @@ -348,7 +348,7 @@ FacetBuilders.termsStatsFacet("f") .valueField("price"); -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -377,14 +377,14 @@ for (TermsStatsFacet.Entry entry : f) { } -------------------------------------------------- -[float] + ==== Geo Distance Facet Here is how you can use link:{ref}/search-facets-geo-distance-facet.html[Geo Distance Facet] with Java API. -[float] + ===== Prepare 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 -------------------------------------------------- -[float] + ===== Use facet response Import Facet definition classes: @@ -428,7 +428,7 @@ for (GeoDistanceFacet.Entry entry : f) { } -------------------------------------------------- -[float] + === Facet filters (not Filter Facet) 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 <>. -[float] + === Scope By default, facets are computed within the query resultset. But, you can diff --git a/docs/java-api/get.asciidoc b/docs/java-api/get.asciidoc index d83c12f2480..121bb8836dc 100644 --- a/docs/java-api/get.asciidoc +++ b/docs/java-api/get.asciidoc @@ -15,7 +15,7 @@ GetResponse response = client.prepareGet("twitter", "tweet", "1") For more information on the index operation, check out the REST link:{ref}/docs-get.html[get] docs. -[float] + === Operation Threading The get API allows to set the threading model the operation will be diff --git a/docs/java-api/index.asciidoc b/docs/java-api/index.asciidoc index c2e10170e14..70dc66d525c 100644 --- a/docs/java-api/index.asciidoc +++ b/docs/java-api/index.asciidoc @@ -16,7 +16,7 @@ Additionally, operations on a client may be accumulated and executed in Note, all the APIs are exposed through the Java API (actually, the Java API is used internally to execute them). -[float] + == Maven Repository Elasticsearch is hosted on diff --git a/docs/java-api/index_.asciidoc b/docs/java-api/index_.asciidoc index 9b71ab8c92d..58bcb1e3201 100644 --- a/docs/java-api/index_.asciidoc +++ b/docs/java-api/index_.asciidoc @@ -4,7 +4,7 @@ The index API allows one to index a typed JSON document into a specific index and make it searchable. -[float] + === Generate 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 directly constructs a `byte[]`. -[float] + ==== Do It Yourself Nothing really difficult here but note that you will have to encode @@ -40,7 +40,7 @@ String json = "{" + "}"; -------------------------------------------------- -[float] + ==== Using Map 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"); -------------------------------------------------- -[float] + ==== Serialize your beans Elasticsearch already use Jackson but shade it under @@ -87,7 +87,7 @@ ObjectMapper mapper = new ObjectMapper(); // create once, reuse String json = mapper.writeValueAsString(yourbeaninstance); -------------------------------------------------- -[float] + ==== Use Elasticsearch helpers 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(); -------------------------------------------------- -[float] + === Index document The following example indexes a JSON document into an index called @@ -187,7 +187,7 @@ List matches = response.matches(); For more information on the index operation, check out the REST link:{ref}/docs-index_.html[index] docs. -[float] + === Operation Threading The index API allows to set the threading model the operation will be diff --git a/docs/java-api/query-dsl-filters.asciidoc b/docs/java-api/query-dsl-filters.asciidoc index 5b40f07dac4..41edfdbf4fa 100644 --- a/docs/java-api/query-dsl-filters.asciidoc +++ b/docs/java-api/query-dsl-filters.asciidoc @@ -19,7 +19,7 @@ import org.elasticsearch.index.query.FilterBuilders.*; Note that you can easily print (aka debug) JSON generated queries using `toString()` method on `FilterBuilder` object. -[float] + === 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 `AndFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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 `BoolFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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"); -------------------------------------------------- -[float] + === 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"); -------------------------------------------------- -[float] + === 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); -------------------------------------------------- -[float] + === 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"); -------------------------------------------------- -[float] + === Geo Bounding Box Filter 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 <>. -[float] + === GeoDistance Filter 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 <>. -[float] + === Geo Distance Range Filter 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 <>. -[float] + === Geo Polygon Filter 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 <>. -[float] + === Geo Shape Filter 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); -------------------------------------------------- -[float] + === Has Child / Has Parent Filters See: @@ -254,7 +254,7 @@ QFilterBuilders.hasParentFilter("blog", QueryBuilders.termQuery("tag", "something")); -------------------------------------------------- -[float] + === 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(); -------------------------------------------------- -[float] + === Missing Filter See link:{ref}/query-dsl-missing-filter.html[Missing Filter] @@ -277,7 +277,7 @@ FilterBuilders.missingFilter("user") .nullValue(true); -------------------------------------------------- -[float] + === 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")); -------------------------------------------------- -[float] + === Numeric Range Filter 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 <>. -[float] + === 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 `OrFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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 `PrefixFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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 `QueryFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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 `RangeFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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 `ScriptFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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 `TermFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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 `TermsFilterBuilder#cache(boolean)` method. See <>. -[float] + === 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]] -[float] + === Caching By default, some filters are cached or not cached. You can have a fine diff --git a/docs/java-api/query-dsl-queries.asciidoc b/docs/java-api/query-dsl-queries.asciidoc index d5010f2e06e..8ed81c8333c 100644 --- a/docs/java-api/query-dsl-queries.asciidoc +++ b/docs/java-api/query-dsl-queries.asciidoc @@ -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, such as `count` and `search`. -[float] + === 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"); -------------------------------------------------- -[float] + === MultiMatch Query See link:{ref}/query-dsl-multi-match-query.html[MultiMatch @@ -46,7 +46,7 @@ QueryBuilder qb = QueryBuilders.multiMatchQuery( ); -------------------------------------------------- -[float] + === Boolean Query See link:{ref}/query-dsl-bool-query.html[Boolean Query] @@ -62,7 +62,7 @@ QueryBuilder qb = QueryBuilders .should(termQuery("content", "test3")); -------------------------------------------------- -[float] + === Boosting Query See link:{ref}/query-dsl-boosting-query.html[Boosting Query] @@ -76,7 +76,7 @@ QueryBuilders.boostingQuery() .negativeBoost(0.2f); -------------------------------------------------- -[float] + === 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"); -------------------------------------------------- -[float] + === Custom Score Query See link:{ref}/query-dsl-custom-score-query.html[Custom Score @@ -105,7 +105,7 @@ QueryBuilders.customScoreQuery(QueryBuilders.matchAllQuery()) .param("param2", 3.1); -------------------------------------------------- -[float] + === Custom Boost Factor Query See @@ -118,7 +118,7 @@ QueryBuilders.customBoostFactorQuery(QueryBuilders.matchAllQuery()) // Your quer .boostFactor(3.1f); -------------------------------------------------- -[float] + === Constant Score Query See link:{ref}/query-dsl-constant-score-query.html[Constant @@ -135,7 +135,7 @@ QueryBuilders.constantScoreQuery(QueryBuilders.termQuery("name","kimchy")) .boost(2.0f); -------------------------------------------------- -[float] + === Disjunction Max Query See link:{ref}/query-dsl-dis-max-query.html[Disjunction Max @@ -150,7 +150,7 @@ QueryBuilders.disMaxQuery() .tieBreaker(0.7f); -------------------------------------------------- -[float] + === 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"); -------------------------------------------------- -[float] + === Fuzzy Like This (Field) Query (flt and flt_field) See: @@ -185,7 +185,7 @@ QueryBuilders.fuzzyLikeThisFieldQuery("name.first") // Only on singl .maxQueryTerms(12); -------------------------------------------------- -[float] + === FuzzyQuery 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"); -------------------------------------------------- -[float] + === Has Child / Has Parent See: @@ -214,7 +214,7 @@ QueryBuilders.hasParentQuery("blog", QueryBuilders.termQuery("tag","something")); -------------------------------------------------- -[float] + === MatchAll Query See link:{ref}/query-dsl-match-all-query.html[Match All @@ -225,7 +225,7 @@ Query] QueryBuilder qb = QueryBuilders.matchAllQuery(); -------------------------------------------------- -[float] + === Fuzzy Like This (Field) Query (flt and flt_field) See: @@ -248,7 +248,7 @@ QueryBuilders.moreLikeThisFieldQuery("name.first") // Only on singl .maxQueryTerms(12); -------------------------------------------------- -[float] + === 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"); -------------------------------------------------- -[float] + === 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"); -------------------------------------------------- -[float] + === Range Query See link:{ref}/query-dsl-range-query.html[Range Query] @@ -283,7 +283,7 @@ QueryBuilder qb = QueryBuilders .includeUpper(false); -------------------------------------------------- -[float] + === Span Queries (first, near, not, or, term) See: @@ -325,7 +325,7 @@ QueryBuilders.spanOrQuery() QueryBuilders.spanTermQuery("user","kimchy"); -------------------------------------------------- -[float] + === 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"); -------------------------------------------------- -[float] + === 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 -------------------------------------------------- -[float] + === Top Children Query See link:{ref}/query-dsl-top-children-query.html[Top Children Query] @@ -363,7 +363,7 @@ QueryBuilders.topChildrenQuery( .incrementalFactor(2); -------------------------------------------------- -[float] + === 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*"); -------------------------------------------------- -[float] + === 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 -------------------------------------------------- -[float] + === Custom Filters Score Query See @@ -406,7 +406,7 @@ QueryBuilders.customFiltersScoreQuery( .scoreMode("first"); // first, min, max, total, avg or multiply -------------------------------------------------- -[float] + === Indices Query See link:{ref}/query-dsl-indices-query.html[Indices Query] @@ -429,7 +429,7 @@ QueryBuilders.indicesQuery( .noMatchQuery("all"); // all or none -------------------------------------------------- -[float] + === GeoShape Query See link:{ref}/query-dsl-geo-shape-query.html[GeoShape Query] diff --git a/docs/java-api/search.asciidoc b/docs/java-api/search.asciidoc index 110cac954f6..e7ef20780bb 100644 --- a/docs/java-api/search.asciidoc +++ b/docs/java-api/search.asciidoc @@ -41,7 +41,7 @@ SearchResponse response = client.prepareSearch().execute().actionGet(); For more information on the search operation, check out the REST link:{ref}/search.html[search] docs. -[float] + === Using scrolls in Java Read the link:{ref}/search-request-scroll.html[scroll documentation] @@ -72,7 +72,7 @@ while (true) { } -------------------------------------------------- -[float] + === Operation Threading 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`. -[float] + === MultiSearch API See link:{ref}/search-multi-search.html[MultiSearch API Query] @@ -115,7 +115,7 @@ for (MultiSearchResponse.Item item : sr.responses()) { } -------------------------------------------------- -[float] + === Using Facets The following code shows how to add two facets within your search: diff --git a/docs/river/index.asciidoc b/docs/river/index.asciidoc index 0c155ba9d85..620b0fb8e7f 100644 --- a/docs/river/index.asciidoc +++ b/docs/river/index.asciidoc @@ -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 `dummy`, and another river called `my_other_river` with type `dummy`. -[float] + == How it Works 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/' -------------------------------------------------- -[float] + == Cluster Allocation 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 example: `my_river1,my_river2`, or `dummy,twitter`. -[float] + == Status Each river (regardless of the implementation) exposes a high level