- Elasticsearch Guide: other versions:
- Elasticsearch introduction
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Logging configuration
- Auditing settings
- Cross-cluster replication settings
- Transforms settings
- Index lifecycle management settings
- License settings
- Machine learning settings
- Monitoring settings
- Security settings
- Snapshot lifecycle management settings
- SQL access settings
- 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
- 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
- String 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
- Indexing aggregation results with transforms
- Metrics Aggregations
- Query DSL
- Search across clusters
- Scripting
- Mapping
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- 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 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
- Modules
- Index modules
- Ingest node
- Pipeline Definition
- Accessing Data in Pipelines
- Conditional Execution in Pipelines
- Handling Failures in Pipelines
- Enrich your data
- Processors
- Append Processor
- Bytes Processor
- Circle Processor
- Convert Processor
- CSV Processor
- Date Processor
- Date Index Name Processor
- Dissect Processor
- Dot Expander Processor
- Drop Processor
- Enrich Processor
- Fail Processor
- Foreach Processor
- GeoIP Processor
- Grok Processor
- Gsub Processor
- HTML Strip Processor
- Inference 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
- ILM: Manage the index lifecycle
- 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
- 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
- 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
- Glossary of terms
- REST APIs
- API conventions
- cat APIs
- Cluster APIs
- Cross-cluster replication APIs
- Document APIs
- Enrich 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
- Create data frame analytics jobs
- Create inference trained model
- Delete data frame analytics jobs
- Delete inference trained model
- Evaluate data frame analytics
- Explain data frame analytics API
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get inference trained model
- Get inference trained model stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- 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
- SAML prepare authentication API
- SAML authenticate API
- SAML logout API
- SAML invalidate API
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management API
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Release highlights
- Breaking changes
- Release notes
- 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
format
editformat
editIn JSON documents, dates are represented as strings. Elasticsearch uses a set of preconfigured formats to recognize and parse these strings into a long value representing milliseconds-since-the-epoch in UTC.
Besides the built-in formats, your own
custom formats can be specified using the familiar
yyyy/MM/dd
syntax:
PUT my_index { "mappings": { "properties": { "date": { "type": "date", "format": "yyyy-MM-dd" } } } }
Many APIs which support date values also support date math
expressions, such as now-1m/d
— the current time, minus one month, rounded
down to the nearest day.
Custom date formats
editCompletely customizable date formats are supported. The syntax for these is explained DateTimeFormatter docs.
Built In Formats
editMost of the below formats have a strict
companion format, which means that
year, month and day parts of the week must use respectively 4, 2 and 2 digits
exactly, potentially prepending zeros. For instance a date like 5/11/1
would
be considered invalid and would need to be rewritten to 2005/11/01
to be
accepted by the date parser.
To use them, you need to prepend strict_
to the name of the date format, for
instance strict_date_optional_time
instead of date_optional_time
.
These strict date formats are especially useful when date fields are dynamically mapped in order to make sure to not accidentally map irrelevant strings as dates.
The following tables lists all the defaults ISO formats supported:
-
epoch_millis
-
A formatter for the number of milliseconds since the epoch. Note, that
this timestamp is subject to the limits of a Java
Long.MIN_VALUE
andLong.MAX_VALUE
. -
epoch_second
-
A formatter for the number of seconds since the epoch. Note, that this
timestamp is subject to the limits of a Java
Long.MIN_VALUE
andLong. MAX_VALUE
divided by 1000 (the number of milliseconds in a second). -
date_optional_time
orstrict_date_optional_time
-
A generic ISO datetime parser where the date, in
year_month_day
format, is mandatory and the time, separated byT
, is optional. Examples:yyyy-MM-dd'T'HH:mm:ss.SSSZ
oryyyy-MM-dd
. -
basic_date
-
A basic formatter for a full date as four digit year, two digit month of
year, and two digit day of month:
yyyyMMdd
. -
basic_date_time
-
A basic formatter that combines a basic date and time, separated by a T:
yyyyMMdd'T'HHmmss.SSSZ
. -
basic_date_time_no_millis
-
A basic formatter that combines a basic date and time without millis,
separated by a T:
yyyyMMdd'T'HHmmssZ
. -
basic_ordinal_date
-
A formatter for a full ordinal date, using a four digit year and three
digit dayOfYear:
yyyyDDD
. -
basic_ordinal_date_time
-
A formatter for a full ordinal date and time, using a four digit year and
three digit dayOfYear:
yyyyDDD'T'HHmmss.SSSZ
. -
basic_ordinal_date_time_no_millis
-
A formatter for a full ordinal date and time without millis, using a four
digit year and three digit dayOfYear:
yyyyDDD'T'HHmmssZ
. -
basic_time
-
A basic formatter for a two digit hour of day, two digit minute of hour,
two digit second of minute, three digit millis, and time zone offset:
HHmmss.SSSZ
. -
basic_time_no_millis
-
A basic formatter for a two digit hour of day, two digit minute of hour,
two digit second of minute, and time zone offset:
HHmmssZ
. -
basic_t_time
-
A basic formatter for a two digit hour of day, two digit minute of hour,
two digit second of minute, three digit millis, and time zone off set
prefixed by T:
'T'HHmmss.SSSZ
. -
basic_t_time_no_millis
-
A basic formatter for a two digit hour of day, two digit minute of hour,
two digit second of minute, and time zone offset prefixed by T:
'T'HHmmssZ
. -
basic_week_date
orstrict_basic_week_date
-
A basic formatter for a full date as four digit weekyear, two digit week
of weekyear, and one digit day of week:
xxxx'W'wwe
. -
basic_week_date_time
orstrict_basic_week_date_time
-
A basic formatter that combines a basic weekyear date and time, separated
by a T:
xxxx'W'wwe'T'HHmmss.SSSZ
. -
basic_week_date_time_no_millis
orstrict_basic_week_date_time_no_millis
-
A basic formatter that combines a basic weekyear date and time without
millis, separated by a T:
xxxx'W'wwe'T'HHmmssZ
. -
date
orstrict_date
-
A formatter for a full date as four digit year, two digit month of year,
and two digit day of month:
yyyy-MM-dd
. -
date_hour
orstrict_date_hour
-
A formatter that combines a full date and two digit hour of day:
yyyy-MM-dd'T'HH
. -
date_hour_minute
orstrict_date_hour_minute
-
A formatter that combines a full date, two digit hour of day, and two
digit minute of hour:
yyyy-MM-dd'T'HH:mm
. -
date_hour_minute_second
orstrict_date_hour_minute_second
-
A formatter that combines a full date, two digit hour of day, two digit
minute of hour, and two digit second of minute:
yyyy-MM-dd'T'HH:mm:ss
. -
date_hour_minute_second_fraction
orstrict_date_hour_minute_second_fraction
-
A formatter that combines a full date, two digit hour of day, two digit
minute of hour, two digit second of minute, and three digit fraction of
second:
yyyy-MM-dd'T'HH:mm:ss.SSS
. -
date_hour_minute_second_millis
orstrict_date_hour_minute_second_millis
-
A formatter that combines a full date, two digit hour of day, two digit
minute of hour, two digit second of minute, and three digit fraction of
second:
yyyy-MM-dd'T'HH:mm:ss.SSS
. -
date_time
orstrict_date_time
-
A formatter that combines a full date and time, separated by a T:
yyyy-MM-dd'T'HH:mm:ss.SSSZZ
. -
date_time_no_millis
orstrict_date_time_no_millis
-
A formatter that combines a full date and time without millis, separated
by a T:
yyyy-MM-dd'T'HH:mm:ssZZ
. -
hour
orstrict_hour
-
A formatter for a two digit hour of day:
HH
-
hour_minute
orstrict_hour_minute
-
A formatter for a two digit hour of day and two digit minute of hour:
HH:mm
. -
hour_minute_second
orstrict_hour_minute_second
-
A formatter for a two digit hour of day, two digit minute of hour, and two
digit second of minute:
HH:mm:ss
. -
hour_minute_second_fraction
orstrict_hour_minute_second_fraction
-
A formatter for a two digit hour of day, two digit minute of hour, two
digit second of minute, and three digit fraction of second:
HH:mm:ss.SSS
. -
hour_minute_second_millis
orstrict_hour_minute_second_millis
-
A formatter for a two digit hour of day, two digit minute of hour, two
digit second of minute, and three digit fraction of second:
HH:mm:ss.SSS
. -
ordinal_date
orstrict_ordinal_date
-
A formatter for a full ordinal date, using a four digit year and three
digit dayOfYear:
yyyy-DDD
. -
ordinal_date_time
orstrict_ordinal_date_time
-
A formatter for a full ordinal date and time, using a four digit year and
three digit dayOfYear:
yyyy-DDD'T'HH:mm:ss.SSSZZ
. -
ordinal_date_time_no_millis
orstrict_ordinal_date_time_no_millis
-
A formatter for a full ordinal date and time without millis, using a four
digit year and three digit dayOfYear:
yyyy-DDD'T'HH:mm:ssZZ
. -
time
orstrict_time
-
A formatter for a two digit hour of day, two digit minute of hour, two
digit second of minute, three digit fraction of second, and time zone
offset:
HH:mm:ss.SSSZZ
. -
time_no_millis
orstrict_time_no_millis
-
A formatter for a two digit hour of day, two digit minute of hour, two
digit second of minute, and time zone offset:
HH:mm:ssZZ
. -
t_time
orstrict_t_time
-
A formatter for a two digit hour of day, two digit minute of hour, two
digit second of minute, three digit fraction of second, and time zone
offset prefixed by T:
'T'HH:mm:ss.SSSZZ
. -
t_time_no_millis
orstrict_t_time_no_millis
-
A formatter for a two digit hour of day, two digit minute of hour, two
digit second of minute, and time zone offset prefixed by T:
'T'HH:mm:ssZZ
. -
week_date
orstrict_week_date
-
A formatter for a full date as four digit weekyear, two digit week of
weekyear, and one digit day of week:
xxxx-'W'ww-e
. -
week_date_time
orstrict_week_date_time
-
A formatter that combines a full weekyear date and time, separated by a
T:
xxxx-'W'ww-e'T'HH:mm:ss.SSSZZ
. -
week_date_time_no_millis
orstrict_week_date_time_no_millis
-
A formatter that combines a full weekyear date and time without millis,
separated by a T:
xxxx-'W'ww-e'T'HH:mm:ssZZ
. -
weekyear
orstrict_weekyear
-
A formatter for a four digit weekyear:
xxxx
. -
weekyear_week
orstrict_weekyear_week
-
A formatter for a four digit weekyear and two digit week of weekyear:
xxxx-'W'ww
. -
weekyear_week_day
orstrict_weekyear_week_day
-
A formatter for a four digit weekyear, two digit week of weekyear, and one
digit day of week:
xxxx-'W'ww-e
. -
year
orstrict_year
-
A formatter for a four digit year:
yyyy
. -
year_month
orstrict_year_month
-
A formatter for a four digit year and two digit month of year:
yyyy-MM
. -
year_month_day
orstrict_year_month_day
-
A formatter for a four digit year, two digit month of year, and two digit
day of month:
yyyy-MM-dd
.
On this page