From 6171ae6cc4a8668c0b1528876e15ea4624688434 Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Sun, 24 May 2015 17:57:34 +0200 Subject: [PATCH] Docs: Added stub entries for pages deleted from 1.x --- docs/reference/index.asciidoc | 3 + docs/reference/query-dsl/index.asciidoc | 4 + docs/reference/query-dsl/match-query.asciidoc | 36 +- docs/reference/redirects.asciidoc | 368 ++++++++++++++++++ docs/reference/setup.asciidoc | 27 +- 5 files changed, 424 insertions(+), 14 deletions(-) create mode 100644 docs/reference/redirects.asciidoc diff --git a/docs/reference/index.asciidoc b/docs/reference/index.asciidoc index bc1a381067f..526a6519892 100644 --- a/docs/reference/index.asciidoc +++ b/docs/reference/index.asciidoc @@ -40,5 +40,8 @@ include::testing.asciidoc[] include::glossary.asciidoc[] +include::redirects.asciidoc[] + + diff --git a/docs/reference/query-dsl/index.asciidoc b/docs/reference/query-dsl/index.asciidoc index 026c80f559a..d2fa27c719b 100644 --- a/docs/reference/query-dsl/index.asciidoc +++ b/docs/reference/query-dsl/index.asciidoc @@ -14,6 +14,8 @@ include::constant-score-query.asciidoc[] include::dis-max-query.asciidoc[] +include::exists-query.asciidoc[] + include::filtered-query.asciidoc[] include::function-score-query.asciidoc[] @@ -44,6 +46,8 @@ include::limit-query.asciidoc[] include::match-all-query.asciidoc[] +include::missing-query.asciidoc[] + include::mlt-query.asciidoc[] include::nested-query.asciidoc[] diff --git a/docs/reference/query-dsl/match-query.asciidoc b/docs/reference/query-dsl/match-query.asciidoc index 8925f2904a3..986228ce4eb 100644 --- a/docs/reference/query-dsl/match-query.asciidoc +++ b/docs/reference/query-dsl/match-query.asciidoc @@ -17,10 +17,11 @@ Note, `message` is the name of a field, you can substitute the name of any field (including `_all`) instead. [float] -==== Types of Match Queries +=== Types of Match Queries [float] -===== boolean +[[query-dsl-match-query-boolean]] +==== boolean The default `match` query is of type `boolean`. It means that the text provided is analyzed and the analysis process constructs a boolean query @@ -34,6 +35,14 @@ The `analyzer` can be set to control which analyzer will perform the analysis process on the text. It defaults to the field explicit mapping definition, or the default search analyzer. +The `lenient` parameter can be set to `true` to ignore exceptions caused by +data-type mismatches, such as trying to query a numeric field with a text +query string. Defaults to `false`. + +[[query-dsl-match-query-fuzziness]] +[float] +===== Fuzziness + `fuzziness` allows _fuzzy matching_ based on the type of field being queried. See <> for allowed settings. @@ -59,7 +68,9 @@ change in structure, `message` is the field name): } -------------------------------------------------- -.zero_terms_query +[[query-dsl-match-query-zero]] +[float] +===== Zero terms query If the analyzer used removes all tokens in a query like a `stop` filter does, the default behavior is to match no documents at all. In order to change that the `zero_terms_query` option can be used, which accepts @@ -78,7 +89,10 @@ change that the `zero_terms_query` option can be used, which accepts } -------------------------------------------------- -.cutoff_frequency +[[query-dsl-match-query-cutoff]] +[float] +===== Cutoff frequency + The match query supports a `cutoff_frequency` that allows specifying an absolute or relative document frequency where high frequency terms are moved into an optional subquery and are only scored @@ -117,8 +131,9 @@ IMPORTANT: The `cutoff_frequency` option operates on a per-shard-level. This mea that when trying it out on test indexes with low document numbers you should follow the advice in {defguide}/relevance-is-broken.html[Relevance is broken]. +[[query-dsl-match-query-phrase]] [float] -===== phrase +==== phrase The `match_phrase` query analyzes the text and creates a `phrase` query out of the analyzed text. For example: @@ -167,6 +182,7 @@ definition, or the default search analyzer, for example: -------------------------------------------------- [float] +[[query-dsl-match-query-phrase-prefix]] ===== match_phrase_prefix The `match_phrase_prefix` is the same as `match_phrase`, except that it @@ -213,8 +229,8 @@ For example: } -------------------------------------------------- -[float] -==== Comparison to query_string / field +.Comparison to query_string / field +************************************************** The match family of queries does not go through a "query parsing" process. It does not support field name prefixes, wildcard characters, @@ -225,8 +241,4 @@ usually what a text search box does). Also, the `phrase_prefix` type can provide a great "as you type" behavior to automatically load search results. -[float] -==== Other options - -* `lenient` - If set to true will cause format based failures (like -providing text to a numeric field) to be ignored. Defaults to false. +************************************************** diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc new file mode 100644 index 00000000000..ac65c657842 --- /dev/null +++ b/docs/reference/redirects.asciidoc @@ -0,0 +1,368 @@ +["appendix",role="exclude",id="redirects"] += Deleted pages + +The following pages have moved or been deleted. + +[role="exclude",id="cluster-nodes-shutdown"] +=== Nodes shutdown + +The `_shutdown` API has been removed. Instead, setup Elasticsearch to run as +a service (see <> or <>) or use the `-p` +command line option to <>. + +[role="exclude",id="docs-bulk-udp"] +=== Bulk UDP API + +The Bulk UDP services has been removed. Use the standard <> instead. + +[role="exclude",id="indices-delete-mapping"] +=== Delete Mapping + +It is no longer possible to delete the mapping for a type. Instead you should +<> and recreate it with the new mappings. + +[role="exclude",id="indices-status"] +=== Index Status + +The index `_status` API has been replaced with the <> and +<> APIs. + +[role="exclude",id="mapping-analyzer-field"] +=== `_analyzer` + +The `_analyzer` field in type mappings is no longer supported and will be +automatically removed from mappings when upgrading to 2.x. + +[role="exclude",id="mapping-boost-field"] +=== `_boost` + +The `_boost` field in type mappings is no longer supported and will be +automatically removed from mappings when upgrading to 2.x. + +[role="exclude",id="mapping-conf-mappings"] +=== Config mappings + +It is no longer possible to specify mappings in files in the `config` +directory. Instead, mappings should be created using the API with: + +* <> +* <> +* <> + +[role="exclude",id="modules-memcached"] +=== memcached + +The `memcached` transport is no longer supported. Instead use the REST +interface over <> or the +https://www.elastic.co/guide/en/elasticsearch/client/java-api/current/index.html[Java API]. + +[role="exclude",id="modules-thrift"] +=== Thrift + +The `thrift` transport is no longer supported. Instead use the REST +interface over <> or the +https://www.elastic.co/guide/en/elasticsearch/client/java-api/current/index.html[Java API]. + +// QUERY DSL + +[role="exclude",id="query-dsl-queries"] +=== Queries + +Queries and filters have been merged. Any query clause can now be used as a query +in ``query context'' and as a filter in ``filter context'' (see <>). + +[role="exclude",id="query-dsl-filters"] +=== Filters + +Queries and filters have been merged. Any query clause can now be used as a query +in ``query context'' and as a filter in ``filter context'' (see <>). + +[role="exclude",id="query-dsl-and-filter"] +=== And Filter + +The `and` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-or-filter"] +=== Or Filter + +The `or` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-not-filter"] +=== Not Filter + +The `not` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-bool-filter"] +=== Bool Filter + +The `bool` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-exists-filter"] +=== Exists Filter + +The `exists` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-missing-filter"] +=== Missing Filter + +The `missing` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + + +[role="exclude",id="query-dsl-geo-bounding-box-filter"] +=== Geo Bounding Box Filter + +The `geo_bounding_box` filter has been replaced by the <>. +It behaves as a query in ``query context'' and as a filter in ``filter +context'' (see <>). + +[role="exclude",id="query-dsl-geo-distance-filter"] +=== Geo Distance Filter + +The `geo_distance` filter has been replaced by the <>. +It behaves as a query in ``query context'' and as a filter in ``filter +context'' (see <>). + +[role="exclude",id="query-dsl-geo-distance-range-filter"] +=== Geo Distance Range Filter + +The `geo_distance_range` filter has been replaced by the <>. +It behaves as a query in ``query context'' and as a filter in ``filter +context'' (see <>). + +[role="exclude",id="query-dsl-geo-polygon-filter"] +=== Geo Polygon Filter + +The `geo_polygon` filter has been replaced by the <>. +It behaves as a query in ``query context'' and as a filter in ``filter +context'' (see <>). + +[role="exclude",id="query-dsl-geo-shape-filter"] +=== Geo Shape Filter + +The `geo_shape` filter has been replaced by the <>. +It behaves as a query in ``query context'' and as a filter in ``filter +context'' (see <>). + +[role="exclude",id="query-dsl-geohash-cell-filter"] +=== Geohash Cell Filter + +The `geohash_cell` filter has been replaced by the <>. +It behaves as a query in ``query context'' and as a filter in ``filter +context'' (see <>). + +[role="exclude",id="query-dsl-has-child-filter"] +=== Has Child Filter + +The `has_child` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-has-parent-filter"] +=== Has Parent Filter + +The `has_parent` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-top-children-query"] +=== Top Children Query + +The `top_children` query has been removed. Use the <> instead. + +[role="exclude",id="query-dsl-ids-filter"] +=== IDs Filter + +The `ids` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-indices-filter"] +=== Indices Filter + +The `indices` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-limit-filter"] +=== Limit Filter + +The `limit` filter has been replaced by the <>. +It behaves as a query in ``query context'' and as a filter in ``filter +context'' (see <>). + +[role="exclude",id="query-dsl-match-all-filter"] +=== Match All Filter + +The `match_all` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-nested-filter"] +=== Nested Filter + +The `nested` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-prefix-filter"] +=== Prefix Filter + +The `prefix` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-query-filter"] +=== Query Filter + +The `query` filter has been removed as queries and filters have been merged (see +<>). + +[role="exclude",id="query-dsl-range-filter"] +=== Range Filter + +The `range` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-regexp-filter"] +=== Regexp Filter + +The `regexp` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-script-filter"] +=== Script Filter + +The `script` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-term-filter"] +=== Term Filter + +The `term` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-terms-filter"] +=== Terms Filter + +The `terms` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-type-filter"] +=== Type Filter + +The `type` filter has been replaced by the <>. It behaves +as a query in ``query context'' and as a filter in ``filter context'' (see +<>). + +[role="exclude",id="query-dsl-flt-query"] +=== Fuzzy Like This Query + +The `fuzzy_like_this` or `flt` query has been removed. Instead use +the <> parameter with the +<> or the <>. + + +[role="exclude",id="query-dsl-flt-field-query"] +=== Fuzzy Like This Field Query + +The `fuzzy_like_this_field` or `flt_field` query has been removed. Instead use +the <> parameter with the +<> or the <>. + +[role="exclude",id="search-more-like-this"] +=== More Like This API + +The More Like This API has been removed. Instead, use the <>. + +// FACETS + +[role="exclude",id="search-facets-filter-facet"] +=== Filter Facet + +Facets have been removed. Use the +<> or +<> instead. + +[role="exclude",id="search-facets-query-facet"] +=== Query Facet + +Facets have been removed. Use the +<> or +<> instead. + +[role="exclude",id="search-facets-geo-distance-facet"] +=== Geo Distance Facet + +Facets have been removed. Use the +<> instead. + +[role="exclude",id="search-facets-histogram-facet"] +=== Histogram Facet + +Facets have been removed. Use the +<> instead. + +[role="exclude",id="search-facets-date-histogram-facet"] +=== Date Histogram Facet + +Facets have been removed. Use the +<> instead. + +[role="exclude",id="search-facets-range-facet"] +=== Range Facet + +Facets have been removed. Use the +<> instead. + +[role="exclude",id="search-facets-terms-facet"] +=== Terms Facet + +Facets have been removed. Use the +<> instead. + +[role="exclude",id="search-facets-terms-statistical-facet"] +=== Terms Stats Facet + +Facets have been removed. Use the +<> +with the <> +or the <> +instead. + +[role="exclude",id="search-facets-statistical-facet"] +=== Statistical Facet + +Facets have been removed. Use the +<> +or the <> instead. + +[role="exclude",id="search-facets-migrating-to-aggs"] +=== Migrating from facets to aggregations + +Facets have been removed. Use <> instead. + + + + + + + + + diff --git a/docs/reference/setup.asciidoc b/docs/reference/setup.asciidoc index f0d8fdff4d3..10388054e22 100644 --- a/docs/reference/setup.asciidoc +++ b/docs/reference/setup.asciidoc @@ -14,7 +14,7 @@ See <>. [float] == Installation -After link:/download[downloading] the latest release and extracting it, +After link:/downloads/elasticsearch[downloading] the latest release and extracting it, *elasticsearch* can be started using: [source,sh] @@ -22,7 +22,12 @@ After link:/download[downloading] the latest release and extracting it, $ bin/elasticsearch -------------------------------------------------- -Under *nix system, the command will start the process in the foreground. +On *nix systems, the command will start the process in the foreground. + +[[setup-installation-daemon]] +[float] +=== Running as a daemon + To run it in the background, add the `-d` switch to it: [source,sh] @@ -30,6 +35,24 @@ To run it in the background, add the `-d` switch to it: $ bin/elasticsearch -d -------------------------------------------------- +[[setup-installation-pid]] +[float] +=== PID + +The Elasticsearch process can write its PID to a specified file on startup, +making it easy to shut down the process later on: + +[source,sh] +-------------------------------------------------- +$ bin/elasticsearch -d -p pid <1> +$ kill `cat pid` <2> +-------------------------------------------------- +<1> The PID is written to a file called `pid`. +<2> The `kill` command sends a `TERM` signal to the PID stored in the `pid` file. + +NOTE: The startup scripts provided for <> and <> +take care of starting and stopping the Elasticsearch process for you. + .*NIX ************************************************************************* There are added features when using the `elasticsearch` shell script.