- Elasticsearch Guide: other versions:
- Getting Started
- 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
- Starting Elasticsearch
- Stopping Elasticsearch
- Adding nodes to your cluster
- Installing X-Pack
- Set up X-Pack
- Configuring X-Pack Java Clients
- X-Pack Settings
- 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
- 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
- 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
- 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
- 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
- Join Processor
- JSON Processor
- KV 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
- SQL Access
- Monitor a cluster
- Rolling up historical data
- Frozen indices
- Set up a cluster for high availability
- 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
- FIPS 140-2
- Security settings
- Security files
- Auditing Settings
- 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
- 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
- User authorization
- Auditing security events
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, tribe, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- Troubleshooting
- Can’t log in after upgrading to 6.7.2
- 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
- X-Pack APIs
- Info API
- Cross-cluster replication APIs
- Explore API
- Freeze index
- Index lifecycle management API
- Licensing APIs
- Migration APIs
- Machine learning APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create calendar
- Create datafeeds
- Create filter
- Create jobs
- 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
- 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
- SSL certificate
- Unfreeze index
- Watcher APIs
- Definitions
- Release Highlights
- Breaking changes
- Release Notes
- Elasticsearch version 6.7.2
- Elasticsearch version 6.7.1
- Elasticsearch version 6.7.0
- Elasticsearch version 6.6.2
- Elasticsearch version 6.6.1
- Elasticsearch version 6.6.0
- Elasticsearch version 6.5.4
- Elasticsearch version 6.5.3
- Elasticsearch version 6.5.2
- Elasticsearch version 6.5.1
- Elasticsearch version 6.5.0
- Elasticsearch version 6.4.3
- Elasticsearch version 6.4.2
- Elasticsearch version 6.4.1
- Elasticsearch version 6.4.0
- Elasticsearch version 6.3.2
- Elasticsearch version 6.3.1
- Elasticsearch version 6.3.0
- Elasticsearch version 6.2.4
- Elasticsearch version 6.2.3
- Elasticsearch version 6.2.2
- Elasticsearch version 6.2.1
- Elasticsearch version 6.2.0
- Elasticsearch version 6.1.4
- Elasticsearch version 6.1.3
- Elasticsearch version 6.1.2
- Elasticsearch version 6.1.1
- Elasticsearch version 6.1.0
- Elasticsearch version 6.0.1
- Elasticsearch version 6.0.0
- Elasticsearch version 6.0.0-rc2
- Elasticsearch version 6.0.0-rc1
- Elasticsearch version 6.0.0-beta2
- Elasticsearch version 6.0.0-beta1
- Elasticsearch version 6.0.0-alpha2
- Elasticsearch version 6.0.0-alpha1
- Elasticsearch version 6.0.0-alpha1 (Changes previously released in 5.x)
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": { "_doc": { "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 in the Joda 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 is mandatory and the time is optional. Full details here.
-
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