Package org.springframework.data.mongodb.core.mapping

Annotation Interface TimeSeries

@Inherited
@Retention(RUNTIME)
@Target(TYPE)
public @interface TimeSeries

Identifies a domain object to be persisted to a MongoDB Time Series collection.

Since:

3.3

Author:

Christoph Strobl, Ben Foster

See Also:

• https://docs.mongodb.com/manual/core/timeseries-collections

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	timeField	Name of the property which contains the date in each time series document.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	collation	Defines the collation to apply when executing a query or creating indexes.
String	collection	The collection the document representing the entity is supposed to be stored in.
String	expireAfter	Configure the timeout after which the document should expire.
Granularity	granularity	Select the granularity parameter to define how data in the time series collection is organized.
String	metaField	The name of the field which contains metadata in each time series document.

Element Details

timeField

String timeField

Name of the property which contains the date in each time series document.
Translation of property names to annotated fieldnames will be considered during the mapping process.

Returns:

never null.

collection

@AliasFor(annotation=Document.class,
          attribute="collection")
String collection

The collection the document representing the entity is supposed to be stored in. If not configured, a default collection name will be derived from the type's name. The attribute supports SpEL expressions to dynamically calculate the collection based on a per operation basis.

Returns:

the name of the collection to be used.

See Also:

• Document.collection()

Default:

""

metaField

String metaField

The name of the field which contains metadata in each time series document. Should not be the id nor timeField() nor point to an array or Collection.
Translation of property names to annotated fieldnames will be considered during the mapping process.

Returns:

empty String by default.

Default:

""

granularity

Granularity granularity

Select the granularity parameter to define how data in the time series collection is organized.

Returns:

server default by default.

Default:

DEFAULT

collation

@AliasFor(annotation=Document.class,
          attribute="collation")
String collation

Defines the collation to apply when executing a query or creating indexes.

Returns:

an empty String by default.

See Also:

• Document.collation()

Default:

""

expireAfter

String expireAfter

Configure the timeout after which the document should expire. Defaults to an empty String for no expiry. Accepts numeric values followed by their unit of measure:

• d: Days
• h: Hours
• m: Minutes
• s: Seconds
• Alternatively: A Spring template expression. The expression can result in a Duration or a valid expiration String according to the already mentioned conventions.

Supports ISO-8601 style.

 @TimeSeries(expireAfter = "10s") String expireAfterTenSeconds;
 @TimeSeries(expireAfter = "1d") String expireAfterOneDay;
 @TimeSeries(expireAfter = "P2D") String expireAfterTwoDays;
 @TimeSeries(expireAfter = "#{@mySpringBean.timeout}") String expireAfterTimeoutObtainedFromSpringBean;
 @TimeSeries(expireAfter = "${my.property.timeout}") String expireAfterTimeoutObtainedFromProperty;
 

Returns:

empty by default.

Since:

4.4

Default:

""