From 3f594089c2f091c8fd9cc809b44e2f56072d371e Mon Sep 17 00:00:00 2001 From: Clinton Gormley Date: Mon, 9 May 2016 15:42:23 +0200 Subject: [PATCH] Renamed all AUTOSENSE snippets to CONSOLE (#18210) --- docs/README.asciidoc | 8 ++-- docs/build.gradle | 2 +- docs/plugins/analysis-icu.asciidoc | 16 ++++---- docs/plugins/analysis-kuromoji.asciidoc | 14 +++---- docs/plugins/analysis-phonetic.asciidoc | 2 +- docs/plugins/delete-by-query.asciidoc | 4 +- docs/plugins/lang-javascript.asciidoc | 6 +-- docs/plugins/lang-python.asciidoc | 6 +-- docs/plugins/mapper-attachments.asciidoc | 22 +++++------ docs/plugins/mapper-murmur3.asciidoc | 4 +- docs/plugins/mapper-size.asciidoc | 4 +- docs/plugins/repository-azure.asciidoc | 2 +- docs/plugins/repository-s3.asciidoc | 2 +- docs/plugins/store-smb.asciidoc | 2 +- .../analyzers/pattern-analyzer.asciidoc | 6 +-- docs/reference/cluster/tasks.asciidoc | 14 +++---- docs/reference/docs/index_.asciidoc | 20 +++++----- docs/reference/docs/reindex.asciidoc | 38 +++++++++---------- docs/reference/docs/update-by-query.asciidoc | 28 +++++++------- .../index-modules/allocation/delayed.asciidoc | 6 +-- .../allocation/filtering.asciidoc | 8 ++-- .../allocation/prioritization.asciidoc | 4 +- docs/reference/indices/analyze.asciidoc | 2 +- docs/reference/indices/flush.asciidoc | 10 ++--- docs/reference/indices/put-mapping.asciidoc | 8 ++-- docs/reference/indices/templates.asciidoc | 2 +- docs/reference/ingest.asciidoc | 2 +- docs/reference/ingest/ingest-node.asciidoc | 10 ++--- docs/reference/mapping.asciidoc | 2 +- .../mapping/dynamic-mapping.asciidoc | 4 +- .../mapping/dynamic/default-mapping.asciidoc | 4 +- .../mapping/dynamic/field-mapping.asciidoc | 8 ++-- .../mapping/dynamic/templates.asciidoc | 10 ++--- .../mapping/fields/all-field.asciidoc | 16 ++++---- .../mapping/fields/field-names-field.asciidoc | 2 +- .../mapping/fields/id-field.asciidoc | 2 +- .../mapping/fields/index-field.asciidoc | 2 +- .../mapping/fields/meta-field.asciidoc | 2 +- .../mapping/fields/parent-field.asciidoc | 8 ++-- .../mapping/fields/routing-field.asciidoc | 8 ++-- .../mapping/fields/source-field.asciidoc | 4 +- .../mapping/fields/timestamp-field.asciidoc | 4 +- .../mapping/fields/ttl-field.asciidoc | 4 +- .../mapping/fields/type-field.asciidoc | 2 +- .../mapping/fields/uid-field.asciidoc | 2 +- .../mapping/params/analyzer.asciidoc | 4 +- docs/reference/mapping/params/boost.asciidoc | 6 +-- docs/reference/mapping/params/coerce.asciidoc | 4 +- .../reference/mapping/params/copy-to.asciidoc | 2 +- .../mapping/params/doc-values.asciidoc | 2 +- .../reference/mapping/params/dynamic.asciidoc | 4 +- .../reference/mapping/params/enabled.asciidoc | 4 +- .../mapping/params/fielddata.asciidoc | 2 +- docs/reference/mapping/params/format.asciidoc | 2 +- .../mapping/params/geohash-precision.asciidoc | 2 +- .../mapping/params/geohash-prefix.asciidoc | 2 +- .../reference/mapping/params/geohash.asciidoc | 2 +- .../mapping/params/ignore-above.asciidoc | 2 +- .../mapping/params/ignore-malformed.asciidoc | 4 +- .../mapping/params/include-in-all.asciidoc | 4 +- .../mapping/params/index-options.asciidoc | 2 +- .../reference/mapping/params/lat-lon.asciidoc | 2 +- .../mapping/params/multi-fields.asciidoc | 4 +- docs/reference/mapping/params/norms.asciidoc | 2 +- .../mapping/params/null-value.asciidoc | 2 +- .../params/position-increment-gap.asciidoc | 4 +- .../mapping/params/properties.asciidoc | 4 +- .../mapping/params/search-analyzer.asciidoc | 2 +- .../mapping/params/similarity.asciidoc | 2 +- docs/reference/mapping/params/store.asciidoc | 2 +- .../mapping/params/term-vector.asciidoc | 2 +- docs/reference/mapping/types/array.asciidoc | 2 +- docs/reference/mapping/types/boolean.asciidoc | 4 +- docs/reference/mapping/types/date.asciidoc | 4 +- .../mapping/types/geo-point.asciidoc | 2 +- docs/reference/mapping/types/ip.asciidoc | 2 +- docs/reference/mapping/types/keyword.asciidoc | 2 +- docs/reference/mapping/types/nested.asciidoc | 6 +-- docs/reference/mapping/types/numeric.asciidoc | 2 +- docs/reference/mapping/types/object.asciidoc | 4 +- docs/reference/mapping/types/text.asciidoc | 2 +- .../mapping/types/token-count.asciidoc | 2 +- .../migration/migrate_5_0/mapping.asciidoc | 2 +- .../cluster/allocation_filtering.asciidoc | 4 +- .../modules/cluster/disk_allocator.asciidoc | 2 +- docs/reference/modules/node.asciidoc | 2 +- .../modules/scripting/fields.asciidoc | 6 +-- .../modules/scripting/painless.asciidoc | 16 ++++---- .../modules/scripting/using.asciidoc | 10 ++--- docs/reference/modules/snapshots.asciidoc | 38 +++++++++---------- docs/reference/query-dsl/bool-query.asciidoc | 8 ++-- .../query-dsl/function-score-query.asciidoc | 2 +- docs/reference/query-dsl/term-query.asciidoc | 8 ++-- docs/reference/setup/cluster_restart.asciidoc | 10 ++--- docs/reference/setup/rolling_upgrade.asciidoc | 12 +++--- 95 files changed, 281 insertions(+), 281 deletions(-) diff --git a/docs/README.asciidoc b/docs/README.asciidoc index 7317ce71a82..da07009d13d 100644 --- a/docs/README.asciidoc +++ b/docs/README.asciidoc @@ -3,13 +3,13 @@ Elasticsearch documentation build process. See: https://github.com/elastic/docs -Snippets marked with `// AUTOSENSE` are automatically annotated with "VIEW IN +Snippets marked with `// CONSOLE` are automatically annotated with "VIEW IN SENSE" in the documentation and are automatically tested by the command -`gradle :docs:check`. By default `// AUTOSENSE` snippet runs as its own isolated +`gradle :docs:check`. By default `// CONSOLE` snippet runs as its own isolated test. You can manipulate the test execution in the following ways: * `// TEST`: Explicitly marks a snippet as a test. Snippets marked this way -are tests even if they don't have `// AUTOSENSE`. +are tests even if they don't have `// CONSOLE`. * `// TEST[s/foo/bar/]`: Replace `foo` with `bar` in the test. This should be used sparingly because it makes the test "lie". Sometimes, though, you can use it to make the tests more clear. @@ -22,7 +22,7 @@ are tests even if they don't have `// AUTOSENSE`. tell the story of some use case because it merges the snippets (and thus the use case) into one big test. * `// TEST[skip:reason]`: Skip this test. Replace `reason` with the actual - reason to skip the test. Snippets without `// TEST` or `// AUTOSENSE` aren't + reason to skip the test. Snippets without `// TEST` or `// CONSOLE` aren't considered tests anyway but this is useful for explicitly documenting the reason why the test shouldn't be run. * `// TEST[setup:name]`: Run some setup code before running the snippet. This diff --git a/docs/build.gradle b/docs/build.gradle index be4b10b1010..3858ec1f9fb 100644 --- a/docs/build.gradle +++ b/docs/build.gradle @@ -31,7 +31,7 @@ task listSnippets(type: SnippetsTask) { task listAutoSenseCandidates(type: SnippetsTask) { group 'Docs' - description 'List snippets that probably should be marked // AUTOSENSE' + description 'List snippets that probably should be marked // CONSOLE' perSnippet { if ( it.autoSense // Already marked, nothing to do diff --git a/docs/plugins/analysis-icu.asciidoc b/docs/plugins/analysis-icu.asciidoc index 03d0dc0296c..19b4fdb07cd 100644 --- a/docs/plugins/analysis-icu.asciidoc +++ b/docs/plugins/analysis-icu.asciidoc @@ -81,7 +81,7 @@ PUT icu_sample } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Uses the default `nfkc_cf` normalization. <2> Uses the customized `nfd_normalizer` token filter, which is set to use `nfc` normalization with decomposition. @@ -113,7 +113,7 @@ PUT icu_sample } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE ===== Rules customization @@ -163,7 +163,7 @@ PUT icu_sample POST icu_sample/_analyze?analyzer=my_analyzer&text=Elasticsearch. Wow! -------------------------------------------------- -// AUTOSENSE +// CONSOLE The above `analyze` request returns the following: @@ -230,7 +230,7 @@ PUT icu_sample } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Uses the default `nfkc_cf` normalization. <2> Uses the customized `nfc_normalizer` token filter, which is set to use `nfc` normalization. @@ -264,7 +264,7 @@ PUT icu_sample } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE The ICU folding token filter already does Unicode normalization, so there is no need to use Normalize character or token filter as well. @@ -305,7 +305,7 @@ PUT icu_sample } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [[analysis-icu-collation]] ==== ICU Collation Token Filter @@ -370,7 +370,7 @@ GET _search <3> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `name` field uses the `standard` analyzer, and so support full text queries. <2> The `name.sort` field uses the `keyword` analyzer to preserve the name as @@ -494,7 +494,7 @@ GET icu_sample/_analyze?analyzer=latin } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> This transforms transliterates characters to Latin, and separates accents from their base characters, removes the accents, and then puts the diff --git a/docs/plugins/analysis-kuromoji.asciidoc b/docs/plugins/analysis-kuromoji.asciidoc index ff42287d03f..2d679de07f4 100644 --- a/docs/plugins/analysis-kuromoji.asciidoc +++ b/docs/plugins/analysis-kuromoji.asciidoc @@ -174,7 +174,7 @@ PUT kuromoji_sample POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=東京スカイツリー -------------------------------------------------- -// AUTOSENSE +// CONSOLE The above `analyze` request returns the following: @@ -226,7 +226,7 @@ PUT kuromoji_sample POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=飲み -------------------------------------------------- -// AUTOSENSE +// CONSOLE [source,text] -------------------------------------------------- @@ -285,7 +285,7 @@ PUT kuromoji_sample POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=寿司がおいしいね -------------------------------------------------- -// AUTOSENSE +// CONSOLE [source,text] -------------------------------------------------- @@ -359,7 +359,7 @@ POST kuromoji_sample/_analyze?analyzer=katakana_analyzer&text=寿司 <1> POST kuromoji_sample/_analyze?analyzer=romaji_analyzer&text=寿司 <2> -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Returns `スシ`. <2> Returns `sushi`. @@ -410,7 +410,7 @@ POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=コピー <1> POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=サーバー <2> -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Returns `コピー`. <2> Return `サーバ`. @@ -456,7 +456,7 @@ PUT kuromoji_sample POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=ストップは消える -------------------------------------------------- -// AUTOSENSE +// CONSOLE The above request returns: @@ -503,7 +503,7 @@ PUT kuromoji_sample POST kuromoji_sample/_analyze?analyzer=my_analyzer&text=一〇〇〇 -------------------------------------------------- -// AUTOSENSE +// CONSOLE [source,text] -------------------------------------------------- diff --git a/docs/plugins/analysis-phonetic.asciidoc b/docs/plugins/analysis-phonetic.asciidoc index f4a9684519d..a0055ef5d69 100644 --- a/docs/plugins/analysis-phonetic.asciidoc +++ b/docs/plugins/analysis-phonetic.asciidoc @@ -81,7 +81,7 @@ PUT phonetic_sample POST phonetic_sample/_analyze?analyzer=my_analyzer&text=Joe Bloggs <1> -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Returns: `J`, `joe`, `BLKS`, `bloggs` diff --git a/docs/plugins/delete-by-query.asciidoc b/docs/plugins/delete-by-query.asciidoc index 643dbfed8b3..aebc0dd7433 100644 --- a/docs/plugins/delete-by-query.asciidoc +++ b/docs/plugins/delete-by-query.asciidoc @@ -58,7 +58,7 @@ a parameter: -------------------------------------------------- DELETE /twitter/tweet/_query?q=user:kimchy -------------------------------------------------- -// AUTOSENSE +// CONSOLE or using the {ref}/query-dsl.html[Query DSL] defined within the request body: @@ -73,7 +73,7 @@ DELETE /twitter/tweet/_query } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The query must be passed as a value to the `query` key, in the same way as the {ref}/search-search.html[search api]. diff --git a/docs/plugins/lang-javascript.asciidoc b/docs/plugins/lang-javascript.asciidoc index 856e4bf4f03..3877fb38d67 100644 --- a/docs/plugins/lang-javascript.asciidoc +++ b/docs/plugins/lang-javascript.asciidoc @@ -82,7 +82,7 @@ GET test/_search } } ---- -// AUTOSENSE +// CONSOLE [[lang-javascript-stored]] [float] @@ -131,7 +131,7 @@ GET test/_search } ---- -// AUTOSENSE +// CONSOLE <1> We store the script under the id `my_script`. <2> The function score query retrieves the script with id `my_script`. @@ -187,7 +187,7 @@ GET test/_search } ---- -// AUTOSENSE +// CONSOLE <1> The function score query retrieves the script with filename `my_script.javascript`. diff --git a/docs/plugins/lang-python.asciidoc b/docs/plugins/lang-python.asciidoc index 49494828b13..070ed3eb6a9 100644 --- a/docs/plugins/lang-python.asciidoc +++ b/docs/plugins/lang-python.asciidoc @@ -81,7 +81,7 @@ GET test/_search } } ---- -// AUTOSENSE +// CONSOLE [[lang-python-stored]] [float] @@ -130,7 +130,7 @@ GET test/_search } ---- -// AUTOSENSE +// CONSOLE <1> We store the script under the id `my_script`. <2> The function score query retrieves the script with id `my_script`. @@ -186,7 +186,7 @@ GET test/_search } ---- -// AUTOSENSE +// CONSOLE <1> The function score query retrieves the script with filename `my_script.py`. diff --git a/docs/plugins/mapper-attachments.asciidoc b/docs/plugins/mapper-attachments.asciidoc index 1da99ee3531..70d760e00b8 100644 --- a/docs/plugins/mapper-attachments.asciidoc +++ b/docs/plugins/mapper-attachments.asciidoc @@ -51,7 +51,7 @@ POST /trying-out-mapper-attachments "cv": { "type": "attachment" } }}}} -------------------------- -// AUTOSENSE +// CONSOLE Index a new document populated with a `base64`-encoded attachment: @@ -62,7 +62,7 @@ POST /trying-out-mapper-attachments/person/1 "cv": "e1xydGYxXGFuc2kNCkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0DQpccGFyIH0=" } -------------------------- -// AUTOSENSE +// CONSOLE Search for the document using words in the attachment: @@ -75,7 +75,7 @@ POST /trying-out-mapper-attachments/person/_search "query": "ipsum" }}} -------------------------- -// AUTOSENSE +// CONSOLE If you get a hit for your indexed document, the plugin should be installed and working. @@ -96,7 +96,7 @@ PUT /test/person/_mapping } } -------------------------- -// AUTOSENSE +// CONSOLE In this case, the JSON to index can be: @@ -107,7 +107,7 @@ PUT /test/person/1 "my_attachment" : "... base64 encoded attachment ..." } -------------------------- -// AUTOSENSE +// CONSOLE Or it is possible to use more elaborated JSON if content type, resource name or language need to be set explicitly: @@ -123,7 +123,7 @@ PUT /test/person/1 } } -------------------------- -// AUTOSENSE +// CONSOLE The `attachment` type not only indexes the content of the doc in `content` sub field, but also automatically adds meta data on the attachment as well (when available). @@ -167,7 +167,7 @@ PUT /test/person/_mapping } } -------------------------- -// AUTOSENSE +// CONSOLE In the above example, the actual content indexed is mapped under `fields` name `content`, and we decide not to index it, so it will only be available in the `_all` field. The other fields map to their respective metadata names, but there is no @@ -201,7 +201,7 @@ PUT /test/person/_mapping } } -------------------------- -// AUTOSENSE +// CONSOLE In this example, the extracted content will be copy as well to `copy` field. @@ -244,7 +244,7 @@ GET /test/person/_search } } -------------------------- -// AUTOSENSE +// CONSOLE Will give you: @@ -296,7 +296,7 @@ PUT /test/person/1 } } -------------------------- -// AUTOSENSE +// CONSOLE [[mapper-attachments-error-handling]] ==== Metadata parsing error handling @@ -372,7 +372,7 @@ GET /test/person/_search } } -------------------------- -// AUTOSENSE +// CONSOLE It gives back: diff --git a/docs/plugins/mapper-murmur3.asciidoc b/docs/plugins/mapper-murmur3.asciidoc index 63fb47b294b..28b7a2387ef 100644 --- a/docs/plugins/mapper-murmur3.asciidoc +++ b/docs/plugins/mapper-murmur3.asciidoc @@ -58,7 +58,7 @@ PUT my_index } } -------------------------- -// AUTOSENSE +// CONSOLE Such a mapping would allow to refer to `my_field.hash` in order to get hashes of the values of the `my_field` field. This is only useful in order to run @@ -88,7 +88,7 @@ GET my_index/_search } } -------------------------- -// AUTOSENSE +// CONSOLE <1> Counting unique values on the `my_field.hash` field diff --git a/docs/plugins/mapper-size.asciidoc b/docs/plugins/mapper-size.asciidoc index 708c8bbd8f7..4111a15ef6c 100644 --- a/docs/plugins/mapper-size.asciidoc +++ b/docs/plugins/mapper-size.asciidoc @@ -50,7 +50,7 @@ PUT my_index } } -------------------------- -// AUTOSENSE +// CONSOLE The value of the `_size` field is accessible in queries, aggregations, scripts, and when sorting: @@ -99,7 +99,7 @@ GET my_index/_search } } -------------------------- -// AUTOSENSE +// CONSOLE <1> Querying on the `_size` field <2> Aggregating on the `_size` field diff --git a/docs/plugins/repository-azure.asciidoc b/docs/plugins/repository-azure.asciidoc index 0ad1106e8c2..dd2ae068eb6 100644 --- a/docs/plugins/repository-azure.asciidoc +++ b/docs/plugins/repository-azure.asciidoc @@ -167,7 +167,7 @@ PUT _snapshot/my_backup4 } } ---- -// AUTOSENSE +// CONSOLE Example using Java: diff --git a/docs/plugins/repository-s3.asciidoc b/docs/plugins/repository-s3.asciidoc index 8780b3a710e..61ae79180dd 100644 --- a/docs/plugins/repository-s3.asciidoc +++ b/docs/plugins/repository-s3.asciidoc @@ -148,7 +148,7 @@ PUT _snapshot/my_s3_repository } } ---- -// AUTOSENSE +// CONSOLE The following settings are supported: diff --git a/docs/plugins/store-smb.asciidoc b/docs/plugins/store-smb.asciidoc index 1c0b5f4ec18..cf0094173d1 100644 --- a/docs/plugins/store-smb.asciidoc +++ b/docs/plugins/store-smb.asciidoc @@ -77,4 +77,4 @@ PUT my_index } } ---- -// AUTOSENSE +// CONSOLE diff --git a/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc b/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc index 2aaa0d6bb16..453967a46d7 100644 --- a/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc +++ b/docs/reference/analysis/analyzers/pattern-analyzer.asciidoc @@ -52,7 +52,7 @@ GET _cluster/health?wait_for_status=yellow GET test/_analyze?analyzer=whitespace&text=foo,bar baz # "foo,bar", "baz" -------------------------------------------------- -// AUTOSENSE +// CONSOLE [float] ===== Non-word character tokenizer @@ -81,7 +81,7 @@ GET test/_analyze?analyzer=nonword&text=foo,bar baz GET test/_analyze?analyzer=nonword&text=type_1-type_4 # "type_1","type_4" -------------------------------------------------- -// AUTOSENSE +// CONSOLE [float] @@ -108,7 +108,7 @@ GET _cluster/health?wait_for_status=yellow GET test/_analyze?analyzer=camel&text=MooseX::FTPClass2_beta # "moose","x","ftp","class","2","beta" -------------------------------------------------- -// AUTOSENSE +// CONSOLE The regex above is easier to understand as: diff --git a/docs/reference/cluster/tasks.asciidoc b/docs/reference/cluster/tasks.asciidoc index 0ac888c953f..b53d8de93a1 100644 --- a/docs/reference/cluster/tasks.asciidoc +++ b/docs/reference/cluster/tasks.asciidoc @@ -15,7 +15,7 @@ GET _tasks <1> GET _tasks?nodes=nodeId1,nodeId2 <2> GET _tasks?nodes=nodeId1,nodeId2&actions=cluster:* <3> -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Retrieves all tasks currently running on all nodes in the cluster. <2> Retrieves all tasks running on nodes `nodeId1` and `nodeId2`. See <> for more info about how to select individual nodes. @@ -66,7 +66,7 @@ tasks using the following two commands: GET _tasks/taskId:1 GET _tasks?parent_task_id=parentTaskId:1 -------------------------------------------------- -// AUTOSENSE +// CONSOLE The task API can be also used to wait for completion of a particular task. The following call will block for 10 seconds or until the task with id `oTUltX4IQMOUUVeiohTt8A:12345` is completed. @@ -75,7 +75,7 @@ block for 10 seconds or until the task with id `oTUltX4IQMOUUVeiohTt8A:12345` is -------------------------------------------------- GET _tasks/oTUltX4IQMOUUVeiohTt8A:12345?wait_for_completion=true&timeout=10s -------------------------------------------------- -// AUTOSENSE +// CONSOLE Tasks can be also listed using _cat version of the list tasks command, which accepts the same arguments as the standard list tasks command. @@ -84,7 +84,7 @@ as the standard list tasks command. -------------------------------------------------- GET _cat/tasks -------------------------------------------------- -// AUTOSENSE +// CONSOLE [float] === Task Cancellation @@ -95,7 +95,7 @@ If a long-running task supports cancellation, it can be cancelled by the followi -------------------------------------------------- POST _tasks/taskId:1/_cancel -------------------------------------------------- -// AUTOSENSE +// CONSOLE The task cancellation command supports the same task selection parameters as the list tasks command, so multiple tasks can be cancelled at the same time. For example, the following command will cancel all reindex tasks running on the @@ -105,7 +105,7 @@ nodes `nodeId1` and `nodeId2`. -------------------------------------------------- POST _tasks/_cancel?node_id=nodeId1,nodeId2&actions=*reindex -------------------------------------------------- -// AUTOSENSE +// CONSOLE [float] @@ -118,4 +118,4 @@ The following command will change the grouping to parent tasks: -------------------------------------------------- GET _tasks?group_by=parents -------------------------------------------------- -// AUTOSENSE +// CONSOLE diff --git a/docs/reference/docs/index_.asciidoc b/docs/reference/docs/index_.asciidoc index 93d04982d6f..eb1e45d6160 100644 --- a/docs/reference/docs/index_.asciidoc +++ b/docs/reference/docs/index_.asciidoc @@ -98,7 +98,7 @@ PUT twitter/tweet/1?version=2 "message" : "elasticsearch now has versioning support, double cool!" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[catch: conflict] *NOTE:* versioning is completely real time, and is not affected by the @@ -173,7 +173,7 @@ PUT twitter/tweet/1?op_type=create "message" : "trying out Elasticsearch" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE Another option to specify `create` is to use the following uri: @@ -186,7 +186,7 @@ PUT twitter/tweet/1/_create "message" : "trying out Elasticsearch" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [float] === Automatic ID Generation @@ -205,7 +205,7 @@ POST twitter/tweet/ "message" : "trying out Elasticsearch" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE The result of the above index operation is: @@ -244,7 +244,7 @@ POST twitter/tweet?routing=kimchy "message" : "trying out Elasticsearch" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE In the example above, the "tweet" document is routed to a shard based on the `routing` parameter provided: "kimchy". @@ -282,7 +282,7 @@ PUT blogs/blog_tag/1122?parent=1111 "tag" : "something" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE When indexing a child document, the routing value is automatically set to be the same as its parent, unless the routing value is explicitly @@ -306,7 +306,7 @@ PUT twitter/tweet/1?timestamp=2009-11-15T14:12:12 "message" : "trying out Elasticsearch" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE If the `timestamp` value is not provided externally or in the `_source`, the `timestamp` will be automatically set to the date the document was @@ -337,7 +337,7 @@ PUT twitter/tweet/1?ttl=86400000ms "message": "Trying out elasticsearch, so far so good?" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [source,js] -------------------------------------------------- @@ -347,7 +347,7 @@ PUT twitter/tweet/1?ttl=1d "message": "Trying out elasticsearch, so far so good?" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE More information can be found on the <>. @@ -430,4 +430,4 @@ PUT twitter/tweet/1?timeout=5m "message" : "trying out Elasticsearch" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE diff --git a/docs/reference/docs/reindex.asciidoc b/docs/reference/docs/reindex.asciidoc index 513281c07e3..00c5d34304e 100644 --- a/docs/reference/docs/reindex.asciidoc +++ b/docs/reference/docs/reindex.asciidoc @@ -18,7 +18,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:big_twitter] That will return something like this: @@ -64,7 +64,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] Setting `version_type` to `external` will cause Elasticsearch to preserve the @@ -85,7 +85,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] Settings `op_type` to `create` will cause `_reindex` to only create missing @@ -105,7 +105,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] By default version conflicts abort the `_reindex` process but you can just @@ -125,7 +125,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] You can limit the documents by adding a type to the `source` or by adding a @@ -149,7 +149,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] `index` and `type` in `source` can both be lists, allowing you to copy from @@ -173,7 +173,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT twitter\nPUT blog\n/] It's also possible to limit the number of processed documents by setting @@ -193,7 +193,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] If you want a particular set of documents from the twitter index you'll @@ -215,7 +215,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] Like `_update_by_query`, `_reindex` supports a script that modifies the @@ -238,7 +238,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] Think of the possibilities! Just be careful! With great power.... You can @@ -298,7 +298,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT source\n/] By default `_reindex` uses scroll batches of 100. You can change the @@ -318,7 +318,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT source\n/] Reindex can also use the <> feature by specifying a @@ -337,7 +337,7 @@ POST _reindex } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT source\n/] [float] @@ -437,7 +437,7 @@ While Reindex is running you can fetch their status using the -------------------------------------------------- GET _tasks/?pretty&detailed=true&actions=*reindex -------------------------------------------------- -// AUTOSENSE +// CONSOLE The responses looks like: @@ -496,7 +496,7 @@ Any Reindex can be canceled using the <>: -------------------------------------------------- POST _tasks/taskid:1/_cancel -------------------------------------------------- -// AUTOSENSE +// CONSOLE The `task_id` can be found using the tasks API above. @@ -515,7 +515,7 @@ the `_rethrottle` API: -------------------------------------------------- POST _reindex/taskid:1/_rethrottle?requests_per_second=unlimited -------------------------------------------------- -// AUTOSENSE +// CONSOLE The `task_id` can be found using the tasks API above. @@ -540,7 +540,7 @@ POST test/test/1?refresh&pretty "flag": "foo" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE But you don't like the name `flag` and want to replace it with `tag`. `_reindex` can create the other index for you: @@ -560,7 +560,7 @@ POST _reindex?pretty } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] Now you can get the new document: @@ -569,7 +569,7 @@ Now you can get the new document: -------------------------------------------------- GET test2/test/1?pretty -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] and it'll look like: diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index cb0c806f3a4..2de592f59a1 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -12,7 +12,7 @@ mapping change. Here is the API: -------------------------------------------------- POST twitter/_update_by_query?conflicts=proceed -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:big_twitter] That will return something like this: @@ -64,7 +64,7 @@ will only update `tweet`s from the `twitter` index: -------------------------------------------------- POST twitter/tweet/_update_by_query?conflicts=proceed -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] You can also limit `_update_by_query` using the @@ -82,7 +82,7 @@ POST twitter/_update_by_query?conflicts=proceed } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] <1> The query must be passed as a value to the `query` key, in the same @@ -109,7 +109,7 @@ POST twitter/_update_by_query } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] Just as in <> you can set `ctx.op = "noop"` if @@ -133,7 +133,7 @@ types at once, just like the search API: -------------------------------------------------- POST twitter,blog/tweet,post/_update_by_query -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT twitter\nPUT blog\n/] If you provide `routing` then the routing is copied to the scroll query, @@ -143,7 +143,7 @@ limiting the process to the shards that match that routing value: -------------------------------------------------- POST twitter/_update_by_query?routing=1 -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] By default `_update_by_query` uses scroll batches of 100. You can change the @@ -153,7 +153,7 @@ batch size with the `scroll_size` URL parameter: -------------------------------------------------- POST twitter/_update_by_query?scroll_size=1000 -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] `_update_by_query` can also use the <> feature by @@ -173,7 +173,7 @@ PUT _ingest/pipeline/set-foo } POST twitter/_update_by_query?pipeline=set-foo -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] [float] @@ -268,7 +268,7 @@ While Update By Query is running you can fetch their status using the -------------------------------------------------- GET _tasks/?pretty&detailed=true&action=*byquery -------------------------------------------------- -// AUTOSENSE +// CONSOLE The responses looks like: @@ -327,7 +327,7 @@ Any Update By Query can be canceled using the <>: -------------------------------------------------- POST _tasks/taskid:1/_cancel -------------------------------------------------- -// AUTOSENSE +// CONSOLE The `task_id` can be found using the tasks API above. @@ -346,7 +346,7 @@ using the `_rethrottle` API: -------------------------------------------------- POST _update_by_query/taskid:1/_rethrottle?requests_per_second=unlimited -------------------------------------------------- -// AUTOSENSE +// CONSOLE The `task_id` can be found using the tasks API above. @@ -396,7 +396,7 @@ PUT test/_mapping/test <2> } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> This means that new fields won't be indexed, just stored in `_source`. @@ -416,7 +416,7 @@ POST test/_search?filter_path=hits.total } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] [source,js] @@ -443,7 +443,7 @@ POST test/_search?filter_path=hits.total } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] [source,js] diff --git a/docs/reference/index-modules/allocation/delayed.asciidoc b/docs/reference/index-modules/allocation/delayed.asciidoc index 6bedba95586..907d927fd68 100644 --- a/docs/reference/index-modules/allocation/delayed.asciidoc +++ b/docs/reference/index-modules/allocation/delayed.asciidoc @@ -45,7 +45,7 @@ PUT _all/_settings } } ------------------------------ -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT test\n/] With delayed allocation enabled, the above scenario changes to look like this: @@ -83,7 +83,7 @@ can be viewed with the <>: ------------------------------ GET _cluster/health <1> ------------------------------ -// AUTOSENSE +// CONSOLE <1> This request will return a `delayed_unassigned_shards` value. ==== Removing a node permanently @@ -101,7 +101,7 @@ PUT _all/_settings } } ------------------------------ -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT test\n/] You can reset the timeout as soon as the missing shards have started to recover. diff --git a/docs/reference/index-modules/allocation/filtering.asciidoc b/docs/reference/index-modules/allocation/filtering.asciidoc index f5b73a9f78e..be45cd2a1ac 100644 --- a/docs/reference/index-modules/allocation/filtering.asciidoc +++ b/docs/reference/index-modules/allocation/filtering.asciidoc @@ -31,7 +31,7 @@ PUT test/_settings "index.routing.allocation.include.size": "big,medium" } ------------------------ -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT test\n/] Alternatively, we can move the index `test` away from the `small` nodes with @@ -44,7 +44,7 @@ PUT test/_settings "index.routing.allocation.exclude.size": "small" } ------------------------ -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT test\n/] Multiple rules can be specified, in which case all conditions must be @@ -59,7 +59,7 @@ PUT test/_settings "index.routing.allocation.include.rack": "rack1" } ------------------------ -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT test\n/] NOTE: If some conditions cannot be satisfied then shards will not be moved. @@ -100,5 +100,5 @@ PUT test/_settings "index.routing.allocation.include._ip": "192.168.2.*" } ------------------------ -// AUTOSENSE +// CONSOLE // TEST[skip:indexes don't assign] diff --git a/docs/reference/index-modules/allocation/prioritization.asciidoc b/docs/reference/index-modules/allocation/prioritization.asciidoc index 149e43fd134..eecc98abcb0 100644 --- a/docs/reference/index-modules/allocation/prioritization.asciidoc +++ b/docs/reference/index-modules/allocation/prioritization.asciidoc @@ -33,7 +33,7 @@ PUT index_4 } } ------------------------------ -// AUTOSENSE +// CONSOLE In the above example: @@ -52,5 +52,5 @@ PUT index_4/_settings "index.priority": 1 } ------------------------------ -// AUTOSENSE +// CONSOLE // TEST[continued] diff --git a/docs/reference/indices/analyze.asciidoc b/docs/reference/indices/analyze.asciidoc index 3597ccc51e5..d9016c9e8ec 100644 --- a/docs/reference/indices/analyze.asciidoc +++ b/docs/reference/indices/analyze.asciidoc @@ -121,7 +121,7 @@ GET _analyze "attributes" : ["keyword"] <1> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Set "keyword" to output "keyword" attribute only coming[2.0.0, body based parameters were added in 2.0.0] diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 0279ee3abcf..acf2b7c1a6a 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -12,7 +12,7 @@ trigger flush operations as required in order to clear memory. -------------------------------------------------- POST twitter/_flush -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] [float] @@ -45,7 +45,7 @@ POST kimchy,elasticsearch/_flush POST _flush -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT kimchy\nPUT elasticsearch\n/] [[indices-synced-flush]] @@ -76,7 +76,7 @@ the <> API: -------------------------------------------------- GET twitter/_stats/commit?level=shards -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT twitter\n/] @@ -141,7 +141,7 @@ NOTE: It is harmless to request a synced flush while there is ongoing indexing. -------------------------------------------------- POST twitter/_flush/synced -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[setup:twitter] The response contains details about how many shards were successfully sync-flushed and information about any failure. @@ -238,4 +238,4 @@ POST kimchy,elasticsearch/_flush/synced POST _flush/synced -------------------------------------------------- -// AUTOSENSE +// CONSOLE diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index 70a5aa8bef0..cb1d956e39f 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -37,7 +37,7 @@ PUT twitter/_mapping/tweet <3> } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> <> called `twitter` with the `message` field in the `tweet` <>. <2> Uses the PUT mapping API to add a new mapping type called `user`. <3> Uses the PUT mapping API to add a new field called `user_name` to the `tweet` mapping type. @@ -115,7 +115,7 @@ PUT my_index/_mapping/user } } ----------------------------------- -// AUTOSENSE +// CONSOLE <1> Create an index with a `first` field under the `name` <> field, and a `user_id` field. <2> Add a `last` field under the `name` object field. <3> Update the `ignore_above` setting from its default of 0. @@ -174,7 +174,7 @@ PUT my_index/_mapping/type_one <2> } } ----------------------------------- -// AUTOSENSE +// CONSOLE // TEST[catch:request] <1> Create an index with two types, both of which contain a `text` field which have the same mapping. <2> Trying to update the `search_analyzer` just for `type_one` throws an exception like `"Merge failed with failures..."`. @@ -194,6 +194,6 @@ PUT my_index/_mapping/type_one?update_all_types <1> } } ----------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] <1> Adding the `update_all_types` parameter updates the `text` field in `type_one` and `type_two`. diff --git a/docs/reference/indices/templates.asciidoc b/docs/reference/indices/templates.asciidoc index 86bc77c52e4..754a93e3096 100644 --- a/docs/reference/indices/templates.asciidoc +++ b/docs/reference/indices/templates.asciidoc @@ -37,7 +37,7 @@ PUT _template/template_1 } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE Defines a template named template_1, with a template pattern of `te*`. The settings and mappings will be applied to any index name that matches diff --git a/docs/reference/ingest.asciidoc b/docs/reference/ingest.asciidoc index 767b928d205..7150bd32739 100644 --- a/docs/reference/ingest.asciidoc +++ b/docs/reference/ingest.asciidoc @@ -30,7 +30,7 @@ PUT my-index/my-type/my-id?pipeline=my_pipeline_id "foo": "bar" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[catch:request] See <> for more information about creating, adding, and deleting pipelines. diff --git a/docs/reference/ingest/ingest-node.asciidoc b/docs/reference/ingest/ingest-node.asciidoc index 631e4bb40f7..ec6253f2d93 100644 --- a/docs/reference/ingest/ingest-node.asciidoc +++ b/docs/reference/ingest/ingest-node.asciidoc @@ -50,7 +50,7 @@ PUT _ingest/pipeline/my-pipeline-id ] } -------------------------------------------------- -// AUTOSENSE +// CONSOLE NOTE: The put pipeline API also instructs all ingest nodes to reload their in-memory representation of pipelines, so that pipeline changes take effect immediately. @@ -64,7 +64,7 @@ The get pipeline API returns pipelines based on ID. This API always returns a lo -------------------------------------------------- GET _ingest/pipeline/my-pipeline-id -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] Example response: @@ -104,7 +104,7 @@ The delete pipeline API deletes pipelines by ID. -------------------------------------------------- DELETE _ingest/pipeline/my-pipeline-id -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] [[simulate-pipeline-api]] @@ -189,7 +189,7 @@ POST _ingest/pipeline/_simulate ] } -------------------------------------------------- -// AUTOSENSE +// CONSOLE Response: @@ -288,7 +288,7 @@ POST _ingest/pipeline/_simulate?verbose ] } -------------------------------------------------- -// AUTOSENSE +// CONSOLE Response: diff --git a/docs/reference/mapping.asciidoc b/docs/reference/mapping.asciidoc index 70de0a2735b..5507ba97ff6 100644 --- a/docs/reference/mapping.asciidoc +++ b/docs/reference/mapping.asciidoc @@ -156,7 +156,7 @@ PUT my_index <1> } } --------------------------------------- -// AUTOSENSE +// CONSOLE <1> Create an index called `my_index`. <2> Add mapping types called `user` and `blogpost`. <3> Disable the `_all` <> for the `user` mapping type. diff --git a/docs/reference/mapping/dynamic-mapping.asciidoc b/docs/reference/mapping/dynamic-mapping.asciidoc index 81aa5858db3..2370684ff44 100644 --- a/docs/reference/mapping/dynamic-mapping.asciidoc +++ b/docs/reference/mapping/dynamic-mapping.asciidoc @@ -12,7 +12,7 @@ type, and fields will spring to life automatically: PUT data/counters/1 <1> { "count": 5 } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Creates the `data` index, the `counters` mapping type, and a field called `count` with datatype `long`. @@ -51,7 +51,7 @@ PUT data/_settings <1> "index.mapper.dynamic":false } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] <1> Disable automatic type creation for all indices. diff --git a/docs/reference/mapping/dynamic/default-mapping.asciidoc b/docs/reference/mapping/dynamic/default-mapping.asciidoc index bef90301f0c..268ae4f29c7 100644 --- a/docs/reference/mapping/dynamic/default-mapping.asciidoc +++ b/docs/reference/mapping/dynamic/default-mapping.asciidoc @@ -27,7 +27,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `_default_` mapping defaults the <> field to disabled. <2> The `user` type inherits the settings from `_default_`. <3> The `blogpost` type overrides the defaults and enables the <> field. @@ -74,7 +74,7 @@ PUT _template/logging PUT logs-2015.10.01/event/1 { "message": "error:16" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `logging` template will match any indices beginning with `logs-`. <2> Matching indices will be created with a single primary shard. <3> The `_all` field will be disabled by default for new type mappings. diff --git a/docs/reference/mapping/dynamic/field-mapping.asciidoc b/docs/reference/mapping/dynamic/field-mapping.asciidoc index a1ce6683502..020c5d24552 100644 --- a/docs/reference/mapping/dynamic/field-mapping.asciidoc +++ b/docs/reference/mapping/dynamic/field-mapping.asciidoc @@ -68,7 +68,7 @@ PUT my_index/my_type/1 GET my_index/_mapping <1> -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `create_date` field has been added as a <> field with the <>: + `"yyyy/MM/dd HH:mm:ss Z||yyyy/MM/dd Z"`. @@ -93,7 +93,7 @@ PUT my_index/my_type/1 <1> "create": "2015/09/02" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `create_date` field has been added as a <> field. @@ -118,7 +118,7 @@ PUT my_index/my_type/1 "create_date": "09/25/2015" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [[numeric-detection]] @@ -147,7 +147,7 @@ PUT my_index/my_type/1 "my_integer": "1" <2> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `my_float` field is added as a <> field. <2> The `my_integer` field is added as a <> field. diff --git a/docs/reference/mapping/dynamic/templates.asciidoc b/docs/reference/mapping/dynamic/templates.asciidoc index 6396abe8522..21b0eadf683 100644 --- a/docs/reference/mapping/dynamic/templates.asciidoc +++ b/docs/reference/mapping/dynamic/templates.asciidoc @@ -96,7 +96,7 @@ PUT my_index/my_type/1 } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `my_integer` field is mapped as an `integer`. <2> The `my_string` field is mapped as a `text`, with a `keyword` <>. @@ -140,7 +140,7 @@ PUT my_index/my_type/1 "long_text": "foo" <2> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `long_num` field is mapped as a `long`. <2> The `long_text` field uses the default `string` mapping. @@ -198,7 +198,7 @@ PUT my_index/my_type/1 } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [[template-variables]] ==== `{name}` and `{dynamic_type}` @@ -245,7 +245,7 @@ PUT my_index/my_type/1 "count": 5 <2> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `english` field is mapped as a `string` field with the `english` analyzer. <2> The `count` field is mapped as a `long` field with `doc_values` disabled @@ -417,7 +417,7 @@ PUT _template/disable_all_field } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Applies the mappings to an `index` which matches the pattern `*`, in other words, all new indices. <2> Defines the `_default_` type mapping types within the index. diff --git a/docs/reference/mapping/fields/all-field.asciidoc b/docs/reference/mapping/fields/all-field.asciidoc index 58f0e783af4..70fac4ed068 100644 --- a/docs/reference/mapping/fields/all-field.asciidoc +++ b/docs/reference/mapping/fields/all-field.asciidoc @@ -28,7 +28,7 @@ GET my_index/_search } } -------------------------------- -// AUTOSENSE +// CONSOLE <1> The `_all` field will contain the terms: [ `"john"`, `"smith"`, `"1970"`, `"10"`, `"24"` ] [NOTE] @@ -77,7 +77,7 @@ GET _search } } -------------------------------- -// AUTOSENSE +// CONSOLE The same goes for the `?q=` parameter in <> (which is rewritten to a `query_string` query internally): @@ -115,7 +115,7 @@ PUT my_index } } -------------------------------- -// AUTOSENSE +// CONSOLE // TEST[s/\.\.\.//] <1> The `_all` field in `type_1` is enabled. @@ -147,7 +147,7 @@ PUT my_index } } -------------------------------- -// AUTOSENSE +// CONSOLE <1> The `_all` field is disabled for the `my_type` type. <2> The `query_string` query will default to querying the `content` field in this index. @@ -184,7 +184,7 @@ PUT myindex } } -------------------------------- -// AUTOSENSE +// CONSOLE <1> When querying the `_all` field, words that originated in the `title` field are twice as relevant as words that originated in @@ -241,7 +241,7 @@ GET myindex/_search } } -------------------------------- -// AUTOSENSE +// CONSOLE <1> The `first_name` and `last_name` values are copied to the `full_name` field. @@ -296,7 +296,7 @@ GET _search } } -------------------------------- -// AUTOSENSE +// CONSOLE Of course, storing the `_all` field will use significantly more disk space and, because it is a combination of other fields, it may result in odd @@ -344,7 +344,7 @@ GET _search } } -------------------------------- -// AUTOSENSE +// CONSOLE <1> The query inspects the `_all` field to find matching documents. <2> Highlighting is performed on the two name fields, which are available from the `_source`. diff --git a/docs/reference/mapping/fields/field-names-field.asciidoc b/docs/reference/mapping/fields/field-names-field.asciidoc index ebb228fca94..a56a9081e88 100644 --- a/docs/reference/mapping/fields/field-names-field.asciidoc +++ b/docs/reference/mapping/fields/field-names-field.asciidoc @@ -37,7 +37,7 @@ GET my_index/_search } -------------------------- -// AUTOSENSE +// CONSOLE <1> Querying on the `_field_names` field (also see the <> query) <2> Accessing the `_field_names` field in scripts (inline scripts must be <> for this example to work) diff --git a/docs/reference/mapping/fields/id-field.asciidoc b/docs/reference/mapping/fields/id-field.asciidoc index 4ee470e4dbd..a852f4f4770 100644 --- a/docs/reference/mapping/fields/id-field.asciidoc +++ b/docs/reference/mapping/fields/id-field.asciidoc @@ -38,7 +38,7 @@ GET my_index/_search } } -------------------------- -// AUTOSENSE +// CONSOLE <1> Querying on the `_id` field (also see the <>) <2> Accessing the `_id` field in scripts (inline scripts must be <> for this example to work) diff --git a/docs/reference/mapping/fields/index-field.asciidoc b/docs/reference/mapping/fields/index-field.asciidoc index bc506db1836..c31b6f1d0f7 100644 --- a/docs/reference/mapping/fields/index-field.asciidoc +++ b/docs/reference/mapping/fields/index-field.asciidoc @@ -55,7 +55,7 @@ GET index_1,index_2/_search } } -------------------------- -// AUTOSENSE +// CONSOLE <1> Querying on the `_index` field <2> Aggregating on the `_index` field diff --git a/docs/reference/mapping/fields/meta-field.asciidoc b/docs/reference/mapping/fields/meta-field.asciidoc index 4bcab15b4c0..befaf4e8df0 100644 --- a/docs/reference/mapping/fields/meta-field.asciidoc +++ b/docs/reference/mapping/fields/meta-field.asciidoc @@ -22,7 +22,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> This `_meta` info can be retrieved with the <> API. diff --git a/docs/reference/mapping/fields/parent-field.asciidoc b/docs/reference/mapping/fields/parent-field.asciidoc index 78ce1ebfd00..9dd8646172d 100644 --- a/docs/reference/mapping/fields/parent-field.asciidoc +++ b/docs/reference/mapping/fields/parent-field.asciidoc @@ -47,7 +47,7 @@ GET my_index/my_parent/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `my_parent` type is parent to the `my_child` type. <2> Index a parent document. <3> Index two child documents, specifying the parent document's ID. @@ -86,7 +86,7 @@ GET my_index/_search } } -------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] <1> Querying on the `_parent` field (also see the <> and the <>) @@ -138,7 +138,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE The amount of heap used by global ordinals can be checked as follows: @@ -150,4 +150,4 @@ GET _stats/fielddata?human&fields=_parent # Per-node per-index GET _nodes/stats/indices/fielddata?human&fields=_parent -------------------------------------------------- -// AUTOSENSE +// CONSOLE diff --git a/docs/reference/mapping/fields/routing-field.asciidoc b/docs/reference/mapping/fields/routing-field.asciidoc index c90a52aab37..49f269511dc 100644 --- a/docs/reference/mapping/fields/routing-field.asciidoc +++ b/docs/reference/mapping/fields/routing-field.asciidoc @@ -21,7 +21,7 @@ PUT my_index/my_type/1?routing=user1 <1> GET my_index/my_type/1?routing=user1 <2> ------------------------------ -// AUTOSENSE +// CONSOLE // TESTSETUP <1> This document uses `user1` as its routing value, instead of its ID. @@ -47,7 +47,7 @@ GET my_index/_search } } -------------------------- -// AUTOSENSE +// CONSOLE <1> Querying on the `_routing` field (also see the <>) <2> Accessing the `_routing` field in scripts (inline scripts must be <> for this example to work) @@ -70,7 +70,7 @@ GET my_index/_search?routing=user1,user2 <1> } } ------------------------------ -// AUTOSENSE +// CONSOLE <1> This search request will only be executed on the shards associated with the `user1` and `user2` routing values. @@ -103,7 +103,7 @@ PUT my_index2/my_type/1 <2> "text": "No routing value provided" } ------------------------------ -// AUTOSENSE +// CONSOLE // TEST[catch:request] <1> Routing is required for `my_type` documents. <2> This index request throws a `routing_missing_exception`. diff --git a/docs/reference/mapping/fields/source-field.asciidoc b/docs/reference/mapping/fields/source-field.asciidoc index 9c509593b61..db005f6eb37 100644 --- a/docs/reference/mapping/fields/source-field.asciidoc +++ b/docs/reference/mapping/fields/source-field.asciidoc @@ -24,7 +24,7 @@ PUT tweets } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [WARNING] .Think before disabling the `_source` field @@ -130,7 +130,7 @@ GET logs/event/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> These fields will be removed from the stored `_source` field. <2> We can still search on this field, even though it is not in the stored `_source`. diff --git a/docs/reference/mapping/fields/timestamp-field.asciidoc b/docs/reference/mapping/fields/timestamp-field.asciidoc index c6b3887f889..104b07cfee1 100644 --- a/docs/reference/mapping/fields/timestamp-field.asciidoc +++ b/docs/reference/mapping/fields/timestamp-field.asciidoc @@ -30,7 +30,7 @@ PUT my_index/my_type/3 <4> { "text": "Autogenerated timestamp set to now()" } ------------------------------------ -// AUTOSENSE +// CONSOLE <1> Enable the `_timestamp` field with default settings. <2> Set the timestamp manually with a formatted date. @@ -88,7 +88,7 @@ GET my_index/_search } } -------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] <1> Querying on the `_timestamp` field diff --git a/docs/reference/mapping/fields/ttl-field.asciidoc b/docs/reference/mapping/fields/ttl-field.asciidoc index 1fd258d1ea1..26760d5aca8 100644 --- a/docs/reference/mapping/fields/ttl-field.asciidoc +++ b/docs/reference/mapping/fields/ttl-field.asciidoc @@ -44,7 +44,7 @@ PUT my_index/my_type/2 <2> "text": "Will not expire" } ------------------------------- -// AUTOSENSE +// CONSOLE <1> This document will expire 10 minutes after being indexed. <2> This document has no TTL set and will not expire. @@ -80,7 +80,7 @@ PUT my_index/my_type/2 <2> "text": "Will expire in 5 minutes" } ------------------------------- -// AUTOSENSE +// CONSOLE <1> This document will expire 10 minutes after being indexed. <2> This document has no TTL set and so will expire after the default 5 minutes. diff --git a/docs/reference/mapping/fields/type-field.asciidoc b/docs/reference/mapping/fields/type-field.asciidoc index a1d48129f5d..ae283e44569 100644 --- a/docs/reference/mapping/fields/type-field.asciidoc +++ b/docs/reference/mapping/fields/type-field.asciidoc @@ -35,7 +35,7 @@ GET my_index/type_*/_search } -------------------------- -// AUTOSENSE +// CONSOLE <1> Querying on the `_type` field <2> Accessing the `_type` field in scripts (inline scripts must be <> for this example to work) diff --git a/docs/reference/mapping/fields/uid-field.asciidoc b/docs/reference/mapping/fields/uid-field.asciidoc index cab5f4f8216..43d5751d426 100644 --- a/docs/reference/mapping/fields/uid-field.asciidoc +++ b/docs/reference/mapping/fields/uid-field.asciidoc @@ -50,7 +50,7 @@ GET my_index/_search } } -------------------------- -// AUTOSENSE +// CONSOLE <1> Querying on the `_uid` field (also see the <>) <2> Aggregating on the `_uid` field diff --git a/docs/reference/mapping/params/analyzer.asciidoc b/docs/reference/mapping/params/analyzer.asciidoc index b2138794546..7fc6c801e16 100644 --- a/docs/reference/mapping/params/analyzer.asciidoc +++ b/docs/reference/mapping/params/analyzer.asciidoc @@ -72,7 +72,7 @@ GET my_index/_analyze?field=text.english <4> "text": "The quick Brown Foxes." } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `text` field uses the default `standard` analyzer`. <2> The `text.english` <> uses the `english` analyzer, which removes stop words and applies stemming. <3> This returns the tokens: [ `the`, `quick`, `brown`, `foxes` ]. @@ -136,7 +136,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [source,js] -------------------------------------------------- diff --git a/docs/reference/mapping/params/boost.asciidoc b/docs/reference/mapping/params/boost.asciidoc index a3379d581c7..e6890f948be 100644 --- a/docs/reference/mapping/params/boost.asciidoc +++ b/docs/reference/mapping/params/boost.asciidoc @@ -23,7 +23,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Matches on the `title` field will have twice the weight as those on the `content` field, which has the default `boost` of `1.0`. @@ -45,7 +45,7 @@ POST _search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE is equivalent to: @@ -63,7 +63,7 @@ POST _search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE The boost is also applied when it is copied with the diff --git a/docs/reference/mapping/params/coerce.asciidoc b/docs/reference/mapping/params/coerce.asciidoc index 9d55a8b80c8..dacdabaafc0 100644 --- a/docs/reference/mapping/params/coerce.asciidoc +++ b/docs/reference/mapping/params/coerce.asciidoc @@ -44,7 +44,7 @@ PUT my_index/my_type/2 "number_two": "10" <2> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[catch:request] <1> The `number_one` field will contain the integer `10`. <2> This document will be rejected because coercion is disabled. @@ -87,7 +87,7 @@ PUT my_index/my_type/1 PUT my_index/my_type/2 { "number_two": "10" } <2> -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[catch:request] <1> The `number_one` field overrides the index level setting to enable coercion. <2> This document will be rejected because the `number_two` field inherits the index-level coercion setting. diff --git a/docs/reference/mapping/params/copy-to.asciidoc b/docs/reference/mapping/params/copy-to.asciidoc index a6288bcbc48..bc22c923821 100644 --- a/docs/reference/mapping/params/copy-to.asciidoc +++ b/docs/reference/mapping/params/copy-to.asciidoc @@ -49,7 +49,7 @@ GET my_index/_search } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The values of the `first_name` and `last_name` fields are copied to the `full_name` field. diff --git a/docs/reference/mapping/params/doc-values.asciidoc b/docs/reference/mapping/params/doc-values.asciidoc index 4ded2212de1..d9d6bbc9afc 100644 --- a/docs/reference/mapping/params/doc-values.asciidoc +++ b/docs/reference/mapping/params/doc-values.asciidoc @@ -40,7 +40,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `status_code` field has `doc_values` enabled by default. <2> The `session_id` has `doc_values` disabled, but can still be queried. diff --git a/docs/reference/mapping/params/dynamic.asciidoc b/docs/reference/mapping/params/dynamic.asciidoc index 16bb89fbf6b..985e5a63df3 100644 --- a/docs/reference/mapping/params/dynamic.asciidoc +++ b/docs/reference/mapping/params/dynamic.asciidoc @@ -31,7 +31,7 @@ PUT my_index/my_type/2 <3> GET my_index/_mapping <4> -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> This document introduces the string field `username`, the object field `name`, and two string fields under the `name` object which can be referred to as `name.first` and `name.last`. @@ -77,7 +77,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Dynamic mapping is disabled at the type level, so no new top-level fields will be added dynamically. <2> The `user` object inherits the type-level setting. <3> The `user.social_networks` object enables dynamic mapping, so new fields may be added to this inner object. diff --git a/docs/reference/mapping/params/enabled.asciidoc b/docs/reference/mapping/params/enabled.asciidoc index 7bffcfddf2e..9d7dc05b382 100644 --- a/docs/reference/mapping/params/enabled.asciidoc +++ b/docs/reference/mapping/params/enabled.asciidoc @@ -52,7 +52,7 @@ PUT my_index/session/session_2 "last_updated": "2015-12-06T18:22:13" } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `session_data` field is disabled. <2> Any arbitrary data can be passed to the `session_data` field as it will be entirely ignored. <3> The `session_data` will also ignore values that are not JSON objects. @@ -87,7 +87,7 @@ GET my_index/session/session_1 <2> GET my_index/_mapping <3> -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The entire `session` mapping type is disabled. <2> The document can be retrieved. <3> Checking the mapping reveals that no fields have been added. diff --git a/docs/reference/mapping/params/fielddata.asciidoc b/docs/reference/mapping/params/fielddata.asciidoc index e20a82bfd5c..92151c56d49 100644 --- a/docs/reference/mapping/params/fielddata.asciidoc +++ b/docs/reference/mapping/params/fielddata.asciidoc @@ -112,4 +112,4 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE diff --git a/docs/reference/mapping/params/format.asciidoc b/docs/reference/mapping/params/format.asciidoc index 106b5b0f10d..38cb0ea624f 100644 --- a/docs/reference/mapping/params/format.asciidoc +++ b/docs/reference/mapping/params/format.asciidoc @@ -25,7 +25,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE Many APIs which support date values also support <> expressions, such as `now-1m/d` -- the current time, minus one month, rounded diff --git a/docs/reference/mapping/params/geohash-precision.asciidoc b/docs/reference/mapping/params/geohash-precision.asciidoc index c571a70a9de..6e4e859d03f 100644 --- a/docs/reference/mapping/params/geohash-precision.asciidoc +++ b/docs/reference/mapping/params/geohash-precision.asciidoc @@ -56,5 +56,5 @@ GET my_index/_search?fielddata_fields=location.geohash } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> A `geohash_precision` of 6 equates to geohash cells of approximately 1.26km x 0.6km diff --git a/docs/reference/mapping/params/geohash-prefix.asciidoc b/docs/reference/mapping/params/geohash-prefix.asciidoc index da4708f89b0..56f0b42ae8d 100644 --- a/docs/reference/mapping/params/geohash-prefix.asciidoc +++ b/docs/reference/mapping/params/geohash-prefix.asciidoc @@ -60,5 +60,5 @@ GET my_index/_search?fielddata_fields=location.geohash } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE diff --git a/docs/reference/mapping/params/geohash.asciidoc b/docs/reference/mapping/params/geohash.asciidoc index a1319c071a3..d362d373437 100644 --- a/docs/reference/mapping/params/geohash.asciidoc +++ b/docs/reference/mapping/params/geohash.asciidoc @@ -53,7 +53,7 @@ GET my_index/_search?fielddata_fields=location.geohash <2> } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> A `location.geohash` field will be indexed for each geo-point. <2> The geohash can be retrieved with <>. <3> A <> query can find all geohashes which start with a particular prefix. diff --git a/docs/reference/mapping/params/ignore-above.asciidoc b/docs/reference/mapping/params/ignore-above.asciidoc index a9fa5377144..6a24ca626d9 100644 --- a/docs/reference/mapping/params/ignore-above.asciidoc +++ b/docs/reference/mapping/params/ignore-above.asciidoc @@ -40,7 +40,7 @@ GET _search <4> } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> This field will ignore any string longer than 20 characters. <2> This document is indexed successfully. <3> This document will be indexed, but without indexing the `message` field. diff --git a/docs/reference/mapping/params/ignore-malformed.asciidoc b/docs/reference/mapping/params/ignore-malformed.asciidoc index 00b57cb32e9..916b01b33c1 100644 --- a/docs/reference/mapping/params/ignore-malformed.asciidoc +++ b/docs/reference/mapping/params/ignore-malformed.asciidoc @@ -43,7 +43,7 @@ PUT my_index/my_type/2 "number_two": "foo" <2> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[catch:request] <1> This document will have the `text` field indexed, but not the `number_one` field. <2> This document will be rejected because `number_two` does not allow malformed values. @@ -81,7 +81,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `number_one` field inherits the index-level setting. <2> The `number_two` field overrides the index-level setting to turn off `ignore_malformed`. diff --git a/docs/reference/mapping/params/include-in-all.asciidoc b/docs/reference/mapping/params/include-in-all.asciidoc index bd2b5b8a179..ade2db80d2c 100644 --- a/docs/reference/mapping/params/include-in-all.asciidoc +++ b/docs/reference/mapping/params/include-in-all.asciidoc @@ -28,7 +28,7 @@ PUT my_index } } -------------------------------- -// AUTOSENSE +// CONSOLE <1> The `title` and `content` fields will be included in the `_all` field. <2> The `date` field will not be included in the `_all` field. @@ -69,7 +69,7 @@ PUT my_index } } -------------------------------- -// AUTOSENSE +// CONSOLE <1> All fields in `my_type` are excluded from `_all`. <2> The `author.first_name` and `author.last_name` fields are included in `_all`. diff --git a/docs/reference/mapping/params/index-options.asciidoc b/docs/reference/mapping/params/index-options.asciidoc index 9f327adb969..bda174b5234 100644 --- a/docs/reference/mapping/params/index-options.asciidoc +++ b/docs/reference/mapping/params/index-options.asciidoc @@ -66,5 +66,5 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `text` field will use the postings highlighter by default because `offsets` are indexed. diff --git a/docs/reference/mapping/params/lat-lon.asciidoc b/docs/reference/mapping/params/lat-lon.asciidoc index 0a5cce48437..c610d8a1771 100644 --- a/docs/reference/mapping/params/lat-lon.asciidoc +++ b/docs/reference/mapping/params/lat-lon.asciidoc @@ -51,7 +51,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Setting `lat_lon` to true indexes the geo-point in the `location.lat` and `location.lon` fields. <2> The `indexed` option tells the geo-distance query to use the inverted index instead of the in-memory calculation. diff --git a/docs/reference/mapping/params/multi-fields.asciidoc b/docs/reference/mapping/params/multi-fields.asciidoc index bee9dae1763..80a92a5d83e 100644 --- a/docs/reference/mapping/params/multi-fields.asciidoc +++ b/docs/reference/mapping/params/multi-fields.asciidoc @@ -55,7 +55,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `city.raw` field is a `keyword` version of the `city` field. <2> The `city` field can be used for full text search. <3> The `city.raw` field can be used for sorting and aggregations @@ -115,7 +115,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `text` field uses the `standard` analyzer. <2> The `text.english` field uses the `english` analyzer. diff --git a/docs/reference/mapping/params/norms.asciidoc b/docs/reference/mapping/params/norms.asciidoc index 9f78e0d62d8..0d259c0bc7c 100644 --- a/docs/reference/mapping/params/norms.asciidoc +++ b/docs/reference/mapping/params/norms.asciidoc @@ -30,7 +30,7 @@ PUT my_index/_mapping/my_type } } ------------ -// AUTOSENSE +// CONSOLE // TEST[s/^/PUT my_index\n/] NOTE: Norms will not be removed instantly, but will be removed as old segments diff --git a/docs/reference/mapping/params/null-value.asciidoc b/docs/reference/mapping/params/null-value.asciidoc index b77a2e4da69..ee1ea0c3257 100644 --- a/docs/reference/mapping/params/null-value.asciidoc +++ b/docs/reference/mapping/params/null-value.asciidoc @@ -43,7 +43,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Replace explicit `null` values with the term `NULL`. <2> An empty array does not contain an explicit `null`, and so won't be replaced with the `null_value`. <3> A query for `NULL` returns document 1, but not document 2. diff --git a/docs/reference/mapping/params/position-increment-gap.asciidoc b/docs/reference/mapping/params/position-increment-gap.asciidoc index 871b6275a1c..ea73e730759 100644 --- a/docs/reference/mapping/params/position-increment-gap.asciidoc +++ b/docs/reference/mapping/params/position-increment-gap.asciidoc @@ -41,7 +41,7 @@ GET my_index/groups/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> This phrase query doesn't match our document which is totally expected. <2> This phrase query matches our document, even though `Abraham` and `Lincoln` are in separate strings, because `slop` > `position_increment_gap`. @@ -79,7 +79,7 @@ GET my_index/groups/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The first term in the next array element will be 0 terms apart from the last term in the previous array element. <2> The phrase query matches our document which is weird, but its what we asked diff --git a/docs/reference/mapping/params/properties.asciidoc b/docs/reference/mapping/params/properties.asciidoc index d9e3a2db75d..9efe1f8e82c 100644 --- a/docs/reference/mapping/params/properties.asciidoc +++ b/docs/reference/mapping/params/properties.asciidoc @@ -57,7 +57,7 @@ PUT my_index/my_type/1 <4> ] } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Properties under the `my_type` mapping type. <2> Properties under the `manager` object field. <3> Properties under the `employees` nested field. @@ -98,7 +98,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] IMPORTANT: The full path to the inner field must be specified. diff --git a/docs/reference/mapping/params/search-analyzer.asciidoc b/docs/reference/mapping/params/search-analyzer.asciidoc index 3e51aad14af..d31a997430d 100644 --- a/docs/reference/mapping/params/search-analyzer.asciidoc +++ b/docs/reference/mapping/params/search-analyzer.asciidoc @@ -68,7 +68,7 @@ GET my_index/_search } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Analysis settings to define the custom `autocomplete` analyzer. <2> The `text` field uses the `autocomplete` analyzer at index time, but the `standard` analyzer at search time. diff --git a/docs/reference/mapping/params/similarity.asciidoc b/docs/reference/mapping/params/similarity.asciidoc index 731c557e730..527e961960b 100644 --- a/docs/reference/mapping/params/similarity.asciidoc +++ b/docs/reference/mapping/params/similarity.asciidoc @@ -48,7 +48,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `default_field` uses the `classic` similarity (ie TF/IDF). <2> The `bm25_field` uses the `BM25` similarity. diff --git a/docs/reference/mapping/params/store.asciidoc b/docs/reference/mapping/params/store.asciidoc index 9c30217c146..d34d1016546 100644 --- a/docs/reference/mapping/params/store.asciidoc +++ b/docs/reference/mapping/params/store.asciidoc @@ -51,7 +51,7 @@ GET my_index/_search "fields": [ "title", "date" ] <2> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `title` and `date` fields are stored. <2> This request will retrieve the values of the `title` and `date` fields. diff --git a/docs/reference/mapping/params/term-vector.asciidoc b/docs/reference/mapping/params/term-vector.asciidoc index 136ab084149..121ab39a6df 100644 --- a/docs/reference/mapping/params/term-vector.asciidoc +++ b/docs/reference/mapping/params/term-vector.asciidoc @@ -62,7 +62,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The fast vector highlighter will be used by default for the `text` field because term vectors are enabled. diff --git a/docs/reference/mapping/types/array.asciidoc b/docs/reference/mapping/types/array.asciidoc index 2422e48e3d1..a1bf9f1eb65 100644 --- a/docs/reference/mapping/types/array.asciidoc +++ b/docs/reference/mapping/types/array.asciidoc @@ -75,7 +75,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `tags` field is dynamically added as a `string` field. <2> The `lists` field is dynamically added as an `object` field. <3> The second document contains no arrays, but can be indexed into the same fields. diff --git a/docs/reference/mapping/types/boolean.asciidoc b/docs/reference/mapping/types/boolean.asciidoc index 65f03942fc2..914646a7220 100644 --- a/docs/reference/mapping/types/boolean.asciidoc +++ b/docs/reference/mapping/types/boolean.asciidoc @@ -44,7 +44,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Indexing a document with a JSON `true`. <2> Querying for the document with `1`, which is interpreted as `true`. @@ -81,7 +81,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Inline scripts must be <> for this example to work. [[boolean-params]] diff --git a/docs/reference/mapping/types/date.asciidoc b/docs/reference/mapping/types/date.asciidoc index 3756717b0d1..0f3c8a7862c 100644 --- a/docs/reference/mapping/types/date.asciidoc +++ b/docs/reference/mapping/types/date.asciidoc @@ -50,7 +50,7 @@ GET my_index/_search "sort": { "date": "asc"} <5> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `date` field uses the default `format`. <2> This document uses a plain date. <3> This document includes a time. @@ -81,7 +81,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [[date-params]] ==== Parameters for `date` fields diff --git a/docs/reference/mapping/types/geo-point.asciidoc b/docs/reference/mapping/types/geo-point.asciidoc index 45c5e65addb..909d9444527 100644 --- a/docs/reference/mapping/types/geo-point.asciidoc +++ b/docs/reference/mapping/types/geo-point.asciidoc @@ -74,7 +74,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Geo-point expressed as an object, with `lat` and `lon` keys. <2> Geo-point expressed as a string with the format: `"lat,lon"`. <3> Geo-point expressed as a geohash. diff --git a/docs/reference/mapping/types/ip.asciidoc b/docs/reference/mapping/types/ip.asciidoc index 624bf63660f..4bcfe553c5c 100644 --- a/docs/reference/mapping/types/ip.asciidoc +++ b/docs/reference/mapping/types/ip.asciidoc @@ -33,7 +33,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [[ip-params]] diff --git a/docs/reference/mapping/types/keyword.asciidoc b/docs/reference/mapping/types/keyword.asciidoc index 48fbf3cd75b..2ae1008c01b 100644 --- a/docs/reference/mapping/types/keyword.asciidoc +++ b/docs/reference/mapping/types/keyword.asciidoc @@ -28,7 +28,7 @@ PUT my_index } } -------------------------------- -// AUTOSENSE +// CONSOLE [[keyword-params]] ==== Parameters for keyword fields diff --git a/docs/reference/mapping/types/nested.asciidoc b/docs/reference/mapping/types/nested.asciidoc index 90b54fafb04..8850763cdc8 100644 --- a/docs/reference/mapping/types/nested.asciidoc +++ b/docs/reference/mapping/types/nested.asciidoc @@ -29,7 +29,7 @@ PUT my_index/my_type/1 ] } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `user` field is dynamically added as a field of type `object`. would be transformed internally into a document that looks more like this: @@ -61,7 +61,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] ==== Using `nested` fields for arrays of objects @@ -143,7 +143,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `user` field is mapped as type `nested` instead of type `object`. <2> This query doesn't match because `Alice` and `Smith` are not in the same nested object. <3> This query matches because `Alice` and `White` are in the same nested object. diff --git a/docs/reference/mapping/types/numeric.asciidoc b/docs/reference/mapping/types/numeric.asciidoc index 25d14386b8c..6982047db34 100644 --- a/docs/reference/mapping/types/numeric.asciidoc +++ b/docs/reference/mapping/types/numeric.asciidoc @@ -31,7 +31,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE [[number-params]] ==== Parameters for numeric fields diff --git a/docs/reference/mapping/types/object.asciidoc b/docs/reference/mapping/types/object.asciidoc index 6d35e6aee97..202c05512fe 100644 --- a/docs/reference/mapping/types/object.asciidoc +++ b/docs/reference/mapping/types/object.asciidoc @@ -18,7 +18,7 @@ PUT my_index/my_type/1 } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The outer document is also a JSON object. <2> It contains an inner object called `manager`. <3> Which in turn contains an inner object called `name`. @@ -64,7 +64,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The mapping type is a type of object, and has a `properties` field. <2> The `manager` field is an inner `object` field. <3> The `manager.name` field is an inner `object` field within the `manager` field. diff --git a/docs/reference/mapping/types/text.asciidoc b/docs/reference/mapping/types/text.asciidoc index 4a5be8287e8..7e51f4d6724 100644 --- a/docs/reference/mapping/types/text.asciidoc +++ b/docs/reference/mapping/types/text.asciidoc @@ -30,7 +30,7 @@ PUT my_index } } -------------------------------- -// AUTOSENSE +// CONSOLE Sometimes it is useful to have both a full text (`text`) and a keyword (`keyword`) version of the same field: one for full text search and the diff --git a/docs/reference/mapping/types/token-count.asciidoc b/docs/reference/mapping/types/token-count.asciidoc index baa6d409ead..c472c7c7770 100644 --- a/docs/reference/mapping/types/token-count.asciidoc +++ b/docs/reference/mapping/types/token-count.asciidoc @@ -43,7 +43,7 @@ GET my_index/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `name` field is an analyzed string field which uses the default `standard` analyzer. <2> The `name.length` field is a `token_count` <> which will index the number of tokens in the `name` field. <3> This query matches only the document containing `Rachel Alice Williams`, as it contains three tokens. diff --git a/docs/reference/migration/migrate_5_0/mapping.asciidoc b/docs/reference/migration/migrate_5_0/mapping.asciidoc index 2da16a62309..233ef84ae09 100644 --- a/docs/reference/migration/migrate_5_0/mapping.asciidoc +++ b/docs/reference/migration/migrate_5_0/mapping.asciidoc @@ -71,7 +71,7 @@ PUT my_index } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE Also the `precision_step` parameter is now irrelevant and will be rejected on indices that are created on or after 5.0. diff --git a/docs/reference/modules/cluster/allocation_filtering.asciidoc b/docs/reference/modules/cluster/allocation_filtering.asciidoc index fbdeb64909f..533a3e83c6c 100644 --- a/docs/reference/modules/cluster/allocation_filtering.asciidoc +++ b/docs/reference/modules/cluster/allocation_filtering.asciidoc @@ -21,7 +21,7 @@ PUT _cluster/settings } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE NOTE: Shards will only be relocated if it is possible to do so without breaking another routing constraint, such as never allocating a primary and @@ -66,5 +66,5 @@ PUT _cluster/settings } } ------------------------ -// AUTOSENSE +// CONSOLE // TEST[skip:indexes don't assign] diff --git a/docs/reference/modules/cluster/disk_allocator.asciidoc b/docs/reference/modules/cluster/disk_allocator.asciidoc index fdd8fc5036b..b6289e37c73 100644 --- a/docs/reference/modules/cluster/disk_allocator.asciidoc +++ b/docs/reference/modules/cluster/disk_allocator.asciidoc @@ -65,7 +65,7 @@ PUT _cluster/settings } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE NOTE: Prior to 2.0.0, when using multiple data paths, the disk threshold decider only factored in the usage across all data paths (if you had two diff --git a/docs/reference/modules/node.asciidoc b/docs/reference/modules/node.asciidoc index 2cb59c6de3a..124d68f1d6d 100644 --- a/docs/reference/modules/node.asciidoc +++ b/docs/reference/modules/node.asciidoc @@ -157,7 +157,7 @@ PUT _cluster/settings } } ---------------------------- -// AUTOSENSE +// CONSOLE // TEST[catch:/cannot set discovery.zen.minimum_master_nodes to more than the current master nodes/] TIP: An advantage of splitting the master and data roles between dedicated diff --git a/docs/reference/modules/scripting/fields.asciidoc b/docs/reference/modules/scripting/fields.asciidoc index 9ddf8267db6..35e1488fc28 100644 --- a/docs/reference/modules/scripting/fields.asciidoc +++ b/docs/reference/modules/scripting/fields.asciidoc @@ -79,7 +79,7 @@ GET my_index/_search } } ------------------------------------- -// AUTOSENSE +// CONSOLE [float] @@ -113,7 +113,7 @@ GET my_index/_search } } ------------------------------- -// AUTOSENSE +// CONSOLE Doc-values can only return "simple" field values like numbers, dates, geo- points, terms, etc, or arrays of these values if the field is multi-valued. @@ -211,7 +211,7 @@ GET my_index/_search } } ------------------------------- -// AUTOSENSE +// CONSOLE <1> The `title` field is not stored and so cannot be used with the `_fields[]` syntax. <2> The `title` field can still be accessed from the `_source`. diff --git a/docs/reference/modules/scripting/painless.asciidoc b/docs/reference/modules/scripting/painless.asciidoc index b8c4c2cc81f..4f7d36f38f5 100644 --- a/docs/reference/modules/scripting/painless.asciidoc +++ b/docs/reference/modules/scripting/painless.asciidoc @@ -66,7 +66,7 @@ PUT hockey/player/_bulk?refresh {"index":{"_id":11}} {"first":"joe","last":"colborne","goals":[3,18,13],"assists":[6,20,24],"gp":[26,67,82]} ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE // TESTSETUP [float] @@ -92,7 +92,7 @@ GET hockey/_search } } ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE Alternatively, you could do the same thing using a script field instead of a function score: @@ -113,7 +113,7 @@ GET hockey/_search } } ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE The following example uses a Painless script to sort the players by their combined first and last names. The names are accessed using `input.doc['first'].value` and `input.doc['last'].value`. @@ -137,7 +137,7 @@ GET hockey/_search } } ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE [float] === Updating Fields with Painless @@ -161,7 +161,7 @@ GET hockey/_search } } ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE To change player 1's last name to `hockey`, simply set `input.ctx._source.last` to the new value: @@ -178,7 +178,7 @@ POST hockey/player/1/_update } } ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE You can also add fields to a document. For example, this script adds a new field that contains the player's nickname, _hockey_. @@ -197,7 +197,7 @@ POST hockey/player/1/_update } } ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE [float] === Writing Type-Safe Scripts to Improve Performance @@ -229,7 +229,7 @@ GET hockey/_search } } ---------------------------------------------------------------- -// AUTOSENSE +// CONSOLE [[painless-api]] [float] diff --git a/docs/reference/modules/scripting/using.asciidoc b/docs/reference/modules/scripting/using.asciidoc index 81636f6189e..856311fac24 100644 --- a/docs/reference/modules/scripting/using.asciidoc +++ b/docs/reference/modules/scripting/using.asciidoc @@ -41,7 +41,7 @@ GET my_index/_search } } ------------------------------------- -// AUTOSENSE +// CONSOLE [float] @@ -191,7 +191,7 @@ POST _scripts/groovy/calculate-score "script": "log(_score * 2) + my_modifier" } ----------------------------------- -// AUTOSENSE +// CONSOLE This same script can be retrieved with: @@ -199,7 +199,7 @@ This same script can be retrieved with: ----------------------------------- GET _scripts/groovy/calculate-score ----------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] Stored scripts can be used by specifying the `lang` and `id` parameters as follows: @@ -221,7 +221,7 @@ GET _search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] And deleted with: @@ -230,7 +230,7 @@ And deleted with: ----------------------------------- DELETE _scripts/groovy/calculate-score ----------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] NOTE: The size of stored scripts is limited to 65,535 bytes. This can be diff --git a/docs/reference/modules/snapshots.asciidoc b/docs/reference/modules/snapshots.asciidoc index 76042d6b516..6c5245ce646 100644 --- a/docs/reference/modules/snapshots.asciidoc +++ b/docs/reference/modules/snapshots.asciidoc @@ -28,7 +28,7 @@ Once a repository is registered, its information can be obtained using the follo ----------------------------------- GET /_snapshot/my_backup ----------------------------------- -// AUTOSENSE +// CONSOLE which returns: @@ -180,7 +180,7 @@ PUT /_snapshot/s3_repository?verify=false } } ----------------------------------- -// AUTOSENSE +// CONSOLE The verification process can also be executed manually by running the following command: @@ -188,7 +188,7 @@ The verification process can also be executed manually by running the following ----------------------------------- POST /_snapshot/s3_repository/_verify ----------------------------------- -// AUTOSENSE +// CONSOLE It returns a list of nodes where repository was successfully verified or an error message if verification process failed. @@ -203,7 +203,7 @@ command: ----------------------------------- PUT /_snapshot/my_backup/snapshot_1?wait_for_completion=true ----------------------------------- -// AUTOSENSE +// CONSOLE The `wait_for_completion` parameter specifies whether or not the request should return immediately after snapshot initialization (default) or wait for snapshot completion. During snapshot initialization, information about all @@ -222,7 +222,7 @@ PUT /_snapshot/my_backup/snapshot_1 "include_global_state": false } ----------------------------------- -// AUTOSENSE +// CONSOLE The list of indices that should be included into the snapshot can be specified using the `indices` parameter that supports <>. The snapshot request also supports the @@ -258,7 +258,7 @@ Once a snapshot is created information about this snapshot can be obtained using ----------------------------------- GET /_snapshot/my_backup/snapshot_1 ----------------------------------- -// AUTOSENSE +// CONSOLE Similar as for repositories, information about multiple snapshots can be queried in one go, supporting wildcards as well: @@ -266,7 +266,7 @@ Similar as for repositories, information about multiple snapshots can be queried ----------------------------------- GET /_snapshot/my_backup/snapshot_*,some_other_snapshot ----------------------------------- -// AUTOSENSE +// CONSOLE All snapshots currently stored in the repository can be listed using the following command: @@ -274,7 +274,7 @@ All snapshots currently stored in the repository can be listed using the followi ----------------------------------- GET /_snapshot/my_backup/_all ----------------------------------- -// AUTOSENSE +// CONSOLE The command fails if some of the snapshots are unavailable. The boolean parameter `ignore_unvailable` can be used to return all snapshots that are currently available. @@ -292,7 +292,7 @@ A snapshot can be deleted from the repository using the following command: ----------------------------------- DELETE /_snapshot/my_backup/snapshot_1 ----------------------------------- -// AUTOSENSE +// CONSOLE When a snapshot is deleted from a repository, Elasticsearch deletes all files that are associated with the deleted snapshot and not used by any other snapshots. If the deleted snapshot operation is executed while the snapshot is being @@ -306,7 +306,7 @@ A repository can be deleted using the following command: ----------------------------------- DELETE /_snapshot/my_backup ----------------------------------- -// AUTOSENSE +// CONSOLE When a repository is deleted, Elasticsearch only removes the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place. @@ -320,7 +320,7 @@ A snapshot can be restored using the following command: ----------------------------------- POST /_snapshot/my_backup/snapshot_1/_restore ----------------------------------- -// AUTOSENSE +// CONSOLE By default, all indices in the snapshot as well as cluster state are restored. It's possible to select indices that should be restored as well as prevent global cluster state from being restored by using `indices` and @@ -341,7 +341,7 @@ POST /_snapshot/my_backup/snapshot_1/_restore "rename_replacement": "restored_index_$1" } ----------------------------------- -// AUTOSENSE +// CONSOLE The restore operation can be performed on a functioning cluster. However, an existing index can be only restored if it's <> and has the same number of shards as the index in the snapshot. @@ -378,7 +378,7 @@ POST /_snapshot/my_backup/snapshot_1/_restore ] } ----------------------------------- -// AUTOSENSE +// CONSOLE Please note, that some settings such as `index.number_of_shards` cannot be changed during restore operation. @@ -413,7 +413,7 @@ A list of currently running snapshots with their detailed status information can ----------------------------------- GET /_snapshot/_status ----------------------------------- -// AUTOSENSE +// CONSOLE In this format, the command will return information about all currently running snapshots. By specifying a repository name, it's possible to limit the results to a particular repository: @@ -422,7 +422,7 @@ to limit the results to a particular repository: ----------------------------------- GET /_snapshot/my_backup/_status ----------------------------------- -// AUTOSENSE +// CONSOLE If both repository name and snapshot id are specified, this command will return detailed status information for the given snapshot even if it's not currently running: @@ -431,7 +431,7 @@ if it's not currently running: ----------------------------------- GET /_snapshot/my_backup/snapshot_1/_status ----------------------------------- -// AUTOSENSE +// CONSOLE Multiple ids are also supported: @@ -439,7 +439,7 @@ Multiple ids are also supported: ----------------------------------- GET /_snapshot/my_backup/snapshot_1,snapshot_2/_status ----------------------------------- -// AUTOSENSE +// CONSOLE [float] === Monitoring snapshot/restore progress @@ -454,7 +454,7 @@ The snapshot operation can be also monitored by periodic calls to the snapshot i ----------------------------------- GET /_snapshot/my_backup/snapshot_1 ----------------------------------- -// AUTOSENSE +// CONSOLE Please note that snapshot info operation uses the same resources and thread pool as the snapshot operation. So, executing a snapshot info operation while large shards are being snapshotted can cause the snapshot info operation to wait @@ -466,7 +466,7 @@ To get more immediate and complete information about snapshots the snapshot stat ----------------------------------- GET /_snapshot/my_backup/snapshot_1/_status ----------------------------------- -// AUTOSENSE +// CONSOLE While snapshot info method returns only basic information about the snapshot in progress, the snapshot status returns complete breakdown of the current state for each shard participating in the snapshot. diff --git a/docs/reference/query-dsl/bool-query.asciidoc b/docs/reference/query-dsl/bool-query.asciidoc index ab39eb49611..8fcd66129cd 100644 --- a/docs/reference/query-dsl/bool-query.asciidoc +++ b/docs/reference/query-dsl/bool-query.asciidoc @@ -69,7 +69,7 @@ POST _search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE ==== Scoring with `bool.filter` @@ -96,7 +96,7 @@ GET _search } } --------------------------------- -// AUTOSENSE +// CONSOLE This `bool` query has a `match_all` query, which assigns a score of `1.0` to all documents. @@ -119,7 +119,7 @@ GET _search } } --------------------------------- -// AUTOSENSE +// CONSOLE This `constant_score` query behaves in exactly the same way as the second example above. The `constant_score` query assigns a score of `1.0` to all documents matched @@ -140,7 +140,7 @@ GET _search } } --------------------------------- -// AUTOSENSE +// CONSOLE ==== Using named queries to see which clauses matched diff --git a/docs/reference/query-dsl/function-score-query.asciidoc b/docs/reference/query-dsl/function-score-query.asciidoc index 3f9943d90d0..5f92d8c172c 100644 --- a/docs/reference/query-dsl/function-score-query.asciidoc +++ b/docs/reference/query-dsl/function-score-query.asciidoc @@ -491,7 +491,7 @@ GET _search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE Next, we show how the computed score looks like for each of the three possible decay functions. diff --git a/docs/reference/query-dsl/term-query.asciidoc b/docs/reference/query-dsl/term-query.asciidoc index b27885ac1ed..bdb62b4d698 100644 --- a/docs/reference/query-dsl/term-query.asciidoc +++ b/docs/reference/query-dsl/term-query.asciidoc @@ -13,7 +13,7 @@ POST _search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> Finds documents which contain the exact term `Kimchy` in the inverted index of the `user` field. @@ -45,7 +45,7 @@ GET _search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `urgent` query clause has a boost of `2.0`, meaning it is twice as important as the query clause for `normal`. @@ -107,7 +107,7 @@ PUT my_index/my_type/1 "exact_value": "Quick Foxes!" <4> } -------------------------------------------------- -// AUTOSENSE +// CONSOLE <1> The `full_text` field is of type `text` and will be analyzed. <2> The `exact_value` field is of type `keyword` and will NOT be analyzed. @@ -154,7 +154,7 @@ GET my_index/my_type/_search } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[continued] <1> This query matches because the `exact_value` field contains the exact diff --git a/docs/reference/setup/cluster_restart.asciidoc b/docs/reference/setup/cluster_restart.asciidoc index 1dbb6e7616d..7f9f8f89afa 100644 --- a/docs/reference/setup/cluster_restart.asciidoc +++ b/docs/reference/setup/cluster_restart.asciidoc @@ -24,7 +24,7 @@ PUT _cluster/settings } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[skip:indexes don't assign] ==== Step 2: Perform a synced flush @@ -36,7 +36,7 @@ Shard recovery will be much faster if you stop indexing and issue a -------------------------------------------------- POST _flush/synced -------------------------------------------------- -// AUTOSENSE +// CONSOLE A synced flush request is a ``best effort'' operation. It will fail if there are any pending indexing operations, but it is safe to reissue the request @@ -72,7 +72,7 @@ GET _cat/health GET _cat/nodes -------------------------------------------------- -// AUTOSENSE +// CONSOLE Use these APIs to check that all nodes have successfully joined the cluster. @@ -104,7 +104,7 @@ PUT _cluster/settings } } ------------------------------------------------------ -// AUTOSENSE +// CONSOLE The cluster will now start allocating replica shards to all data nodes. At this point it is safe to resume indexing and searching, but your cluster will @@ -120,7 +120,7 @@ GET _cat/health GET _cat/recovery -------------------------------------------------- -// AUTOSENSE +// CONSOLE Once the `status` column in the `_cat/health` output has reached `green`, all primary and replica shards have been successfully allocated. diff --git a/docs/reference/setup/rolling_upgrade.asciidoc b/docs/reference/setup/rolling_upgrade.asciidoc index 8c098a1ac04..5ba578ce768 100644 --- a/docs/reference/setup/rolling_upgrade.asciidoc +++ b/docs/reference/setup/rolling_upgrade.asciidoc @@ -28,7 +28,7 @@ PUT _cluster/settings } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE // TEST[skip:indexes don't assign] ==== Step 2: Stop non-essential indexing and perform a synced flush (Optional) @@ -41,7 +41,7 @@ will be much faster if you temporarily stop non-essential indexing and issue a -------------------------------------------------- POST _flush/synced -------------------------------------------------- -// AUTOSENSE +// CONSOLE A synced flush request is a ``best effort'' operation. It will fail if there are any pending indexing operations, but it is safe to reissue the request @@ -103,7 +103,7 @@ the log file or by checking the output of this request: -------------------------------------------------- GET _cat/nodes -------------------------------------------------- -// AUTOSENSE +// CONSOLE ==== Step 6: Reenable shard allocation @@ -119,7 +119,7 @@ PUT _cluster/settings } } -------------------------------------------------- -// AUTOSENSE +// CONSOLE ==== Step 7: Wait for the node to recover @@ -131,7 +131,7 @@ request: -------------------------------------------------- GET _cat/health -------------------------------------------------- -// AUTOSENSE +// CONSOLE Wait for the `status` column to move from `yellow` to `green`. Status `green` means that all primary and replica shards have been allocated. @@ -164,7 +164,7 @@ recover. The recovery status of individual shards can be monitored with the -------------------------------------------------- GET _cat/recovery -------------------------------------------------- -// AUTOSENSE +// CONSOLE If you stopped indexing, then it is safe to resume indexing as soon as recovery has completed.