redirects.asciidoc 31 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084
  1. ["appendix",role="exclude",id="redirects"]
  2. = Deleted pages
  3. The following pages have moved or been deleted.
  4. [role="exclude",id="cluster-nodes-shutdown"]
  5. === Nodes shutdown
  6. The `_shutdown` API has been removed. Instead, setup Elasticsearch to run as
  7. a service (see <<rpm>>, <<deb>>, or <<windows>>) or use the `-p`
  8. command line option to <<setup-installation-daemon,write the PID to a file>>.
  9. [role="exclude",id="indices-upgrade"]
  10. === Upgrade API
  11. The `_upgrade` API is no longer useful and will be removed. Instead, see
  12. <<reindex-upgrade>>.
  13. [role="exclude",id="migration-api-assistance"]
  14. === Migration Assistance API
  15. The Migration Assistance API has been replaced with the
  16. <<migration-api-deprecation, Deprecation Info API>>.
  17. [role="exclude",id="migration-api-upgrade"]
  18. === Migration Upgrade API
  19. The Migration Upgrade API has been removed. Use the
  20. {kibana-ref}/upgrade-assistant.html[{kib} Upgrade Assistant] or
  21. <<reindex-upgrade,Reindex manually>> instead.
  22. [role="exclude",id="docs-bulk-udp"]
  23. === Bulk UDP API
  24. The Bulk UDP services has been removed. Use the standard <<docs-bulk>> instead.
  25. [role="exclude",id="indices-delete-mapping"]
  26. === Delete Mapping
  27. It is no longer possible to delete the mapping for a type. Instead you should
  28. <<indices-delete-index,delete the index>> and recreate it with the new mappings.
  29. [role="exclude",id="indices-status"]
  30. === Index Status
  31. The index `_status` API has been replaced with the <<indices-stats>> and
  32. <<indices-recovery>> APIs.
  33. [role="exclude",id="mapping-analyzer-field"]
  34. === `_analyzer`
  35. The `_analyzer` field in type mappings is no longer supported and will be
  36. automatically removed from mappings when upgrading to 2.x.
  37. [role="exclude",id="mapping-boost-field"]
  38. === `_boost`
  39. The `_boost` field in type mappings is no longer supported and will be
  40. automatically removed from mappings when upgrading to 2.x.
  41. [role="exclude",id="mapping-conf-mappings"]
  42. === Config mappings
  43. It is no longer possible to specify mappings in files in the `config`
  44. directory. Instead, mappings should be created using the API with:
  45. * <<indices-create-index>>
  46. * <<indices-put-mapping>>
  47. * <<indices-templates>>
  48. [role="exclude",id="mapping-parent-field"]
  49. === `_parent` field
  50. The `_parent` field has been removed in favour of the <<parent-join,`join` field>>.
  51. [role="exclude",id="mapping-uid-field"]
  52. === `_uid` field
  53. The `_uid` field has been removed in favour of the <<mapping-id-field,`_id` field>>.
  54. [role="exclude",id="modules-memcached"]
  55. === memcached
  56. The `memcached` transport is no longer supported. Instead use the REST
  57. interface over <<modules-http,HTTP>>.
  58. [role="exclude",id="modules-thrift"]
  59. === Thrift
  60. The `thrift` transport is no longer supported. Instead use the REST
  61. interface over <<modules-http,HTTP>>.
  62. // QUERY DSL
  63. [role="exclude",id="query-dsl-queries"]
  64. === Queries
  65. Queries and filters have been merged. Any query clause can now be used as a query
  66. in ``query context'' and as a filter in ``filter context'' (see <<query-dsl>>).
  67. [role="exclude",id="query-dsl-filters"]
  68. === Filters
  69. Queries and filters have been merged. Any query clause can now be used as a query
  70. in ``query context'' and as a filter in ``filter context'' (see <<query-dsl>>).
  71. [role="exclude",id="query-dsl-not-filter"]
  72. === Not Filter
  73. The `not` query has been replaced by using a `must_not` clause in a `bool` query (see <<query-dsl-bool-query>>).
  74. [role="exclude",id="query-dsl-bool-filter"]
  75. === Bool Filter
  76. The `bool` filter has been replaced by the <<query-dsl-bool-query>>. It behaves
  77. as a query in ``query context'' and as a filter in ``filter context'' (see
  78. <<query-dsl>>).
  79. [role="exclude",id="query-dsl-exists-filter"]
  80. === Exists Filter
  81. The `exists` filter has been replaced by the <<query-dsl-exists-query>>. It behaves
  82. as a query in ``query context'' and as a filter in ``filter context'' (see
  83. <<query-dsl>>).
  84. [role="exclude",id="query-dsl-geo-bounding-box-filter"]
  85. === Geo Bounding Box Filter
  86. The `geo_bounding_box` filter has been replaced by the <<query-dsl-geo-bounding-box-query>>.
  87. It behaves as a query in ``query context'' and as a filter in ``filter
  88. context'' (see <<query-dsl>>).
  89. [role="exclude",id="query-dsl-geo-distance-filter"]
  90. === Geo Distance Filter
  91. The `geo_distance` filter has been replaced by the <<query-dsl-geo-distance-query>>.
  92. It behaves as a query in ``query context'' and as a filter in ``filter
  93. context'' (see <<query-dsl>>).
  94. [role="exclude",id="query-dsl-geo-distance-range-filter"]
  95. === Geo Distance Range Filter
  96. The `geo_distance_range` filter has been replaced by the <<query-dsl-geo-distance-range-query>>.
  97. It behaves as a query in ``query context'' and as a filter in ``filter
  98. context'' (see <<query-dsl>>).
  99. [role="exclude",id="query-dsl-geo-polygon-filter"]
  100. === Geo Polygon Filter
  101. The `geo_polygon` filter has been replaced by the <<query-dsl-geo-polygon-query>>.
  102. It behaves as a query in ``query context'' and as a filter in ``filter
  103. context'' (see <<query-dsl>>).
  104. [role="exclude",id="query-dsl-geo-shape-filter"]
  105. === Geo Shape Filter
  106. The `geo_shape` filter has been replaced by the <<query-dsl-geo-shape-query>>.
  107. It behaves as a query in ``query context'' and as a filter in ``filter
  108. context'' (see <<query-dsl>>).
  109. [role="exclude",id="query-dsl-has-child-filter"]
  110. === Has Child Filter
  111. The `has_child` filter has been replaced by the <<query-dsl-has-child-query>>. It behaves
  112. as a query in ``query context'' and as a filter in ``filter context'' (see
  113. <<query-dsl>>).
  114. [role="exclude",id="query-dsl-has-parent-filter"]
  115. === Has Parent Filter
  116. The `has_parent` filter has been replaced by the <<query-dsl-has-parent-query>>. It behaves
  117. as a query in ``query context'' and as a filter in ``filter context'' (see
  118. <<query-dsl>>).
  119. [role="exclude",id="query-dsl-top-children-query"]
  120. === Top Children Query
  121. The `top_children` query has been removed. Use the <<query-dsl-has-child-query>> instead.
  122. [role="exclude",id="query-dsl-ids-filter"]
  123. === IDs Filter
  124. The `ids` filter has been replaced by the <<query-dsl-ids-query>>. It behaves
  125. as a query in ``query context'' and as a filter in ``filter context'' (see
  126. <<query-dsl>>).
  127. [role="exclude",id="query-dsl-match-all-filter"]
  128. === Match All Filter
  129. The `match_all` filter has been replaced by the <<query-dsl-match-all-query>>. It behaves
  130. as a query in ``query context'' and as a filter in ``filter context'' (see
  131. <<query-dsl>>).
  132. [role="exclude",id="query-dsl-nested-filter"]
  133. === Nested Filter
  134. The `nested` filter has been replaced by the <<query-dsl-nested-query>>. It behaves
  135. as a query in ``query context'' and as a filter in ``filter context'' (see
  136. <<query-dsl>>).
  137. [role="exclude",id="query-dsl-prefix-filter"]
  138. === Prefix Filter
  139. The `prefix` filter has been replaced by the <<query-dsl-prefix-query>>. It behaves
  140. as a query in ``query context'' and as a filter in ``filter context'' (see
  141. <<query-dsl>>).
  142. [role="exclude",id="query-dsl-query-filter"]
  143. === Query Filter
  144. The `query` filter has been removed as queries and filters have been merged (see
  145. <<query-dsl>>).
  146. [role="exclude",id="query-dsl-range-filter"]
  147. === Range Filter
  148. The `range` filter has been replaced by the <<query-dsl-range-query>>. It behaves
  149. as a query in ``query context'' and as a filter in ``filter context'' (see
  150. <<query-dsl>>).
  151. [role="exclude",id="query-dsl-regexp-filter"]
  152. === Regexp Filter
  153. The `regexp` filter has been replaced by the <<query-dsl-regexp-query>>. It behaves
  154. as a query in ``query context'' and as a filter in ``filter context'' (see
  155. <<query-dsl>>).
  156. [role="exclude",id="query-dsl-script-filter"]
  157. === Script Filter
  158. The `script` filter has been replaced by the <<query-dsl-script-query>>. It behaves
  159. as a query in ``query context'' and as a filter in ``filter context'' (see
  160. <<query-dsl>>).
  161. [role="exclude",id="query-dsl-term-filter"]
  162. === Term Filter
  163. The `term` filter has been replaced by the <<query-dsl-term-query>>. It behaves
  164. as a query in ``query context'' and as a filter in ``filter context'' (see
  165. <<query-dsl>>).
  166. [role="exclude",id="query-dsl-terms-filter"]
  167. === Terms Filter
  168. The `terms` filter has been replaced by the <<query-dsl-terms-query>>. It behaves
  169. as a query in ``query context'' and as a filter in ``filter context'' (see
  170. <<query-dsl>>).
  171. [role="exclude",id="query-dsl-flt-query"]
  172. === Fuzzy Like This Query
  173. The `fuzzy_like_this`, alternatively known as `flt`, query has been removed. Instead use either
  174. the <<query-dsl-match-query-fuzziness,`fuzziness`>> parameter with the
  175. <<query-dsl-match-query,`match` query>> or the <<query-dsl-mlt-query>>.
  176. [role="exclude",id="query-dsl-flt-field-query"]
  177. === Fuzzy Like This Field Query
  178. The `fuzzy_like_this_field` or `flt_field` query has been removed. Instead use
  179. the <<query-dsl-match-query-fuzziness,`fuzziness`>> parameter with the
  180. <<query-dsl-match-query,`match` query>> or the <<query-dsl-mlt-query>>.
  181. [role="exclude",id="query-dsl-geo-distance-range-query"]
  182. === Geo distance range Query
  183. The `geo_distance_range` query has been removed. Instead use the
  184. <<query-dsl-geo-distance-query, Geo Distance Query>> with pagination
  185. or the
  186. <<search-aggregations-bucket-geodistance-aggregation, Geo Distance Aggregation>>
  187. depending on your needs.
  188. [role="exclude",id="query-dsl-geohash-cell-query"]
  189. === Geohash Cell Query
  190. The `geohash_cell` query has been removed. Instead use the
  191. <<query-dsl-geo-bounding-box-query, Geo Bounding Box Query>>.
  192. [role="exclude",id="search-more-like-this"]
  193. === More Like This API
  194. The More Like This API has been removed. Instead, use the <<query-dsl-mlt-query>>.
  195. // FACETS
  196. [role="exclude",id="search-facets"]
  197. === Facets
  198. Faceted search refers to a way to explore large amounts of data by displaying
  199. summaries about various partitions of the data and later allowing to narrow
  200. the navigation to a specific partition.
  201. In Elasticsearch, `facets` are also the name of a feature that allowed to
  202. compute these summaries. `facets` have been replaced by
  203. <<search-aggregations, aggregations>> in Elasticsearch 1.0, which are a superset
  204. of facets.
  205. [role="exclude",id="search-facets-filter-facet"]
  206. === Filter Facet
  207. Facets have been removed. Use the
  208. <<search-aggregations-bucket-filter-aggregation,`filter` aggregation>> or
  209. <<search-aggregations-bucket-filters-aggregation,`filters` aggregation>> instead.
  210. [role="exclude",id="search-facets-query-facet"]
  211. === Query Facet
  212. Facets have been removed. Use the
  213. <<search-aggregations-bucket-filter-aggregation,`filter` aggregation>> or
  214. <<search-aggregations-bucket-filters-aggregation,`filters` aggregation>> instead.
  215. [role="exclude",id="search-facets-geo-distance-facet"]
  216. === Geo Distance Facet
  217. Facets have been removed. Use the
  218. <<search-aggregations-bucket-geodistance-aggregation,`geo_distance` aggregation>> instead.
  219. [role="exclude",id="search-facets-histogram-facet"]
  220. === Histogram Facet
  221. Facets have been removed. Use the
  222. <<search-aggregations-bucket-histogram-aggregation,`histogram` aggregation>> instead.
  223. [role="exclude",id="search-facets-date-histogram-facet"]
  224. === Date Histogram Facet
  225. Facets have been removed. Use the
  226. <<search-aggregations-bucket-datehistogram-aggregation,`date_histogram` aggregation>> instead.
  227. [role="exclude",id="search-facets-range-facet"]
  228. === Range Facet
  229. Facets have been removed. Use the
  230. <<search-aggregations-bucket-range-aggregation,`range` aggregation>> instead.
  231. [role="exclude",id="search-facets-terms-facet"]
  232. === Terms Facet
  233. Facets have been removed. Use the
  234. <<search-aggregations-bucket-terms-aggregation,`terms` aggregation>> instead.
  235. [role="exclude",id="search-facets-terms-statistical-facet"]
  236. === Terms Stats Facet
  237. Facets have been removed. Use the
  238. <<search-aggregations-bucket-terms-aggregation,`terms` aggregation>>
  239. with the <<search-aggregations-metrics-stats-aggregation,`stats` aggregation>>
  240. or the <<search-aggregations-metrics-extendedstats-aggregation,`extended_stats` aggregation>>
  241. instead.
  242. [role="exclude",id="search-facets-statistical-facet"]
  243. === Statistical Facet
  244. Facets have been removed. Use the
  245. <<search-aggregations-metrics-stats-aggregation,`stats` aggregation>>
  246. or the <<search-aggregations-metrics-extendedstats-aggregation,`extended_stats` aggregation>> instead.
  247. [role="exclude",id="search-facets-migrating-to-aggs"]
  248. === Migrating from facets to aggregations
  249. Facets have been removed. Use <<search-aggregations>> instead.
  250. // CACHES
  251. [role="exclude",id="shard-query-cache"]
  252. === Shard request cache
  253. The shard query cache has been renamed <<shard-request-cache>>.
  254. [role="exclude",id="filter-cache"]
  255. === Query cache
  256. The filter cache has been renamed <<query-cache>>.
  257. [role="exclude",id="query-dsl-filtered-query"]
  258. === Filtered query
  259. The `filtered` query is replaced by the <<query-dsl-bool-query,bool>> query. Instead of
  260. the following:
  261. [source,js]
  262. -------------------------
  263. ## INCORRECT - DEPRECATED SYNTAX, DO NOT USE
  264. GET _search
  265. {
  266. "query": {
  267. "filtered": {
  268. "query": {
  269. "match": {
  270. "text": "quick brown fox"
  271. }
  272. },
  273. "filter": {
  274. "term": {
  275. "status": "published"
  276. }
  277. }
  278. }
  279. }
  280. }
  281. -------------------------
  282. // NOTCONSOLE
  283. move the query and filter to the `must` and `filter` parameters in the `bool`
  284. query:
  285. [source,console]
  286. -------------------------
  287. GET _search
  288. {
  289. "query": {
  290. "bool": {
  291. "must": {
  292. "match": {
  293. "text": "quick brown fox"
  294. }
  295. },
  296. "filter": {
  297. "term": {
  298. "status": "published"
  299. }
  300. }
  301. }
  302. }
  303. }
  304. -------------------------
  305. [role="exclude",id="query-dsl-or-query"]
  306. === Or query
  307. The `or` query is replaced in favour of the <<query-dsl-bool-query,bool>> query.
  308. [role="exclude",id="query-dsl-or-filter"]
  309. === Or filter
  310. The `or` filter is replaced in favour of the <<query-dsl-bool-query,bool>> query.
  311. [role="exclude",id="query-dsl-and-query"]
  312. === And query
  313. The `and` query is replaced in favour of the <<query-dsl-bool-query,bool>> query.
  314. [role="exclude",id="query-dsl-and-filter"]
  315. === And filter
  316. The `and` filter is replaced in favour of the <<query-dsl-bool-query,bool>> query.
  317. [role="exclude",id="query-dsl-limit-query"]
  318. === Limit query
  319. The `limit` query is replaced in favour of the <<search-request-body,terminate_after>>
  320. parameter of search requests.
  321. [role="exclude",id="query-dsl-limit-filter"]
  322. === Limit filter
  323. The `limit` filter is replaced in favour of the <<search-request-body,terminate_after>>
  324. parameter of search requests.
  325. [role="exclude",id="query-dsl-not-query"]
  326. === Not query
  327. The `not` query has been replaced by using a `mustNot` clause in a Boolean query.
  328. [role="exclude",id="mapping-nested-type"]
  329. === Nested type
  330. The docs for the `nested` field datatype have moved to <<nested>>.
  331. [role="exclude",id="indices-warmers"]
  332. === Warmers
  333. Warmers have been removed. There have been significant improvements to the
  334. index that make warmers not necessary anymore.
  335. [role="exclude",id="index-boost"]
  336. === Index time boosting
  337. The index time boost mapping has been replaced with query time boost (see <<mapping-boost>>).
  338. [role="exclude",id="modules-scripting-native"]
  339. === Native scripting
  340. Native scripts have been replaced with writing custom `ScriptEngine` backends (see <<modules-scripting-engine>>).
  341. [role="exclude",id="modules-advanced-scripting"]
  342. === Advanced scripting
  343. Using `_index` in scripts has been replaced with writing `ScriptEngine` backends (see <<modules-scripting-engine>>).
  344. [role="exclude",id="modules-scripting-painless-syntax"]
  345. === Painless Syntax
  346. See the
  347. {painless}/painless-lang-spec.html[Painless Language Specification]
  348. in the guide to the {painless}/index.html[Painless Scripting Language].
  349. [role="exclude",id="modules-scripting-painless-debugging"]
  350. === Painless Debugging
  351. See {painless}/painless-debugging.html[Painless Debugging] in the
  352. guide to the {painless}/index.html[Painless Scripting Language].
  353. [role="exclude",id="painless-api-reference"]
  354. === Painless Contexts API Reference
  355. See the {painless}/painless-api-reference.html[Painless Contexts API Reference]
  356. in the guide to the {painless}/index.html[Painless Scripting Language].
  357. [role="exclude", id="security-api-roles"]
  358. === Role management APIs
  359. You can use the following APIs to add, remove, and retrieve roles in the native realm:
  360. * <<security-api-put-role,Create role>>, <<security-api-delete-role,Delete role>>
  361. * <<security-api-clear-role-cache,Clear roles cache>>
  362. * <<security-api-get-role,Get roles>>
  363. [role="exclude",id="security-api-tokens"]
  364. === Token management APIs
  365. You can use the following APIs to create and invalidate bearer tokens for access
  366. without requiring basic authentication:
  367. * <<security-api-get-token,Get token>>, <<security-api-invalidate-token,Invalidate token>>
  368. [role="exclude",id="security-api-users"]
  369. === User Management APIs
  370. You can use the following APIs to create, read, update, and delete users from the
  371. native realm:
  372. * <<security-api-put-user,Create users>>, <<security-api-delete-user,Delete users>>
  373. * <<security-api-enable-user,Enable users>>, <<security-api-disable-user,Disable users>>
  374. * <<security-api-change-password,Change passwords>>
  375. * <<security-api-get-user,Get users>>
  376. [role="exclude",id="security-api-role-mapping"]
  377. === Role mapping APIs
  378. You can use the following APIs to add, remove, and retrieve role mappings:
  379. * <<security-api-put-role-mapping,Add role mappings>>, <<security-api-delete-role-mapping,Delete role mappings>>
  380. * <<security-api-get-role-mapping,Get role mappings>>
  381. [role="exclude",id="security-api-privileges"]
  382. === Privilege APIs
  383. See <<security-api-has-privileges>>.
  384. [role="exclude",id="xpack-commands"]
  385. === X-Pack commands
  386. See <<commands>>.
  387. [role="exclude",id="ml-api-definitions"]
  388. === Machine learning API definitions
  389. See <<api-definitions>>.
  390. [role="exclude",id="analysis-standard-tokenfilter"]
  391. === Standard filter removed
  392. The standard token filter has been removed.
  393. [role="exclude",id="modules-discovery-azure-classic"]
  394. See <<azure-classic-hosts-provider>>.
  395. [role="exclude",id="modules-discovery-ec2"]
  396. See <<ec2-hosts-provider>>.
  397. [role="exclude",id="modules-discovery-gce"]
  398. See <<gce-hosts-provider>>.
  399. [role="exclude",id="modules-discovery-zen"]
  400. Zen discovery is replaced by the <<modules-discovery,discovery and cluster
  401. formation module>>.
  402. [role="exclude",id="settings-xpack"]
  403. === {xpack} settings in {es}
  404. include::{asciidoc-dir}/../../shared/settings.asciidoc[]
  405. [role="exclude",id="_faster_phrase_queries_with_literal_index_phrases_literal"]
  406. See <<faster-phrase-queries>>.
  407. [role="exclude",id="_faster_prefix_queries_with_literal_index_prefixes_literal.html"]
  408. See <<faster-prefix-queries>>.
  409. [role="exclude",id="setup-xpack"]
  410. === Set up {xpack}
  411. {xpack} is an Elastic Stack extension that provides security, alerting,
  412. monitoring, reporting, machine learning, and many other capabilities. By default,
  413. when you install {es}, {xpack} is installed.
  414. [role="exclude",id="setup-xpack-client"]
  415. === Configuring {xpack} Java Clients
  416. The `TransportClient` is deprecated in favour of the
  417. {java-rest}/java-rest-high.html[Java High Level REST Client] and was removed in
  418. Elasticsearch 8.0. The
  419. {java-rest}/java-rest-high-level-migration.html[migration guide] describes all
  420. the steps needed to migrate.
  421. [role="exclude",id="query-dsl-common-terms-query"]
  422. === Common Terms Query
  423. The `common` terms query is deprecated. Use the <<query-dsl-match-query, `match`
  424. query>> instead. The `match` query skips blocks of documents efficiently,
  425. without any configuration, if the total number of hits is not tracked.
  426. [role="exclude",id="indices-types-exists"]
  427. === Types Exists
  428. The types exists endpoint has been removed. See <<removal-of-types>> for
  429. more details.
  430. [role="exclude",id="xpack-api"]
  431. === X-Pack APIs
  432. {es} {xpack} APIs are now documented in <<rest-apis, REST APIs>>.
  433. [role="exclude",id="ml-calendar-resource"]]
  434. === Calendar resources
  435. See <<ml-get-calendar>> and
  436. {stack-ov}/ml-calendars.html[Calendars and scheduled events].
  437. [role="exclude",id="ml-filter-resource"]
  438. === Filter resources
  439. See <<ml-get-filter>> and
  440. {stack-ov}/ml-rules.html[Machine learning custom rules].
  441. [role="exclude",id="ml-event-resource"]
  442. === Scheduled event resources
  443. See <<ml-get-calendar-event>> and
  444. {stack-ov}/ml-calendars.html[Calendars and scheduled events].
  445. [role="exclude",id="index-apis"]
  446. === Index APIs
  447. {es} index APIs are now documented in <<indices>>.
  448. [role="exclude",id="search-request-docvalue-fields"]
  449. === Doc value fields parameter for request body search API
  450. See <<request-body-search-docvalue-fields>>.
  451. [role="exclude",id="search-request-explain"]
  452. === Explain parameter for request body search API
  453. See <<request-body-search-explain>>.
  454. [role="exclude",id="search-request-collapse"]
  455. === Collapse parameter for request body search API
  456. See <<request-body-search-collapse>>.
  457. [role="exclude",id="search-request-from-size"]
  458. === From and size parameters for request body search API
  459. See <<request-body-search-from-size>>.
  460. [role="exclude",id="search-request-highlighting"]
  461. === Highlight parameter for request body search API
  462. See <<request-body-search-highlighting>>.
  463. [role="exclude",id="search-request-index-boost"]
  464. === Index boost parameter for request body search API
  465. See <<request-body-search-index-boost>>.
  466. [role="exclude",id="search-request-inner-hits"]
  467. === Inner hits parameter for request body search API
  468. See <<request-body-search-inner-hits>>.
  469. [role="exclude",id="search-request-min-score"]
  470. === Minimum score parameter for request body search API
  471. See <<request-body-search-min-score>>.
  472. [role="exclude",id="search-request-named-queries-and-filters"]
  473. === Named query parameter for request body search API
  474. See <<request-body-search-queries-and-filters>>.
  475. [role="exclude",id="search-request-post-filter"]
  476. === Post filter parameter for request body search API
  477. See <<request-body-search-post-filter>>.
  478. [role="exclude",id="search-request-preference"]
  479. === Preference parameter for request body search API
  480. See <<request-body-search-preference>>.
  481. [role="exclude",id="search-request-query"]
  482. === Query parameter for request body search API
  483. See <<request-body-search-query>>.
  484. [role="exclude",id="search-request-rescore"]
  485. === Rescoring parameter for request body search API
  486. See <<request-body-search-rescore>>.
  487. [role="exclude",id="search-request-script-fields"]
  488. === Script fields parameter for request body search API
  489. See <<request-body-search-script-fields>>.
  490. [role="exclude",id="search-request-scroll"]
  491. === Scroll parameter for request body search API
  492. See <<request-body-search-scroll>>.
  493. [role="exclude",id="search-request-search-after"]
  494. === Search after parameter for request body search API
  495. See <<request-body-search-search-after>>.
  496. [role="exclude",id="search-request-search-type"]
  497. === Search type parameter for request body search API
  498. See <<request-body-search-search-type>>.
  499. [role="exclude",id="search-request-seq-no-primary-term"]
  500. === Sequence numbers and primary terms parameter for request body search API
  501. See <<request-body-search-search-type>>.
  502. [role="exclude",id="search-request-sort"]
  503. === Sort parameter for request body search API
  504. See <<request-body-search-sort>>.
  505. [role="exclude",id="search-request-source-filtering"]
  506. === Source filtering parameter for request body search API
  507. See <<request-body-search-source-filtering>>.
  508. [role="exclude",id="search-request-stored-fields"]
  509. === Stored fields parameter for request body search API
  510. See <<request-body-search-stored-fields>>.
  511. [role="exclude",id="search-request-track-total-hits"]
  512. === Track total hits parameter for request body search API
  513. See <<request-body-search-track-total-hits>>.
  514. [role="exclude",id="search-request-version"]
  515. === Version parameter for request body search API
  516. See <<request-body-search-version>>.
  517. [role="exclude",id="search-suggesters-term"]
  518. === Term suggester
  519. See <<term-suggester>>.
  520. [role="exclude",id="search-suggesters-phrase"]
  521. === Phrase suggester
  522. See <<phrase-suggester>>.
  523. [role="exclude",id="search-suggesters-completion"]
  524. === Completion suggester
  525. See <<completion-suggester>>.
  526. [role="exclude",id="suggester-context"]
  527. === Context suggester
  528. See <<context-suggester>>.
  529. [role="exclude",id="returning-suggesters-type"]
  530. === Return suggester type
  531. See <<return-suggesters-type>>.
  532. [role="exclude",id="search-profile-queries"]
  533. === Profiling queries
  534. See <<profiling-queries>>.
  535. [role="exclude",id="search-profile-aggregations"]
  536. === Profiling aggregations
  537. See <<profiling-aggregations>>.
  538. [role="exclude",id="search-profile-considerations"]
  539. === Profiling considerations
  540. See <<profiling-considerations>>.
  541. [role="exclude",id="_explain_analyze"]
  542. === Explain analyze API
  543. See <<explain-analyze-api>>.
  544. [role="exclude",id="indices-synced-flush"]
  545. === Synced flush API
  546. See <<indices-synced-flush-api>>.
  547. [role="exclude",id="_repositories"]
  548. === Snapshot repositories
  549. See <<snapshots-repositories>>.
  550. [role="exclude",id="_snapshot"]
  551. === Snapshot
  552. See <<snapshots-take-snapshot>>.
  553. [role="exclude",id="getting-started-explore"]
  554. === Exploring your cluster
  555. See <<cat>>.
  556. [role="exclude",id="getting-started-cluster-health"]
  557. === Cluster health
  558. See <<cat-health>>.
  559. [role="exclude", id="getting-started-list-indices"]
  560. === List all indices
  561. See <<cat-indices>>.
  562. [role="exclude", id="getting-started-create-index"]
  563. === Create an index
  564. See <<indices-create-index>>.
  565. [role="exclude", id="getting-started-query-document"]
  566. === Index and query a document
  567. See <<getting-started-index>>.
  568. [role="exclude", id="getting-started-delete-index"]
  569. === Delete an index
  570. See <<indices-delete-index>>.
  571. [role="exclude", id="getting-started-modify-data"]
  572. == Modifying your data
  573. See <<docs-update>>.
  574. [role="exclude", id="indexing-replacing-documents"]
  575. === Indexing/replacing documents
  576. See <<docs-index_>>.
  577. [role="exclude", id="getting-started-explore-data"]
  578. === Exploring your data
  579. See <<getting-started-search>>.
  580. [role="exclude", id="getting-started-search-API"]
  581. === Search API
  582. See <<getting-started-search>>.
  583. [role="exclude", id="getting-started-conclusion"]
  584. === Conclusion
  585. See <<getting-started-next-steps>>.
  586. [role="exclude",id="ccs-reduction"]
  587. === {ccs-cap} reduction
  588. See <<ccs-works>>.
  589. [role="exclude",id="administer-elasticsearch"]
  590. === Administering {es}
  591. See <<high-availability>>.
  592. [role="exclude",id="slm-api"]
  593. === Snapshot lifecycle management API
  594. See <<snapshot-lifecycle-management-api>>.
  595. [role="exclude",id="delete-data-frame-transform"]
  596. === Delete {transforms} API
  597. See <<delete-transform>>.
  598. [role="exclude",id="get-data-frame-transform-stats"]
  599. === Get {transform} statistics API
  600. See <<get-transform-stats>>.
  601. [role="exclude",id="get-data-frame-transform"]
  602. === Get {transforms} API
  603. See <<get-transform>>.
  604. [role="exclude",id="preview-data-frame-transform"]
  605. === Preview {transforms} API
  606. See <<preview-transform>>.
  607. [role="exclude",id="put-data-frame-transform"]
  608. === Create {transforms} API
  609. See <<put-transform>>.
  610. [role="exclude",id="start-data-frame-transform"]
  611. === Start {transforms} API
  612. See <<start-transform>>.
  613. [role="exclude",id="stop-data-frame-transform"]
  614. === Stop {transforms} API
  615. See <<stop-transform>>.
  616. [role="exclude",id="update-data-frame-transform"]
  617. === Update {transforms} API
  618. See <<update-transform>>.
  619. [role="exclude",id="data-frame-apis"]
  620. === {transform-cap} APIs
  621. See <<transform-apis>>.
  622. [role="exclude",id="data-frame-transform-resource"]
  623. === {transform-cap} resources
  624. See <<transform-resource>>.
  625. [role="exclude",id="data-frame-transform-dest"]
  626. === Dest objects
  627. See <<transform-dest>>.
  628. [role="exclude",id="data-frame-transform-source"]
  629. ==== Source objects
  630. See <<transform-source>>.
  631. [role="exclude",id="data-frame-transform-pivot"]
  632. ==== Pivot objects
  633. See <<transform-pivot>>.
  634. [role="exclude",id="configuring-monitoring"]
  635. === Configuring monitoring
  636. See <<monitoring-overview>>.
  637. [role="exclude",id="es-monitoring"]
  638. === Monitoring {es}
  639. See <<monitor-elasticsearch-cluster>>.
  640. [role="exclude",id="docker-cli-run"]
  641. === Docker Run
  642. See <<docker-cli-run-dev-mode>>.
  643. [role="exclude",id="auditing"]
  644. === Audit logging
  645. See <<enable-audit-logging>>.
  646. [role="exclude",id="analysis-compound-word-tokenfilter"]
  647. === Compound word token filters
  648. See <<analysis-dict-decomp-tokenfilter>> and
  649. <<analysis-hyp-decomp-tokenfilter>>.
  650. [role="exclude",id="configuring-native-realm"]
  651. === Configuring a native realm
  652. See <<native-realm-configuration>>.
  653. [role="exclude",id="native-settings"]
  654. ==== Native realm settings
  655. See <<ref-native-settings>>.
  656. [role="exclude",id="configuring-saml-realm"]
  657. === Configuring a SAML realm
  658. See <<saml-guide>>.
  659. [role="exclude",id="saml-settings"]
  660. ==== SAML realm settings
  661. See <<ref-saml-settings>>.
  662. [role="exclude",id="_saml_realm_signing_settings"]
  663. ==== SAML realm signing settings
  664. See <<ref-saml-signing-settings>>.
  665. [role="exclude",id="_saml_realm_encryption_settings"]
  666. ==== SAML realm encryption settings
  667. See <<ref-saml-encryption-settings>>.
  668. [role="exclude",id="_saml_realm_ssl_settings"]
  669. ==== SAML realm SSL settings
  670. See <<ref-saml-ssl-settings>>.
  671. [role="exclude",id="configuring-file-realm"]
  672. === Configuring a file realm
  673. See <<file-realm-configuration>>.
  674. [role="exclude",id="ldap-user-search"]
  675. === User search mode and user DN templates mode
  676. See <<ldap-realm-configuration>>.
  677. [role="exclude",id="configuring-ldap-realm"]
  678. === Configuring an LDAP realm
  679. See <<ldap-realm-configuration>>.
  680. [role="exclude",id="ldap-settings"]
  681. === LDAP realm settings
  682. See <<ref-ldap-settings>>.
  683. [role="exclude",id="ldap-ssl"]
  684. === Setting up SSL between Elasticsearch and LDAP
  685. See <<tls-ldap>>.
  686. [role="exclude",id="configuring-kerberos-realm"]
  687. === Configuring a Kerberos realm
  688. See <<kerberos-realm-configuration>>.
  689. [role="exclude",id="beats"]
  690. === Beats and Security
  691. See:
  692. * {auditbeat-ref}/securing-beats.html[{auditbeat}]
  693. * {filebeat-ref}/securing-beats.html[{filebeat}]
  694. * {heartbeat-ref}/securing-beats.html[{heartbeat}]
  695. * {metricbeat-ref}/securing-beats.html[{metricbeat}]
  696. * {packetbeat-ref}/securing-beats.html[{packetbeat}]
  697. * {winlogbeat-ref}/securing-beats.html[{winlogbeat}]
  698. [role="exclude",id="configuring-pki-realm"]
  699. === Configuring a PKI realm
  700. See <<pki-realm>>.
  701. [role="exclude",id="pki-settings"]
  702. ==== PKI realm settings
  703. See <<ref-pki-settings>>.
  704. [role="exclude",id="configuring-ad-realm"]
  705. === Configuring an Active Directory realm
  706. See <<ad-realm-configuration>>.
  707. [role="exclude",id="ad-settings"]
  708. === Active Directory realm settings
  709. See <<ref-ad-settings>>.
  710. [role="exclude",id="mapping-roles-ad"]
  711. === Mapping Active Directory users and groups to roles
  712. See <<ad-realm-configuration>>.
  713. [role="exclude",id="how-security-works"]
  714. === How security works
  715. See <<elasticsearch-security>>.
  716. [role="exclude",id="rollup-job-config"]
  717. === Rollup job configuration
  718. See <<rollup-put-job-api-request-body>>.
  719. [role="exclude",id="ml-job-resource"]
  720. === Job resources
  721. This page was deleted.
  722. [[ml-analysisconfig]]
  723. See the details in
  724. [[ml-apimodelplotconfig]]
  725. <<ml-put-job>>, <<ml-update-job>>, and <<ml-get-job>>.
  726. [role="exclude",id="ml-datafeed-resource"]
  727. === {dfeed-cap} resources
  728. This page was deleted.
  729. [[ml-datafeed-chunking-config]]
  730. See the details in <<ml-put-datafeed>>, <<ml-update-datafeed>>,
  731. [[ml-datafeed-delayed-data-check-config]]
  732. <<ml-get-datafeed>>,
  733. [[ml-datafeed-counts]]
  734. <<ml-get-datafeed-stats>>.
  735. [role="exclude",id="ml-jobstats"]
  736. === Job statistics
  737. This
  738. [[ml-datacounts]]
  739. page
  740. [[ml-modelsizestats]]
  741. was
  742. [[ml-forecastsstats]]
  743. deleted.
  744. [[ml-timingstats]]
  745. See
  746. [[ml-stats-node]]
  747. the details in <<ml-get-job-stats>>.