org.springframework.data.couchbase.core.mapping

Annotation Type Document

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Document

Identifies a domain object to be persisted to Couchbase.

Author:

Michael Nitschinger

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	expiry An optional expiry time for the document.
TimeUnit	expiryUnit An optional time unit for the document's expiry(), if set.
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 Detail

expiry

public abstract int expiry

An optional expiry time for the document. Default is no expiry.

Default:

0

expiryUnit

public abstract TimeUnit expiryUnit

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

Default:

java.util.concurrent.TimeUnit.SECONDS

touchOnRead

public abstract 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