- Elasticsearch Guide: other versions:
- Getting Started
- Set up Elasticsearch
- Set up X-Pack
- Breaking changes
- Breaking changes in 5.5
- Breaking changes in 5.4
- Breaking changes in 5.3
- Breaking changes in 5.2
- Breaking changes in 5.1
- Breaking changes in 5.0
- Search and Query DSL changes
- Mapping changes
- Percolator changes
- Suggester changes
- Index APIs changes
- Document API changes
- Settings changes
- Allocation changes
- HTTP changes
- REST API changes
- CAT API changes
- Java API changes
- Packaging
- Plugin changes
- Filesystem related changes
- Path to data on disk
- Aggregation changes
- Script related changes
- API Conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Cardinality Aggregation
- Extended Stats Aggregation
- Geo Bounds Aggregation
- Geo Centroid Aggregation
- Max Aggregation
- Min Aggregation
- Percentiles Aggregation
- Percentile Ranks Aggregation
- Scripted Metric Aggregation
- Stats Aggregation
- Sum Aggregation
- Top hits Aggregation
- Value Count Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Children Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Range Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Terms Aggregation
- Pipeline Aggregations
- Avg Bucket Aggregation
- Derivative Aggregation
- Max Bucket Aggregation
- Min Bucket Aggregation
- Sum Bucket Aggregation
- Stats Bucket Aggregation
- Extended Stats Bucket Aggregation
- Percentiles Bucket Aggregation
- Moving Average Aggregation
- Cumulative Sum Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Shadow replica indices
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Token Filters
- Standard Token Filter
- ASCII Folding Token Filter
- Flatten Graph Token Filter
- Length Token Filter
- Lowercase Token Filter
- Uppercase Token Filter
- NGram Token Filter
- Edge NGram Token Filter
- Porter Stem Token Filter
- Shingle Token Filter
- Stop Token Filter
- Word Delimiter Token Filter
- Word Delimiter Graph Token Filter
- Stemmer Token Filter
- Stemmer Override Token Filter
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Snowball Token Filter
- Phonetic Token Filter
- Synonym Token Filter
- Synonym Graph Token Filter
- Compound Word Token Filters
- Reverse Token Filter
- Elision Token Filter
- Truncate Token Filter
- Unique Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Trim Token Filter
- Limit Token Count Token Filter
- Hunspell Token Filter
- Common Grams Token Filter
- Normalization Token Filter
- CJK Width Token Filter
- CJK Bigram Token Filter
- Delimited Payload Token Filter
- Keep Words Token Filter
- Keep Types Token Filter
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- Minhash Token Filter
- Character Filters
- Modules
- Index Modules
- Ingest Node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Fail Processor
- Foreach Processor
- Grok Processor
- Gsub Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- Dot Expander Processor
- X-Pack APIs
- Info API
- Explore API
- Machine Learning APIs
- Close Jobs
- Create Datafeeds
- Create Jobs
- Delete Datafeeds
- Delete Jobs
- Delete Model Snapshots
- Flush Jobs
- Get Buckets
- Get Categories
- Get Datafeeds
- Get Datafeed Statistics
- Get Influencers
- Get Jobs
- Get Job Statistics
- Get Model Snapshots
- Get Records
- Open Jobs
- Post Data to Jobs
- Preview Datafeeds
- Revert Model Snapshots
- Start Datafeeds
- Stop Datafeeds
- Update Datafeeds
- Update Jobs
- Update Model Snapshots
- Security APIs
- Watcher APIs
- Definitions
- How To
- Testing
- Glossary of terms
- Release Notes
- 5.5.3 Release Notes
- 5.5.2 Release Notes
- 5.5.1 Release Notes
- 5.5.0 Release Notes
- 5.4.3 Release Notes
- 5.4.2 Release Notes
- 5.4.1 Release Notes
- 5.4.0 Release Notes
- 5.3.3 Release Notes
- 5.3.2 Release Notes
- 5.3.1 Release Notes
- 5.3.0 Release Notes
- 5.2.2 Release Notes
- 5.2.1 Release Notes
- 5.2.0 Release Notes
- 5.1.2 Release Notes
- 5.1.1 Release Notes
- 5.1.0 Release Notes
- 5.0.2 Release Notes
- 5.0.1 Release Notes
- 5.0.0 Combined Release Notes
- 5.0.0 GA Release Notes
- 5.0.0-rc1 Release Notes
- 5.0.0-beta1 Release Notes
- 5.0.0-alpha5 Release Notes
- 5.0.0-alpha4 Release Notes
- 5.0.0-alpha3 Release Notes
- 5.0.0-alpha2 Release Notes
- 5.0.0-alpha1 Release Notes
- 5.0.0-alpha1 Release Notes (Changes previously released in 2.x)
WARNING: Version 5.5 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
REST API changes
editREST API changes
editStrict REST query string parameter parsing
editPrevious versions of Elasticsearch ignored unrecognized URL query string parameters. This means that extraneous parameters or parameters containing typographical errors would be silently accepted by Elasticsearch. This is dangerous from an end-user perspective because it means a submitted request will silently execute not as intended. This leniency has been removed and Elasticsearch will now fail any request that contains unrecognized query string parameters.
id values longer than 512 bytes are rejected
editWhen specifying an _id
value longer than 512 bytes, the request will be
rejected.
/_optimize
endpoint removed
editThe deprecated /_optimize
endpoint has been removed. The /_forcemerge
endpoint should be used in lieu of optimize.
The GET
HTTP verb for /_forcemerge
is no longer supported, please use the
POST
HTTP verb.
Index creation endpoint only accepts PUT
editIt used to be possible to create an index by either calling PUT index_name
or POST index_name
. Only the former is now supported.
HEAD {index}/{type}
replaced with HEAD {index}/_mapping/{type}
editThe endpoint for checking whether a type exists has been changed from
{index}/{type}
to {index}/_mapping/{type}
in order to prepare for the
removal of types when HEAD {index}/{id}
will be used to check whether a
document exists in an index. The old endpoint will keep working until 6.0.
Removed mem
section from /_cluster/stats
response
editThe mem
section contained only the total
value, which was actually the
memory available throughout all nodes in the cluster. The section contains now
total
, free
, used
, used_percent
and free_percent
.
Revised node roles aggregate returned by /_cluster/stats
editThe client
, master_only
, data_only
and master_data
fields have been
removed in favor of master
, data
, ingest
and coordinating_only
. A
node can contribute to multiple counts as it can have multiple roles. Every
node is implicitly a coordinating node, so whenever a node has no explicit
roles, it will be counted as coordinating only.
Removed shard version
information from /_cluster/state
routing table
editWe now store allocation id’s of shards in the cluster state and use that to select primary shards instead of the version information.
Node roles are not part of node attributes anymore
editNode roles are now returned in a specific section, called roles
, as part of
nodes stats and nodes info response. The new section is an array that holds all
the different roles that each node fulfills. In case the array is returned
empty, that means that the node is a coordinating only node.
Forbid unquoted JSON
editPreviously, JSON documents were allowed with unquoted field names, which isn’t
strictly JSON and broke some Elasticsearch clients. If documents were already
indexed with unquoted fields in a previous version of Elasticsearch, some
operations may throw errors. To accompany this, a commented out JVM option has
been added to the jvm.options
file:
-Delasticsearch.json.allow_unquoted_field_names
.
Note that this option is provided solely for migration purposes and will be removed in Elasticsearch 6.0.0.
Analyze API changes
editThe filters
and char_filters
parameters have been renamed filter
and char_filter
.
The token_filters
parameter has been removed. Use filter
instead.
DELETE /_query
endpoint removed
editThe DELETE /_query
endpoint provided by the Delete-By-Query plugin has been
removed and replaced by the Delete By Query API.
Create stored script endpoint removed
editThe PUT /_scripts/{lang}/{id}/_create
endpoint that previously allowed to create
indexed scripts has been removed. Indexed scripts have been replaced
by stored scripts.
Create stored template endpoint removed
editThe PUT /_search/template/{id}/_create
endpoint that previously allowed to create
indexed template has been removed. Indexed templates have been replaced
by Pre-registered templates.
Remove properties support
editSome REST endpoints (e.g., cluster update index settings) supported detecting content in the Java properties format (line-delimited key=value pairs). This support has been removed.
wait_for_relocating_shards
is now wait_for_no_relocating_shards
in /_cluster/health
editThe wait_for_relocating_shards
parameter that used to take a number is now simply a boolean
flag wait_for_no_relocating_shards
, which if set to true, means the request will wait (up
until the configured timeout) for the cluster to have no shard relocations before returning.
Defaults to false, which means the operation will not wait.
On this page
- Strict REST query string parameter parsing
- id values longer than 512 bytes are rejected
/_optimize
endpoint removed- Index creation endpoint only accepts
PUT
HEAD {index}/{type}
replaced withHEAD {index}/_mapping/{type}
- Removed
mem
section from/_cluster/stats
response - Revised node roles aggregate returned by
/_cluster/stats
- Removed shard
version
information from/_cluster/state
routing table - Node roles are not part of node attributes anymore
- Forbid unquoted JSON
- Analyze API changes
DELETE /_query
endpoint removed- Create stored script endpoint removed
- Create stored template endpoint removed
- Remove properties support
wait_for_relocating_shards
is nowwait_for_no_relocating_shards
in/_cluster/health