Package io.ebean.annotation

Extra deployment annotations

Extra deployment annotations for entity beans.

Enum Summary

Enum	Description
ChangeLogInsertMode	The mode used to determine if inserts should be included or not for a given bean type.
ConstraintMode	Modes for the DbForeignKey onDelete and onUpdate clause of a foreign keys.
DbEnumType	Specify the DB storage type used to with @DbEnumValue.
DbJsonType	Specify the DB storage type used to store JSON content.
DocProperty.Option	Index options for a property.
DocStoreMode	Defines the behavior options when a Insert, Update or Delete event occurs on a bean with an associated ElasticSearch index.
IdentityGenerated	For IDENTITY specifies the generated ALWAYS or BY DEFAULT option.
IdentityType	The type of identity to be used.
PartitionMode	Common partition modes.
PersistBatch	Defines the mode for JDBC batch processing.
Platform	Built in supported platforms.
TxIsolation	The Transaction Isolation levels.
TxType	Used to define the transactional scope for executing a method.

Annotation Types Summary

Annotation Type	Description
Aggregation	Specify a property to be an aggregation formula.
Avg	Specify a property to be an AVG aggregation.
Cache	Specify the default cache use specific entity type.
CacheBeanTuning	Cache tuning hints for the L2 bean cache of a specific entity type.
CacheQueryTuning	Specify cache tuning for query caching on a specific entity type.
ChangeLog	Marks an entity bean as being included in the change logging.
CreatedTimestamp	Deprecated.
DbArray	Specify a collection property that will be stored into a DB ARRAY type.
DbComment	A database table or column comment.
DbDefault	Annotation to specify a default value for DDL-generation & Migration.
DbEnumValue	Specify a method on an Enum that returns the value that should be stored in the DB.
DbForeignKey	Specify how a foreign key constraint should be defined.
DbJson	Specify a property holding JSON content.
DbJsonB	Specify a property holding JSON content.
DbMap	Used for mapping a Map type property to Postgres HSTORE data type.
DbMigration	Annotation to specify details for DDL & Migration-generation.
DbMigration.List	Repeatable support for DbMigration.
DbName	Specify the name of the DB that the entity should use.
DbPartition	Specify that the underlying table is partitioned.
DocCode	Used to indicate that a particular string property should be treated as a 'code' and not analysed for text searching.
DocEmbedded	Specify the property is included in the parent document store index.
DocMapping	Specify the entity type maps to a document store (like ElasticSearch).
DocProperty	Specify the entity type maps to a document store (like ElasticSearch).
DocSortable	Used to indicate that a particular string property should support sorting.
DocStore	Specify the entity type maps to a document store (like ElasticSearch).
Draft	Marks a boolean property on a @Draftable bean that indicates if the bean instance is a 'draft' or 'live' bean.
Draftable	Used to indicate an entity bean that has 'draftable' support.
DraftableElement	Used to indicate an entity bean that has 'draftable' support but it not a 'top level' (or root level) bean but instead child related to another @Draftable entity bean.
DraftDirty	Marks a boolean property on a @Draftable bean that only exists on the 'draft' table and is used to detect when a draft has unpublished changes.
DraftOnly	Marks a property on a @Draftable bean that only exists on the 'draft' and not the 'live' table.
DraftReset	Marks a property on a @Draftable bean that is set to null on the 'draft bean' on publish.
EbeanComponent	Annotated classes (like BeanPersistAdapter, BeanPersistListener etc) with @EbeanComponent and these will be registered with Ebean.
Encrypted	Specify that the property is stored in encrypted form.
EnumValue	Enables you to specify a value to use to persist for an enum value.
Expose
FetchPreference	Used to control which ToMany relationships are preferred as 'joins' rather than as 'secondary joins' (query fetches).
Formula	Assign to a property to be based on a SQL formula.
Formula.List	Repeatable support for Formula.
History	Marks an entity bean as having history support.
HistoryExclude	Marks a property as being excluded from history.
Identity	Defines identity generation for an associated entity bean.
Index	An annotation for declaring an index.
Indices	An annotation for declaring multiple indices at class or field level.
InvalidateQueryCache	This is put on entity bean types that themselves are not L2 cached directly but are instead joined to other entity beans that are query cached.
JsonIgnore	Similar to Jackson JsonIgnore but provides the option to just ignore serialize or deserialize.
Length	A non-JPA standard alternative to using @Column(length).
Max	Specify a property to be an MAX aggregation.
Min	Specify a property to be an MIN aggregation.
NotNull	A non-JPA standard alternative to using @Column(nullable=false) or javax validation @NotNull.
PostSoftDelete	Marks a method as executing after a Soft Delete.
PreSoftDelete	Marks a method as executing prior to a Soft Delete.
ReadAudit	Marks an entity bean as being included in read auditing.
SoftDelete	Used to indicate a property on an entity bean used to control 'soft delete' (also known as 'logical delete').
Sql	Mark and entity bean that is used solely via RawSql.
StorageEngine	Specify a storage engine to use with a specific table.
Sum	Specify a property to be an SUM aggregation.
TenantId	Marks a property as mapping to the "Tenant Id" when using Partition based multi-tenancy support.
Transactional	Specify transaction scoping for a method.
UnmappedJson	Marks a Map property on a bean that unmapped JSON properties go into.
UpdatedTimestamp	Deprecated.
View	Annotate an entity bean with @View to indicates the bean is based on a view.
WhenCreated	For a timestamp property that is set to the datetime when the entity is created/inserted.
WhenModified	For a timestamp property that is set to the datetime when the entity was last modified.
Where	Add an Literal to add to the where clause when a many property (List, Set or Map) is loaded or refreshed.
Where.List	Repeatable support for Where.
WhoCreated	Mapped onto a entity bean property that represents the user id of who created the entity>
WhoModified	Mapped onto a entity bean property that represents the user id of who last modified the entity>