io.ebean.annotation

Annotation Type DocStore

@Target(value=TYPE)
 @Retention(value=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 and 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

public abstract String queueId

A unique Id used when queuing reindex events.

Default:

""

indexName

public abstract String indexName

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

Default:

""

indexType

public abstract String indexType

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

Default:

""

enableAll

public abstract boolean enableAll

Set to false to disable the "_all" index.

Default:

true

refreshInterval

public abstract String refreshInterval

Set the refresh interval for the index.

Default:

""

shards

public abstract int shards

The number of shards this index should use.

Default:

0

replicas

public abstract int replicas

The number of replicas this index should use.

Default:

0

mapping

public abstract DocMapping[] mapping

Additional mapping that can be defined on the properties.

Default:

{}

persist

public abstract DocStoreMode persist

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

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

insert

public abstract DocStoreMode insert

Specify the behavior when bean Insert occurs.

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

update

public abstract DocStoreMode update

Specify the behavior when bean Update occurs.

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

delete

public abstract DocStoreMode delete

Specify the behavior when bean Delete occurs.

Default:

io.ebean.annotation.DocStoreMode.DEFAULT

doc

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

// only include the customer id and name
@DocStore(doc = "id,name")
@Entity @Table(name = "o_order")
public class Customer {

Default:

""