Package org.springframework.data.couchbase.core.mapping

Annotation Interface Document

@Inherited
@Retention(RUNTIME)
@Target(TYPE)
@ScanConsistency
public @interface Document

Identifies a domain object to be persisted to Couchbase.

Author:

Michael Nitschinger, Andrey Rubtsov

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
int	expiry	An optional expiry time for the document.
String	expiryExpression	Same as expiry() but allows the actual value to be set using standard Spring property sources mechanism.
TimeUnit	expiryUnit	An optional time unit for the document's expiry(), if set.
com.couchbase.client.java.query.QueryScanConsistency	queryScanConsistency	An optional string indicating the query scan consistency
boolean	touchOnRead	An optional flag associated with expiry() indicating whether the expiry timer should be reset whenever the document is directly read (eg. findByOne, findById).

Element Details

expiry

@AliasFor(annotation=Expiry.class,
          attribute="expiry")
int expiry

An optional expiry time for the document. Default is no expiry. Only one of two might might be set at the same time: either expiry() or expiryExpression()

Default:

0

expiryExpression

@AliasFor(annotation=Expiry.class,
          attribute="expiryExpression")
String expiryExpression

Same as expiry() but allows the actual value to be set using standard Spring property sources mechanism. Only one might be set at the same time: either expiry() or expiryExpression().
Syntax is the same as for PropertyResolver.resolveRequiredPlaceholders(String).

The value will be recalculated for every CouchbaseTemplate save/insert/update call, thus allowing actual expiration to reflect changes on-the-fly as soon as property sources change.

SpEL is NOT supported.

Default:

""

expiryUnit

@AliasFor(annotation=Expiry.class,
          attribute="expiryUnit")
TimeUnit expiryUnit

An optional time unit for the document's expiry(), if set. Default is TimeUnit.SECONDS.

Default:

SECONDS

touchOnRead

boolean touchOnRead

An optional flag associated with expiry() indicating whether the expiry timer should be reset whenever the document is directly read (eg. findByOne, findById).

Default:

false

queryScanConsistency

@AliasFor(annotation=ScanConsistency.class,
          attribute="query")
com.couchbase.client.java.query.QueryScanConsistency queryScanConsistency

An optional string indicating the query scan consistency

Default:

NOT_BOUNDED