Package io.ebean.annotation

Annotation Type DocStore

@Target(TYPE)
@Retention(RUNTIME)
public @interface DocStore

Specify the entity type maps to a document store (like ElasticSearch).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
DocStoreMode	delete	Specify the behavior when bean Delete occurs.
String	doc	Specify to include only some properties in the doc store document.
boolean	enableAll	Set to false to disable the "_all" index.
String	indexName	The ElasticSearch index name.
String	indexType	The ElasticSearch index type.
DocStoreMode	insert	Specify the behavior when bean Insert occurs.
DocMapping[]	mapping	Additional mapping that can be defined on the properties.
DocStoreMode	persist	Specify the behavior when bean Insert, Update, Delete events occur.
String	queueId	A unique Id used when queuing reindex events.
String	refreshInterval	Set the refresh interval for the index.
int	replicas	The number of replicas this index should use.
int	shards	The number of shards this index should use.
DocStoreMode	update	Specify the behavior when bean Update occurs.

Element Detail

queueId

String queueId

A unique Id used when queuing reindex events.

Default:

""

indexName

String indexName

The ElasticSearch index name. If left unspecified the short name of the bean type is used.

Default:

""

indexType

String indexType

The ElasticSearch index type. If left unspecified the short name of the bean type is used.

Default:

""

enableAll

boolean enableAll

Set to false to disable the "_all" index.

Default:

true

refreshInterval

String refreshInterval

Set the refresh interval for the index.

Default:

""

shards

int shards

The number of shards this index should use.

Default:

0

replicas

int replicas

The number of replicas this index should use.

Default:

0

mapping

DocMapping[] mapping

Additional mapping that can be defined on the properties.

Default:

{}

persist

DocStoreMode persist

Specify the behavior when bean Insert, Update, Delete events occur.

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

insert

DocStoreMode insert

Specify the behavior when bean Insert occurs.

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

update

DocStoreMode update

Specify the behavior when bean Update occurs.

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

delete

DocStoreMode delete

Specify the behavior when bean Delete occurs.

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

doc

String doc

Specify to include only some properties in the doc store document.

If this is left as default then all scalar properties are included, all @ManyToOne properties are included with just the nested id property and no @OneToMany properties are included.

Note that typically DocStoreEmbedded is used on @ManyToOne and @OneToMany properties to indicate what part of the nested document should be included.

Example:

{@code

 // only include the customer id and name

Default:

""