- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 7.10
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- HTTP
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Network settings
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot lifecycle management settings
- Transforms settings
- Transport
- Thread pools
- Watcher settings
- 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
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Set up X-Pack
- Configuring X-Pack Java Clients
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest node
- Search your data
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Geo-distance
- Geohash grid
- Geotile grid
- Global
- Histogram
- IP range
- Missing
- Nested
- Parent
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Bucket aggregations
- EQL
- 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
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Overview
- Concepts
- Automate rollover
- Manage Filebeat time-based indices
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Resolve lifecycle policy execution errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- 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
- Granting access to Stack Management features
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and index 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
- Watch for cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Nodes reload secure settings
- Nodes stats
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Cross-cluster replication APIs
- Data stream APIs
- Document APIs
- Enrich APIs
- Graph explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete component template
- Delete index template
- Delete index template (legacy)
- Flush
- Force merge
- Freeze index
- Get component template
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- Open index
- Put index template
- Put index template (legacy)
- Put component template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Simulate index
- Simulate template
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Resolve index
- List dangling indices
- Import dangling index
- Delete dangling index
- Index lifecycle management APIs
- Ingest APIs
- Info API
- Licensing APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- 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 filters
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create trained models
- Update data frame analytics jobs
- Delete data frame analytics jobs
- Delete trained models
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get trained models
- Get trained models stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Search APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key 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
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 7.10.2
- Elasticsearch version 7.10.1
- Elasticsearch version 7.10.0
- Elasticsearch version 7.9.3
- Elasticsearch version 7.9.2
- Elasticsearch version 7.9.1
- Elasticsearch version 7.9.0
- Elasticsearch version 7.8.1
- Elasticsearch version 7.8.0
- Elasticsearch version 7.7.1
- Elasticsearch version 7.7.0
- Elasticsearch version 7.6.2
- Elasticsearch version 7.6.1
- Elasticsearch version 7.6.0
- Elasticsearch version 7.5.2
- Elasticsearch version 7.5.1
- Elasticsearch version 7.5.0
- 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
- Dependencies and versions
Java time migration guide
editJava time migration guide
editWith 7.0, Elasticsearch switched from joda time to java time for date-related parsing, formatting, and calculations. This guide is designed to help you determine if your cluster is impacted and, if so, prepare for the upgrade.
You do not need to convert joda-time date formats to java time for indices created in Elasticsearch 6.8 before upgrading to 7.7 or later versions. However, mappings for indices created in 7.7 and later versions must use java-time formats.
To ensure new indices use java-time formats, we recommend you update any ingest pipelines and index templates created in 6.8 to java time before upgrading. See:
Indices created in versions 7.0-7.6 cannot use joda time. This was fixed was in 7.7 with #52555.
Convert date formats
editTo use java time in 6.8, prefix the date format with an 8
.
For example, you can change the date format YYYY-MM-dd
to 8yyyy-MM-dd
to
indicate the date format uses java time.
Elasticsearch treats date formats starting with the 8
prefix differently depending on
the version:
6.8: Date formats with an 8
prefix are handled as java-time formats. Date
formats without an 8
prefix are treated as joda-time formats. We recommend
converting these joda-time formats to java-time before upgrading to 7.x.
7.x and later: For indices created in 6.x, date formats without an 8
prefix
are treated as joda-time formats. For indices created in 7.x and later versions,
all date formats are treated as java-time formats, regardless of whether it
starts with an 8
prefix.
Impacted features
editThe switch to java time only impacts custom date
and
date_nanos
formats.
These formats are commonly used in:
If you don’t use custom date formats, you can skip the rest of this guide. Most custom date formats are compatible. However, several require an update.
To see if your date format is impacted, use the deprecation info API or the Kibana upgrade assistant.
Incompatible date formats
editCustom date formats containing the following joda-time literals should be converted to their java-time equivalents.
-
Y
(Year of era) -
Replace with
y
.Example:
YYYY-MM-dd
should becomeyyyy-MM-dd
.In java time,
Y
is used for week-based year. UsingY
in place ofy
could result in off-by-one errors in year calculation.For pattern
YYYY-ww
and date2019-01-01T00:00:00.000Z
will give2019-01
For patternYYYY-ww
and date2018-12-31T00:00:00.000Z
will give2019-01
(counter-intuitive) because there is >4 days of that week in 2019 -
y
(Year) -
Replace with
u
.Example:
yyyy-MM-dd
should becomeuuuu-MM-dd
.In java time,
y
is used for year of era.u
can contain non-positive values whiley
cannot.y
can also be associated with an era field. -
C
(Century of era) -
Century of era is not supported in java time. There is no replacement. Instead, we recommend you preprocess your input.
-
x
(Week year) -
Replace with
Y
.In java time,
x
means zone-offset.Failure to properly convert
x
(Week year) toY
could result in data loss. -
Z
(Zone offset/id) -
Replace with multiple
X
's.Z
has a similar meaning in java time. However, java time expects different numbers of literals to parse different forms.Consider migrating to
X
, which gives you more control over how time is parsed. For example, the joda-time formatYYYY-MM-dd'T'hh:mm:ssZZ
accepts the following dates:2010-01-01T01:02:03Z 2010-01-01T01:02:03+01 2010-01-01T01:02:03+01:02 2010-01-01T01:02:03+01:02:03
In java time, you cannot parse all these dates using a single format Instead, you must specify 3 separate formats:
2010-01-01T01:02:03Z 2010-01-01T01:02:03+01 both parsed with yyyy-MM-dd'T'hh:mm:ssX 2010-01-01T01:02:03+01:02 yyyy-MM-dd'T'hh:mm:ssXXX 2010-01-01T01:02:03+01:02:03 yyyy-MM-dd'T'hh:mm:ssXXXXX
The formats must then be delimited using
||
:yyyy-MM-dd'T'hh:mm:ssX||yyyy-MM-dd'T'hh:mm:ssXXX||yyyy-MM-dd'T'hh:mm:ssXXXXX
The same applies if you expect your pattern to occur without a colon (
:
): For example, theYYYY-MM-dd'T'hh:mm:ssZ
format accepts the following date forms:2010-01-01T01:02:03Z 2010-01-01T01:02:03+01 2010-01-01T01:02:03+0102 2010-01-01T01:02:03+010203
To accept all these forms in java time, you must use the
||
delimiter:yyyy-MM-dd'T'hh:mm:ssX||yyyy-MM-dd'T'hh:mm:ssXX||yyyy-MM-dd'T'hh:mm:ssXXXX
-
d
(Day) -
In java time,
d
is still interpreted as "day" but is less flexible.For example, the joda-time date format
YYYY-MM-dd
accepts2010-01-01
or2010-01-1
.In java time, you must use the
||
delimiter to provide specify each format:yyyy-MM-dd||yyyy-MM-d
In java time,
d
also does not accept more than 2 digits. To accept days with more than two digits, you must include a text literal in your java-time date format. For example, to parse2010-01-00001
, you must use the following java-time date format:yyyy-MM-'000'dd
-
e
(Name of day) -
In java time,
e
is still interpreted as "name of day" but does not parse short- or full-text forms.For example, the joda-time date format
EEE YYYY-MM
accepts bothWed 2020-01
andWednesday 2020-01
.To accept both of these dates in java time, you must specify each format using the
||
delimiter:cccc yyyy-MM||ccc yyyy-MM
The joda-time literal
E
is interpreted as "day of week." The java-time literalc
is interpreted as "localized day of week."E
does not accept full-text day formats, such asWednesday
. -
EEEE
and similar text forms -
Support for full-text forms depends on the locale data provided with your Java Development Kit (JDK) and other implementation details. We recommend you test formats containing these patterns carefully before upgrading.
-
z
(Time zone text) -
In java time,
z
outputs Z for Zulu when given a UTC timezone.
Test with your data
editWe strongly recommend you test any date format changes using real data before deploying in production.
Update index mappings
editTo update joda-time date formats in index mappings, you must create a new index with an updated mapping and reindex your data to it. You can however update your pipelines or templates.
The following my-index-000001
index contains a mapping for the datetime
field, a
date
field with a custom joda-time date format.
GET my-index-000001/_mapping
{ "my-index-000001" : { "mappings" : { "properties" : { "datetime": { "type": "date", "format": "yyyy/MM/dd HH:mm:ss||yyyy/MM/dd||epoch_millis" } } } } }
To change the date format for the datetime
field, create a separate index
containing an updated mapping and date format.
For example, the following my-index-000002
index changes the datetime
field’s
date format to 8uuuu/MM/dd HH:mm:ss||uuuu/MM/dd||epoch_millis
. The 8
prefix
indicates this date format uses java time.
PUT my-index-000002 { "mappings": { "properties": { "datetime": { "type": "date", "format": "8uuuu/MM/dd HH:mm:ss||uuuu/MM/dd||epoch_millis" } } } }
Next, reindex data from the old index to the new index.
The following reindex API request reindexes data from
my-index-000001
to my-index-000002
.
POST _reindex { "source": { "index": "my-index-000001" }, "dest": { "index": "my-index-000002" } }
If you use index aliases, update them to point to the new index.
POST /_aliases { "actions" : [ { "remove" : { "index" : "my-index-000001", "alias" : "my-index" } }, { "add" : { "index" : "my-index-000002", "alias" : "my-index" } } ] }
Update ingest pipelines
editIf your ingest pipelines contain joda-time date formats, you can update them using the put ingest pipeline API.
PUT _ingest/pipeline/my_pipeline { "description": "Pipeline for routing data to specific index", "processors": [ { "date": { "field": "createdTime", "formats": [ "8uuuu-w" ] }, "date_index_name": { "field": "@timestamp", "date_rounding": "d", "index_name_prefix": "x-", "index_name_format": "8uuuu-w" } } ] }
Update index templates
editIf your index templates contain joda-time date formats, you can update them using the put index template API.
PUT _template/template_1 { "index_patterns": [ "te*", "bar*" ], "settings": { "number_of_shards": 1 }, "mappings": { "_source": { "enabled": false }, "properties": { "host_name": { "type": "keyword" }, "created_at": { "type": "date", "format": "8EEE MMM dd HH:mm:ss Z yyyy" } } } }
On this page