- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Important System Configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- G1GC check
- All permission check
- Discovery configuration check
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Full-cluster restart and rolling restart
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- Aggregations
- Metrics Aggregations
- Avg Aggregation
- Weighted 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
- Median Absolute Deviation Aggregation
- Bucket Aggregations
- Adjacency Matrix Aggregation
- Auto-interval Date Histogram Aggregation
- Children Aggregation
- Composite Aggregation
- Date histogram aggregation
- Date Range Aggregation
- Diversified Sampler Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- GeoTile Grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IP Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Parent Aggregation
- Range Aggregation
- Rare Terms Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text Aggregation
- Terms Aggregation
- Subtleties of bucketing range fields
- 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
- Moving Function Aggregation
- Cumulative Sum Aggregation
- Cumulative Cardinality Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Bucket Sort Aggregation
- Serial Differencing Aggregation
- Matrix Aggregations
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Returning the type of the aggregation
- Metrics Aggregations
- Query DSL
- Search across clusters
- Scripting
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Char Group Tokenizer
- Classic Tokenizer
- Edge n-gram tokenizer
- Keyword Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- N-gram tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Pattern Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Standard Tokenizer
- Thai Tokenizer
- UAX URL Email Tokenizer
- Whitespace Tokenizer
- Token Filters
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten Graph Token Filter
- Hunspell Token Filter
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword Marker Token Filter
- Keyword Repeat Token Filter
- KStem Token Filter
- Length Token Filter
- Limit Token Count Token Filter
- Lowercase Token Filter
- MinHash Token Filter
- Multiplexer Token Filter
- N-gram
- Normalization Token Filter
- Pattern Capture Token Filter
- Pattern Replace Token Filter
- Phonetic Token Filter
- Porter Stem Token Filter
- Predicate Token Filter Script
- Remove Duplicates Token Filter
- Reverse Token Filter
- Shingle Token Filter
- Snowball Token Filter
- Stemmer Token Filter
- Stemmer Override Token Filter
- Stop Token Filter
- Synonym Token Filter
- Synonym Graph Token Filter
- Trim Token Filter
- Truncate Token Filter
- Unique Token Filter
- Uppercase Token Filter
- Word Delimiter Token Filter
- Word Delimiter Graph Token Filter
- Character Filters
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Bytes Processor
- Circle Processor
- Convert Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Dot Expander Processor
- Drop Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub Processor
- HTML Strip Processor
- Join Processor
- JSON Processor
- KV Processor
- Lowercase Processor
- Pipeline Processor
- Remove Processor
- Rename Processor
- Script Processor
- Set Processor
- Set Security User Processor
- Split Processor
- Sort Processor
- Trim Processor
- Uppercase Processor
- URL Decode Processor
- User Agent processor
- Managing the index lifecycle
- Getting started with index lifecycle management
- Policy phases and actions
- Set up index lifecycle management policy
- Using policies to manage index rollover
- Update policy
- Index lifecycle error handling
- Restoring snapshots of managed indices
- Start and stop index lifecycle management
- Using ILM with existing indices
- Getting started with snapshot lifecycle management
- SQL access
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Secure a cluster
- Overview
- Configuring security
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Security privileges
- Document level security
- Field level security
- Granting privileges for indices and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enabling audit logging
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Alerting on cluster and index events
- Command line tools
- How To
- Testing
- Glossary of terms
- REST APIs
- API conventions
- cat APIs
- Cluster APIs
- Cross-cluster replication APIs
- Document APIs
- Explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete index template
- Flush
- Force merge
- Freeze index
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists
- Open index
- Put index template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Index lifecycle management API
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendar
- Create datafeeds
- Create filter
- Delete calendar
- Delete datafeeds
- Delete events from calendar
- Delete filter
- Delete forecast
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Find file structure
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filter
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Migration APIs
- Reload search analyzers
- Rollup APIs
- Search APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect Prepare Authentication API
- OpenID Connect authenticate API
- OpenID Connect logout API
- SSL certificate
- Snapshot lifecycle management API
- Transform APIs
- Watcher APIs
- Definitions
- Release highlights
- Breaking changes
- Release notes
- Elasticsearch version 7.4.2
- Elasticsearch version 7.4.1
- Elasticsearch version 7.4.0
- Elasticsearch version 7.3.2
- Elasticsearch version 7.3.1
- Elasticsearch version 7.3.0
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Elasticsearch version 7.3.0
editElasticsearch version 7.3.0
editAlso see Breaking changes in 7.3.
Known issues
edit- Applying deletes or updates on an index after it has been shrunk may corrupt the index. In order to prevent this issue, it is recommended to stop shrinking read-write indices. For read-only indices, it is recommended to force-merge indices after shrinking, which significantly reduces the likeliness of this corruption in the case that deletes/updates would be applied by mistake. This bug is fixed in Elasticsearch 7.7 and later versions. More details can be found on the corresponding issue.
-
Indices created in 6.x with
dateanddate_nanosfields using formats that are incompatible with java.time patterns will cause parsing errors, incorrect date calculations or wrong search results. https://github.com/elastic/elasticsearch/pull/52555 This is fixed in Elasticsearch 7.7 and later versions.
Breaking changes
edit- CCR
- Data Frame
-
- Removing format support in date_histogram group_by #43659
Breaking Java changes
edit- Mapping
- Search
-
- Refactor IndexSearcherWrapper to disallow the wrapping of IndexSearcher #43645
Deprecations
editNew features
editEnhancements
edit- Aggregations
- Analysis
- Authentication
- Authorization
- CCR
- Cluster Coordination
- Data Frame
-
- Add a frequency option to transform config, default 1m #44120
- Add node attr to GET _stats #43842 (issue: #43743)
- Add deduced mappings to _preview response payload #43742 (issue: #39250)
- Add support for allow_no_match for endpoints #43490 (issue: #42766)
- Add version and create_time to transform config #43384 (issue: #43037)
- Have sum map to a double to prevent overflows #43213
- Add new pipeline field to dest config #43124 (issue: #43061)
- Write a warning audit on bulk index failures #43106
- Add support for weighted_avg agg #42646
- Distributed
- Engine
-
- Use reader attributes to control term dict memory useage #42838 (issue: #38390)
- Remove sort by primary term when reading soft-deletes #43845
- Refresh translog stats after translog trimming in NoOpEngine #43825 (issue: #43156)
- Expose translog stats in ReadOnlyEngine #43752
- Do not use soft-deletes to resolve indexing strategy #43336 (issues: #35230, #42979, #43202)
- Rebuild version map when opening internal engine #43202 (issues: #40741, #42979)
- Only load FST off heap if we are actually using mmaps for the term dictionary #43158 (issue: #43150)
- Trim translog for closed indices #43156 (issue: #42445)
-
Also mmap terms index (
.tip) files for hybridfs #43150 (issue: #42838) - Add a merge policy that prunes ID postings for soft-deleted but retained documents #40741
- Features/Indices APIs
- Features/Ingest
- Features/Java High Level REST Client
- Features/Java Low Level REST Client
- Features/Monitoring
-
- Expand beats_system role privileges #40876
- Features/Watcher
- Infra/Core
- Infra/Packaging
-
- Omit JDK sources archive from bundled JDK #42821
- Infra/Plugins
-
- Enable node roles to be pluggable #43175
- Infra/Scripting
- Machine Learning
-
- Add version and create_time to data frame analytics config #43683
- Improve message when native controller cannot connect #43565 (issue: #42341)
- Report exponential_avg_bucket_processing_time which gives more weight to recent buckets #43189 (issue: #29857)
- Adding support for geo_shape, geo_centroid, geo_point in datafeeds #42969 (issue: #42820)
- Report timing stats as part of the Job stats response #42709 (issue: #29857)
- Increase maximum forecast interval to 10 years. #41082 (issue: #41103)
- Upgrade to a newer version of the Apache Portable Runtime library. #495
- Improve stability of modelling around change points. #496
- Restrict detection of epoch timestamps in find_file_structure #43188
- Better detection of binary input in find_file_structure #42707
- Add a limit on line merging in find_file_structure #42501 (issue: #38086)
- Improve file structure finder timestamp format determination #41948 (issues: #35132, #35137, #38086)
- Add earliest and latest timestamps to field stats in find_file_structure response #42890
- Change dots in CSV column names to underscores in find_file_structure response #42839 (issue: #26800)
- Mapping
- Network
-
- Do not hang on unsupported HTTP methods #43362
- Ranking
- Recovery
- Reindex
- Search
-
- Split search in two when made against read-only and write indices #42510 (issue: #40900)
- Rename SearchRequest#crossClusterSearch #42363
-
Allow
fieldsto be set to*#42301 (issue: #39577) - Search - enable low_level_cancellation by default. #42291 (issue: #26258)
- Cut over ClusterSearchShardsGroup to Writeable #41788
- Disable max score optimization for queries with unbounded max scores #41361
- Snapshot/Restore
-
- Recursive Delete on BlobContainer #43281 (issue: #42189)
- Add SAS Token Authentication Support to Azure Repo Plugin #42982 (issue: #42117)
- Enable Parallel Deletes in Azure Repository #42783
- Add Ability to List Child Containers to BlobContainer #42653 (issue: #42189)
- Add custom metadata to snapshots #41281 (issue: #40638)
- Store
Bug fixes
edit- Aggregations
- Allocation
-
- Do not copy initial recovery filter during split #44053 (issue: #43955)
- Avoid parallel reroutes in DiskThresholdMonitor #43381 (issue: #40174)
- Reset failed allocation counter before executing routing commands #42658 (issue: #39546)
- Validate routing commands using updated routing state #42066 (issue: #41050)
- Analysis
-
- Fix AnalyzeAction response serialization #44284 (issue: #44078)
- Actually close IndexAnalyzers contents #43914
- Issue deprecation warnings for preconfigured delimited_payload_filter #43684 (issues: #26625, #43568)
- Use preconfigured filters correctly in Analyze API #43568 (issue: #43002)
- Require [articles] setting in elision filter #43083 (issue: #43002)
- Authentication
- CCR
- CRUD
- Cluster Coordination
- Data Frame
-
- Treat bulk index failures as an indexing failure #44351 (issue: #44101)
- Responding with 409 status code when failing _stop #44231 (issue: #44103)
- Adds index validations to _start data frame transform #44191 (issue: #44104)
- Data frame task failure do not make a 500 response #44058 (issue: #44011)
- Audit message missing for autostop #43984 (issue: #43977)
- Add data frame transform cluster privileges to HLRC #43879
- Improve pivot nested field validations #43548
- Adjusting error message #43455
- Size the GET stats search by number of Ids requested #43206 (issue: #43203)
- Rewrite start and stop to answer with acknowledged #42589 (issue: #42450)
- Set data frame transform task state to stopped when stopping #42516 (issue: #42441)
- Distributed
-
- Fix DefaultShardOperationFailedException subclass xcontent serialization #43435 (issue: #43423)
- Advance checkpoints only after persisting ops #43205
- Avoid loading retention leases while writing them #42620 (issue: #41430)
- Do not use ifSeqNo for update requests on mixed cluster #42596 (issue: #42561)
- Ensure relocation target still tracked when start handoff #42201
- Engine
- Features/CAT APIs
- Features/ILM
- Features/Indices APIs
- Features/Ingest
-
- Read the default pipeline for bulk upsert through an alias #41963
- Features/Java High Level REST Client
- Features/Stats
- Features/Watcher
- Infra/Core
-
- Add default CLI JVM options #44545 (issues: #219, #42021)
- scheduleAtFixedRate would hang #42993 (issue: #38441)
- Only ignore IOException when fsyncing on dirs #42972 (issue: #42950)
- Fix alpha build error message when generate version object from version string #40406
- Bat scripts to work with JAVA_HOME with parantheses #39712 (issues: #30606, #33405, #38578, #38624)
- Change licence expiration date pattern #39681 (issue: #39136)
- Infra/Packaging
- Infra/Plugins
- Infra/REST API
-
- Remove deprecated _source_exclude and _source_include from get API spec #42188
- Infra/Scripting
-
- Allow aggregations using expressions to use _score #42652
- Machine Learning
-
- Update .ml-config mappings before indexing job, datafeed or df analytics config #44216 (issue: #44263)
- Wait for .ml-config primary before assigning persistent tasks #44170 (issue: #44156)
- Fix ML memory tracker lockup when inner step fails #44158 (issue: #44156)
- Reduce false positives associated with the multi-bucket feature. #491
- Reduce false positives for sum and count functions on sparse data. #492
- Fix an edge case causing spurious anomalies (false positives) if the variance in the count of events changed significantly throughout the period of a seasonal quantity. (See #489.)
- Mapping
-
- Ensure field caps doesn’t error on rank feature fields. #44370 (issue: #44330)
- Prevent types deprecation warning for indices.exists requests #43963 (issue: #43905)
- Fix index_prefix sub field name on nested text fields #43862 (issue: #43741)
- Fix possible NPE in put mapping validators #43000 (issue: #37675)
- Allow big integers and decimals to be mapped dynamically. #42827 (issue: #37846)
- Network
- Recovery
- Reindex
-
- Properly serialize remote query in ReindexRequest #43457 (issues: #43406, #43456)
- Fixing handling of auto slices in bulk scroll requests #43050
- Remote reindex failure parse fix #42928
- Fix concurrent search and index delete #42621 (issue: #28053)
- Propogate version in reindex from remote search #42412 (issue: #31908)
- SQL
-
- SQL: change the size of the list of concrete indices when resolving multiple indices #43878 (issue: #43876)
- SQL: handle double quotes escaping #43829 (issue: #43810)
- SQL: add pretty printing to JSON format #43756
- SQL: handle SQL not being available in a more graceful way #43665 (issue: #41279)
- SQL: fix NPE in case of subsequent scrolled requests for a CSV/TSV formatted response #43365 (issue: #43327)
- Geo: Add coerce support to libs/geo WKT parser #43273 (issue: #43173)
- SQL: Increase hard limit for sorting on aggregates #43220 (issue: #43168)
- SQL: Fix wrong results when sorting on aggregate #43154 (issue: #42851)
- SQL: cover the Integer type when extracting values from _source #42859 (issue: #42858)
- Search
-
- Don’t use index_phrases on graph queries #44340 (issue: #43976)
-
Fix wrong logic in
match_phrasequery with multi-word synonyms #43941 (issue: #43308) - Fix UOE on search requests that match a sparse role query #43668 (issue: #42857)
- Fix propagation of enablePositionIncrements in QueryStringQueryBuilder #43578 (issue: #43574)
- Fix score mode of the MinimumScoreCollector #43527 (issue: #43497)
- Fix round up of date range without rounding #43303 (issue: #43277)
- SearchRequest#allowPartialSearchResults does not handle successful retries #43095 (issue: #40743)
- Wire query cache into sorting nested-filter computation #42906 (issue: #42813)
- Fix auto fuzziness in query_string query #42897
-
Fix IntervalBuilder#analyzeText to never return
null#42750 (issue: #42587) - Fix sorting on nested field with unmapped #42451 (issue: #33644)
- Deduplicate alias and concrete fields in query field expansion #42328
- Security
- Snapshot/Restore
- Store
- Suggesters
Regressions
editUpgrades
editOn this page
Was this helpful?
Thank you for your feedback.