- Elasticsearch Guide: other versions:
- Getting Started
- Setup
- Breaking changes
- Breaking changes in 2.1
- Breaking changes in 2.0
- Removed features
- Network changes
- Multiple
path.datastriping - Mapping changes
- CRUD and routing changes
- Query DSL changes
- Search changes
- Aggregation changes
- Parent/Child changes
- Scripting changes
- Index API changes
- Snapshot and Restore changes
- Plugin and packaging changes
- Setting changes
- Stats, info, and
catchanges - Java API changes
- API Conventions
- Document APIs
- Search APIs
- Aggregations
- Metrics Aggregations
- 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
- Bucket Aggregations
- Children Aggregation
- Date Histogram Aggregation
- Date Range Aggregation
- Filter Aggregation
- Filters Aggregation
- Geo Distance Aggregation
- GeoHash grid Aggregation
- Global Aggregation
- Histogram Aggregation
- IPv4 Range Aggregation
- Missing Aggregation
- Nested Aggregation
- Range Aggregation
- Reverse nested Aggregation
- Sampler Aggregation
- Significant Terms 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
- Cumulative Sum Aggregation
- Bucket Script Aggregation
- Bucket Selector Aggregation
- Serial Differencing Aggregation
- Caching heavy aggregations
- Returning only aggregation results
- Aggregation Metadata
- Metrics Aggregations
- Indices APIs
- Create Index
- Delete Index
- Get Index
- Indices Exists
- Open / Close Index API
- Put Mapping
- Get Mapping
- Get Field Mapping
- Types Exists
- Index Aliases
- Update Indices Settings
- Get Settings
- Analyze
- Index Templates
- Warmers
- Shadow replica indices
- Indices Stats
- Indices Segments
- Indices Recovery
- Indices Shard Stores
- Clear Cache
- Flush
- Refresh
- Force Merge
- Optimize
- Upgrade
- cat APIs
- Cluster APIs
- Query DSL
- Mapping
- Field datatypes
- Meta-Fields
- Mapping parameters
analyzerboostcoercecopy_todoc_valuesdynamicenabledfielddataformatgeohashgeohash_precisiongeohash_prefixignore_aboveignore_malformedinclude_in_allindexindex_optionslat_lonfieldsnormsnull_valueposition_increment_gapprecision_steppropertiessearch_analyzersimilaritystoreterm_vector
- Dynamic Mapping
- Transform
- Analysis
- Analyzers
- Tokenizers
- Token Filters
- Standard Token Filter
- ASCII Folding 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
- 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
- Compound Word Token Filter
- 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
- Classic Token Filter
- Apostrophe Token Filter
- Character Filters
- ICU Analysis Plugin
- Modules
- Index Modules
- Testing
- Glossary of terms
- Release Notes
WARNING: Version 2.1 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
_ttl field
edit_ttl field
editDeprecated in 2.0.0-beta2.
The current _ttl implementation is deprecated and will be replaced with a different implementation in a future version
Some types of documents, such as session data or special offers, come with an
expiration date. The _ttl field allows you to specify the minimum time a
document should live, after which time the document is deleted automatically.
Prefer index-per-timeframe to TTL
With TTL , expired documents first have to be marked as deleted then later purged from the index when segments are merged. For append-only time-based data such as log events, it is much more efficient to use an index-per-day / week / month instead of TTLs. Old log data can be removed by simply deleting old indices.
The _ttl field may be enabled as follows:
PUT my_index { "mappings": { "my_type": { "_ttl": { "enabled": true } } } } PUT my_index/my_type/1?ttl=10m { "text": "Will expire in 10 minutes" } PUT my_index/my_type/2 { "text": "Will not expire" }
|
This document will expire 10 minutes after being indexed. |
|
|
This document has no TTL set and will not expire. |
The expiry time is calculated as the value of the
_timestamp field (or now() if the _timestamp
is not enabled) plus the ttl specified in the indexing request.
Default TTL
editYou can provide a default _ttl, which will be applied to indexing requests where the ttl is not specified:
PUT my_index { "mappings": { "my_type": { "_ttl": { "enabled": true, "default": "5m" } } } } PUT my_index/my_type/1?ttl=10m { "text": "Will expire in 10 minutes" } PUT my_index/my_type/2 { "text": "Will expire in 5 minutes" }
|
This document will expire 10 minutes after being indexed. |
|
|
This document has no TTL set and so will expire after the default 5 minutes. |
The default value can use time units like d for days, and
will use ms as the default unit if no time unit is provided.
You can dynamically update the default value using the put mapping
API. It won’t change the _ttl of already indexed documents but will be
used for future documents.
Note on documents expiration
editExpired documents will be automatically deleted periodoically. The following settings control the expiry process:
-
indices.ttl.interval -
How often the purge process should run. Defaults to
60s. Expired documents may still be retrieved before they are purged. -
indices.ttl.bulk_size -
How many deletions are handled by a single
bulkrequest. The default value is10000.
Note on detect_noop
editIf an update tries to update just the _ttl without changing the _source of
the document it’s expiration time won’t be updated if detect_noop is true.
In 2.1 detect_noop defaults to true.