- 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
- Set up X-Pack
- Configuring X-Pack Java Clients
- Bootstrap Checks for X-Pack
- Upgrade Elasticsearch
- API conventions
- Document APIs
- Search APIs
- 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
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms Aggregation
- Significant Text 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
- Moving Function Aggregation
- Cumulative Sum 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
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Shrink Index
- Split Index
- Rollover Index
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- cat APIs
- Cluster APIs
- Query DSL
- Scripting
- Mapping
- Analysis
- Anatomy of an analyzer
- Testing analyzers
- Analyzers
- Normalizers
- Tokenizers
- Standard Tokenizer
- Letter Tokenizer
- Lowercase Tokenizer
- Whitespace Tokenizer
- UAX URL Email Tokenizer
- Classic Tokenizer
- Thai Tokenizer
- NGram Tokenizer
- Edge NGram Tokenizer
- Keyword Tokenizer
- Pattern Tokenizer
- Char Group Tokenizer
- Simple Pattern Tokenizer
- Simple Pattern Split Tokenizer
- Path Hierarchy Tokenizer
- Path Hierarchy Tokenizer Examples
- Token Filters
- 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
- Multiplexer Token Filter
- Conditional Token Filter
- Predicate Token Filter Script
- 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
- Parsing synonym files
- 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
- Exclude mode settings example
- Classic Token Filter
- Apostrophe Token Filter
- Decimal Digit Token Filter
- Fingerprint Token Filter
- MinHash Token Filter
- Remove Duplicates Token Filter
- Character Filters
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Ingest APIs
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Processors
- Append Processor
- Bytes 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
- 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
- Set up a cluster for high availability
- Roll up or transform your data
- X-Pack APIs
- Info API
- Cross-cluster replication APIs
- Explore API
- Freeze index
- Index lifecycle management API
- Licensing APIs
- Machine learning 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 calendars
- Get buckets
- Get overall buckets
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- 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
- Migration APIs
- Rollup 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
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application 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
- Transform APIs
- Unfreeze index
- Watcher APIs
- Definitions
- Secure a cluster
- Overview
- Configuring security
- Encrypting communications in Elasticsearch
- Encrypting communications in an Elasticsearch Docker Container
- Enabling cipher suites for stronger encryption
- Separating node-to-node and client traffic
- Configuring an Active Directory realm
- Configuring a file realm
- Configuring an LDAP realm
- Configuring a native realm
- Configuring a PKI realm
- Configuring a SAML realm
- Configuring a Kerberos realm
- Security files
- FIPS 140-2
- How security works
- 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
- Auditing security events
- 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
- Release highlights
- Breaking changes
- Release notes
- 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.0.0-alpha1
editElasticsearch version 7.0.0-alpha1
editThe changes listed below have been released for the first time in Elasticsearch 7.0.0-alpha1.
Breaking changes
edit- Aggregations
- Analysis
- Audit
-
- Logfile auditing settings remove after deprecation #35205
- Authentication
- Authorization
- CRUD
- Distributed
- Features/Indices APIs
- Features/Ingest
- Features/Stats
- Geo
- Infra/Circuit Breakers
- Infra/Core
-
- Core: Default node.name to the hostname #33677
- Remove bulk fallback for write thread pool #29609
- CCS: Drop http address from remote cluster info #29568 (issue: #29207)
- Remove the index thread pool #29556
- Main response should not have status 503 when okay #29045 (issue: #8902)
- Automatically prepare indices for splitting #27451
-
Don’t refresh on
_flush
_force_merge
and_upgrade
#27000 (issue: #26972)
- Infra/Packaging
-
- Packaging: Remove windows bin files from the tar distribution #30596
- Infra/REST API
- Infra/Scripting
- Infra/Settings
-
- Remove config prompting for secrets and text #27216
- Mapping
-
- Match phrase queries against non-indexed fields should throw an exception #31060
- Remove legacy mapping code. #29224
-
Reject updates to the
_default_
mapping. #29165 (issues: #15613, #28248) -
Remove the
update_all_types
option. #28288 -
Remove the
_default_
mapping. #28248 -
Reject the
index_options
parameter for numeric fields #26668 (issue: #21475)
- Network
- Percolator
-
- remove deprecated percolator map_unmapped_fields_as_string setting #28060
- Ranking
- Search
-
-
Remove deprecated url parameters
_source_include
and_source_exclude
#35097 (issues: #22792, #33475) - Disallow negative query boost #34486 (issue: #33309)
-
Forbid negative
weight
in Function Score Query #33390 (issue: #31927) - In the field capabilities API, remove support for providing fields in the request body. #30185
- Remove deprecated options for query_string #29203 (issue: #25551)
- Fix Laplace scorer to multiply by alpha (and not add) #27125
- Remove _primary and _replica shard preferences #26791 (issue: #26335)
- Limit the number of expanded fields it query_string and simple_query_string #26541 (issue: #25105)
- Make purely negative queries return scores of 0. #26015 (issue: #23449)
-
Remove deprecated url parameters
- Snapshot/Restore
- Store
- Suggesters
-
- Fix threshold frequency computation in Suggesters #34312 (issue: #34282)
- Make Geo Context Mapping Parsing More Strict #32821 (issues: #32202, #32412)
- Make Geo Context Parsing More Strict #32412 (issue: #32202)
- Remove the ability to index or query context suggestions without context #31007 (issue: #30712)
Breaking Java changes
editDeprecations
editNew features
edit- Analysis
- CCR
-
- Generalize search.remote settings to cluster.remote #33413
- Distributed
- Features/Ingest
- Features/Java High Level REST Client
-
- GraphClient for the high level REST client and associated tests #32366
- Features/Monitoring
- Infra/Core
-
-
Skip shard refreshes if shard is
search idle
#27500
-
Skip shard refreshes if shard is
- Infra/Logging
-
- Logging: Unify log rotation for index/search slow log #27298
- Infra/Plugins
- Infra/REST API
- Machine Learning
-
- [ML] Filter undefined job groups from update job calendar actions #30757
- Mapping
- Ranking
- Recovery
- SQL
- Search
-
- Add “took” timing info to response for _msearch/template API #30961 (issue: #30957)
- Expose the lucene Matches API to searches [ISSUE] #29631
- Add allow_partial_search_results flag to search requests with default setting true #28440 (issue: #27435)
- Enable adaptive replica selection by default #26522 (issue: #24915)
- Suggesters
Enhancements
edit- Aggregations
- Discovery-Plugins
-
- Rename discovery.zen.minimum_master_nodes [ISSUE] #14058
- Engine
-
- Remove versionType from translog #31945
- do retry if primary fails on AsyncAfterWriteAction #31857 (issues: #31716, #31755)
- handle AsyncAfterWriteAction exception before listener is registered #31755 (issue: #31716)
- Use IndexWriter#flushNextBuffer to free memory #27753
- Remove pre 6.0.0 support from InternalEngine #27720
- Features/Indices APIs
- Features/Ingest
- Features/Java High Level REST Client
- Features/Stats
-
- Stats to record how often the ClusterState diff mechanism is used successfully #26973
- Features/Watcher
- Infra/Circuit Breakers
- Infra/Core
- Infra/Packaging
-
- Choose JVM options ergonomically #30684
- Infra/REST API
- Infra/Scripting
- Infra/Settings
-
- Settings: Add keystore creation to add commands #26126
- Infra/Transport API
- Network
-
- Add cors support to NioHttpServerTransport #30827 (issue: #28898)
- Reintroduce mandatory http pipelining support #30820
- Make http pipelining support mandatory #30695 (issues: #28898, #29500)
- Add nio http server transport #29587 (issue: #28898)
- Add class for serializing message to bytes #29384 (issue: #28898)
- Selectors operate on channel contexts #28468 (issue: #27260)
- Unify nio read / write channel contexts #28160 (issue: #27260)
- Create nio-transport plugin for NioTransport #27949 (issue: #27260)
- Add elasticsearch-nio jar for base nio classes #27801 (issue: #27802)
- Ranking
-
- Add k parameter to PrecisionAtK metric #27569
- SQL
- Search
-
- Make limit on number of expanded fields configurable #35284 (issues: #26541, #34778)
- Search: Simply SingleFieldsVisitor #34052
- Don’t count hits via the collector if the hit count can be computed from index stats. #33701
- Limit the number of concurrent requests per node #31206 (issue: #31192)
- Default max concurrent search req. numNodes * 5 #31171 (issues: #30783, #30994)
- Change ScriptException status to 400 (bad request) #30861 (issue: #12315)
- Change default value to true for transpositions parameter of fuzzy query #26901
-
Introducing "took" time (in ms) for
_msearch
#23767 (issue: #23131)
- Snapshot/Restore
- Store
- ZenDiscovery
-
- [Zen2] Introduce vote withdrawal #35446
- Zen2: Add basic Zen1 transport-level BWC #35443
- Zen2: Add diff-based publishing #35290
- [Zen2] Introduce auto_shrink_voting_configuration setting #35217
- Introduce transport API for cluster bootstrapping #34961
- [Zen2] Reconfigure cluster as its membership changes #34592 (issue: #33924)
- Zen2: Fail fast on disconnects #34503
- [Zen2] Add storage-layer disruptions to CoordinatorTests #34347
- [Zen2] Add low-level bootstrap implementation #34345
- [Zen2] Gather votes from all nodes #34335
- Zen2: Add Cluster State Applier #34257
- [Zen2] Add safety phase to CoordinatorTests #34241
- [Zen2] Integrate FollowerChecker with Coordinator #34075
- Integrate LeaderChecker with Coordinator #34049
- Zen2: Trigger join when active master detected #34008
- Zen2: Update PeerFinder term on term bump #33992
- [Zen2] Calculate optimal cluster configuration #33924
- [Zen2] Introduce FollowersChecker #33917
- Zen2: Integrate publication pipeline into Coordinator #33771
- Zen2: Add DisruptableMockTransport #33713
- [Zen2] Implement basic cluster formation #33668
- [Zen2] Introduce LeaderChecker #33024
- Zen2: Add leader-side join handling logic #33013
- [Zen2] Add PeerFinder#onFoundPeersUpdated #32939
- [Zen2] Introduce PreVoteCollector #32847
- [Zen2] Introduce ElectionScheduler #32846
- [Zen2] Introduce ElectionScheduler #32709
- [Zen2] Add HandshakingTransportAddressConnector #32643 (issue: #32246)
- [Zen2] Add UnicastConfiguredHostsResolver #32642 (issue: #32246)
- Zen2: Cluster state publication pipeline #32584 (issue: #32006)
- [Zen2] Introduce gossip-like discovery of master nodes #32246
- Add core coordination algorithm for cluster state publishing #32171 (issue: #32006)
- Add term and config to cluster state #32100 (issue: #32006)
Bug fixes
edit- Aggregations
- Analysis
- Authorization
- Docs Infrastructure
-
- Docs build fails due to missing nexus.png [ISSUE] #33101
- Features/Indices APIs
- Features/Ingest
-
- INGEST: Fix Deprecation Warning in Script Proc. #32407
- Features/Java High Level REST Client
-
- HLRC: Drop extra level from user parser #34932
- Features/Java Low Level REST Client
- Features/Watcher
-
- Watcher: Ignore system locale/timezone in croneval CLI tool #33215
- Geo
-
-
[build] Test
GeoShapeQueryTests#testPointsOnly
fails [ISSUE] #27454
-
[build] Test
- Infra/Core
- Infra/Settings
-
- Change format how settings represent lists / array #26723
- Infra/Transport API
- License
- Mapping
-
- Ensure that field aliases cannot be used in multi-fields. #32219
- Network
- Search
-
-
Ensure realtime
_get
and_termvectors
don’t run on the network thread #33814 (issue: #27500) - [bug] fuzziness custom auto #33462 (issue: #33454)
- Fix inner hits retrieval when stored fields are disabled (none) #33018 (issue: #32941)
- Set maxScore for empty TopDocs to Nan rather than 0 #32938
- Handle leniency for cross_fields type in multi_match query #27045 (issue: #23210)
- Raise IllegalArgumentException instead if query validation failed #26811 (issue: #26799)
-
Ensure realtime
- Security
-
- Handle 6.4.0+ BWC for Application Privileges #32929
- ZenDiscovery
-
- [Zen2] Remove duplicate discovered peers #35505
Upgrades
editOn this page
Was this helpful?
Thank you for your feedback.