A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- Aggregation - Annotation Type in io.ebean.annotation
-
Specify a property to be an aggregation formula.
- ALL - io.ebean.annotation.PersistBatch
-
Use JDBC Batch mode on Inserts, Updates and Deletes.
- ALWAYS - io.ebean.annotation.IdentityGenerated
-
Use GENERATED ALWAYS AS IDENTITY.
- analyzer() - Method in annotation type io.ebean.annotation.DocProperty
-
The analyzer to use.
- APPLICATION - io.ebean.annotation.IdentityType
-
Application supplies the identity value.
- AUTO - io.ebean.annotation.IdentityGenerated
-
Platform default option chosen.
- AUTO - io.ebean.annotation.IdentityType
-
Use the platform default identity type (database Identity or Sequence).
- Avg - Annotation Type in io.ebean.annotation
-
Specify a property to be an AVG aggregation.
B
- base() - Method in enum io.ebean.annotation.Platform
-
Return the base platform.
- batch() - Method in annotation type io.ebean.annotation.Transactional
-
Persist batch mode for the transaction.
- batchOnCascade() - Method in annotation type io.ebean.annotation.Transactional
-
Persist batch mode for the request if not set on the transaction.
- batchSize() - Method in annotation type io.ebean.annotation.Transactional
-
The batch size to use when using JDBC batch mode.
- BLOB - io.ebean.annotation.DbJsonType
-
Store as database BLOB.
- boost() - Method in annotation type io.ebean.annotation.DocCode
-
Set a boost value specific to this property.
- boost() - Method in annotation type io.ebean.annotation.DocProperty
-
Set a boost value specific to this property.
- boost() - Method in annotation type io.ebean.annotation.DocSortable
-
Set a boost value specific to this property.
- BY_DEFAULT - io.ebean.annotation.IdentityGenerated
-
Use GENERATED BY DEFAULT AS IDENTITY.
C
- cache() - Method in annotation type io.ebean.annotation.Identity
-
Optional CACHE option for database IDENTITY or SEQUENCE.
- Cache - Annotation Type in io.ebean.annotation
-
Specify the default cache use specific entity type.
- CacheBeanTuning - Annotation Type in io.ebean.annotation
-
Cache tuning hints for the L2 bean cache of a specific entity type.
- CacheQueryTuning - Annotation Type in io.ebean.annotation
-
Specify cache tuning for query caching on a specific entity type.
- CASCADE - io.ebean.annotation.ConstraintMode
-
Cascade - To automatically cascade a delete of a referenced id.
- ChangeLog - Annotation Type in io.ebean.annotation
-
Marks an entity bean as being included in the change logging.
- ChangeLogInsertMode - Enum in io.ebean.annotation
-
The mode used to determine if inserts should be included or not for a given bean type.
- clause() - Method in annotation type io.ebean.annotation.Where
-
The clause added to the lazy load query.
- CLICKHOUSE - io.ebean.annotation.Platform
-
ClickHouse.
- CLOB - io.ebean.annotation.DbJsonType
-
Store as database CLOB.
- COCKROACH - io.ebean.annotation.Platform
-
CockroachDB.
- code() - Method in annotation type io.ebean.annotation.DocProperty
-
Set this to true to indicate that this property should be un-analysed.
- columnNames() - Method in annotation type io.ebean.annotation.Index
-
When placed on the class (rather than field) you can specify the columns to include in the index in order.
- concurrent() - Method in annotation type io.ebean.annotation.Index
-
If set true with Postgres this index should be created concurrently.
- ConstraintMode - Enum in io.ebean.annotation
-
Modes for the DbForeignKey onDelete and onUpdate clause of a foreign keys.
- copyTo() - Method in annotation type io.ebean.annotation.DocProperty
-
Set a copyTo field.
- CreatedTimestamp - Annotation Type in io.ebean.annotation
-
Deprecated.
D
- DAY - io.ebean.annotation.PartitionMode
-
Daily partitioning.
- DB2 - io.ebean.annotation.Platform
-
DB2.
- DbArray - Annotation Type in io.ebean.annotation
-
Specify a collection property that will be stored into a DB ARRAY type.
- DbComment - Annotation Type in io.ebean.annotation
-
A database table or column comment.
- DbDefault - Annotation Type in io.ebean.annotation
-
Annotation to specify a default value for DDL-generation & Migration.
- dbEncryption() - Method in annotation type io.ebean.annotation.Encrypted
-
When true try to use DB encryption rather than local java encryption.
- DbEnumType - Enum in io.ebean.annotation
-
Specify the DB storage type used to with
@DbEnumValue. - DbEnumValue - Annotation Type in io.ebean.annotation
-
Specify a method on an Enum that returns the value that should be stored in the DB.
- DbForeignKey - Annotation Type in io.ebean.annotation
-
Specify how a foreign key constraint should be defined.
- DbJson - Annotation Type in io.ebean.annotation
-
Specify a property holding JSON content.
- DbJsonB - Annotation Type in io.ebean.annotation
-
Specify a property holding JSON content.
- DbJsonType - Enum in io.ebean.annotation
-
Specify the DB storage type used to store JSON content.
- dbLength() - Method in annotation type io.ebean.annotation.Encrypted
-
Used to specify the DB column length.
- DbMap - Annotation Type in io.ebean.annotation
-
Used for mapping a Map
type property to Postgres HSTORE data type. - DbMigration - Annotation Type in io.ebean.annotation
-
Annotation to specify details for DDL & Migration-generation.
- DbMigration.List - Annotation Type in io.ebean.annotation
-
Repeatable support for
DbMigration. - DbName - Annotation Type in io.ebean.annotation
-
Specify the name of the DB that the entity should use.
- DbPartition - Annotation Type in io.ebean.annotation
-
Specify that the underlying table is partitioned.
- DEFAULT - io.ebean.annotation.ChangeLogInsertMode
-
Use the default behaviour as defined on ServerConfig.
- DEFAULT - io.ebean.annotation.DocProperty.Option
-
Use the default which means analysed string properties use POSITIONS as the default and all other types use DOCS.
- DEFAULT - io.ebean.annotation.DocStoreMode
-
The actual mode of QUEUE, UPDATE or IGNORE is set from the default configuration.
- DEFAULT - io.ebean.annotation.TxIsolation
-
The default isolation level.
- definition() - Method in annotation type io.ebean.annotation.Index
-
The full raw SQL definition to create the index.
- delete() - Method in annotation type io.ebean.annotation.DocStore
-
Specify the behavior when bean Delete occurs.
- dependentTables() - Method in annotation type io.ebean.annotation.View
-
Tables this view is dependent on.
- deserialize() - Method in annotation type io.ebean.annotation.Expose
-
If
true, the field marked with this annotation is deserialized from the JSON. - deserialize() - Method in annotation type io.ebean.annotation.JsonIgnore
-
If
true, the field marked with this annotation is deserialized from the JSON. - doc() - Method in annotation type io.ebean.annotation.DocEmbedded
-
The properties on the embedded bean to include in the index.
- doc() - Method in annotation type io.ebean.annotation.DocStore
-
Specify to include only some properties in the doc store document.
- DocCode - Annotation Type in io.ebean.annotation
-
Used to indicate that a particular string property should be treated as a 'code' and not analysed for text searching.
- DocEmbedded - Annotation Type in io.ebean.annotation
-
Specify the property is included in the parent document store index.
- DocMapping - Annotation Type in io.ebean.annotation
-
Specify the entity type maps to a document store (like ElasticSearch).
- DocProperty - Annotation Type in io.ebean.annotation
-
Specify the entity type maps to a document store (like ElasticSearch).
- DocProperty.Option - Enum in io.ebean.annotation
-
Index options for a property.
- DOCS - io.ebean.annotation.DocProperty.Option
-
Only index the doc number.
- DocSortable - Annotation Type in io.ebean.annotation
-
Used to indicate that a particular string property should support sorting.
- DocStore - Annotation Type in io.ebean.annotation
-
Specify the entity type maps to a document store (like ElasticSearch).
- DocStoreMode - Enum in io.ebean.annotation
-
Defines the behavior options when a Insert, Update or Delete event occurs on a bean with an associated ElasticSearch index.
- docValues() - Method in annotation type io.ebean.annotation.DocProperty
-
Set this to false such that doc values are not stored separately for this property.
- Draft - Annotation Type in io.ebean.annotation
-
Marks a boolean property on a @Draftable bean that indicates if the bean instance is a 'draft' or 'live' bean.
- Draftable - Annotation Type in io.ebean.annotation
-
Used to indicate an entity bean that has 'draftable' support.
- DraftableElement - Annotation Type in io.ebean.annotation
-
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 - Annotation Type in io.ebean.annotation
-
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 - Annotation Type in io.ebean.annotation
-
Marks a property on a @Draftable bean that only exists on the 'draft' and not the 'live' table.
- DraftReset - Annotation Type in io.ebean.annotation
-
Marks a property on a @Draftable bean that is set to null on the 'draft bean' on publish.
E
- EbeanComponent - Annotation Type in io.ebean.annotation
-
Annotated classes (like BeanPersistAdapter, BeanPersistListener etc) with @EbeanComponent and these will be registered with Ebean.
- enableAll() - Method in annotation type io.ebean.annotation.DocStore
-
Set to false to disable the "_all" index.
- enableBeanCache() - Method in annotation type io.ebean.annotation.Cache
-
Set this to false to disable the use of bean cache.
- enabled() - Method in annotation type io.ebean.annotation.DocProperty
-
Set to false to disable the field from indexing, it will only be get/set in _source.
- enableQueryCache() - Method in annotation type io.ebean.annotation.Cache
-
Set this to true to enable the use of query cache.
- Encrypted - Annotation Type in io.ebean.annotation
-
Specify that the property is stored in encrypted form.
- EnumValue - Annotation Type in io.ebean.annotation
-
Enables you to specify a value to use to persist for an enum value.
- EXCLUDE - io.ebean.annotation.ChangeLogInsertMode
-
Exclude inserts in the change log.
- Expose - Annotation Type in io.ebean.annotation
F
- FetchPreference - Annotation Type in io.ebean.annotation
-
Used to control which ToMany relationships are preferred as 'joins' rather than as 'secondary joins' (query fetches).
- flushOnQuery() - Method in annotation type io.ebean.annotation.Transactional
-
Set this to false if the JDBC batch should not be automatically flushed when a query is executed.
- Formula - Annotation Type in io.ebean.annotation
-
Assign to a property to be based on a SQL formula.
- Formula.List - Annotation Type in io.ebean.annotation
-
Repeatable support for
Formula. - FREQS - io.ebean.annotation.DocProperty.Option
-
Doc number and term frequencies are indexed.
- fromLevel(int) - Static method in enum io.ebean.annotation.TxIsolation
-
Return the TxIsolation given the java.sql.Connection isolation level.
G
- generated() - Method in annotation type io.ebean.annotation.Identity
-
For IDENTITY type specify the generated mode of ALWAYS or BY DEFAULT.
- GENERIC - io.ebean.annotation.Platform
-
Generic platform configured via properties or code.
- getGeneratedKeys() - Method in annotation type io.ebean.annotation.Transactional
-
Set to false when we want to skip getting generatedKeys.
- getLevel() - Method in enum io.ebean.annotation.TxIsolation
-
Return the level as per java.sql.Connection.
H
- H2 - io.ebean.annotation.Platform
-
H2.
- HANA - io.ebean.annotation.Platform
-
SAP HANA
- History - Annotation Type in io.ebean.annotation
-
Marks an entity bean as having history support.
- HistoryExclude - Annotation Type in io.ebean.annotation
-
Marks a property as being excluded from history.
- HSQLDB - io.ebean.annotation.Platform
-
HsqlDB.
I
- Identity - Annotation Type in io.ebean.annotation
-
Defines identity generation for an associated entity bean.
- IDENTITY - io.ebean.annotation.IdentityType
-
Use database IDENTITY column.
- IdentityGenerated - Enum in io.ebean.annotation
-
For IDENTITY specifies the generated ALWAYS or BY DEFAULT option.
- IdentityType - Enum in io.ebean.annotation
-
The type of identity to be used.
- IGNORE - io.ebean.annotation.DocStoreMode
-
Ignore the event and not update the document store.
- INCLUDE - io.ebean.annotation.ChangeLogInsertMode
-
Include inserts in the change log.
- includeInAll() - Method in annotation type io.ebean.annotation.DocProperty
-
Set this to false to exclude this from the _all property.
- increment() - Method in annotation type io.ebean.annotation.Identity
-
Optional INCREMENT BY value of an IDENTITY or SEQUENCE.
- Index - Annotation Type in io.ebean.annotation
-
An annotation for declaring an index.
- indexName() - Method in annotation type io.ebean.annotation.DocStore
-
The ElasticSearch index name.
- indexType() - Method in annotation type io.ebean.annotation.DocStore
-
The ElasticSearch index type.
- Indices - Annotation Type in io.ebean.annotation
-
An annotation for declaring multiple indices at class or field level.
- INHERIT - io.ebean.annotation.PersistBatch
-
You should not use this value explicitly.
- insert() - Method in annotation type io.ebean.annotation.DocStore
-
Specify the behavior when bean Insert occurs.
- inserts() - Method in annotation type io.ebean.annotation.ChangeLog
-
Specify if inserts should be explicitly Included or Excluded.
- INTEGER - io.ebean.annotation.DbEnumType
-
Store values as database INTEGER.
- InvalidateQueryCache - Annotation Type in io.ebean.annotation
-
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.
- io.ebean.annotation - package io.ebean.annotation
-
Extra deployment annotations
- isolation() - Method in annotation type io.ebean.annotation.Transactional
-
The transaction isolation level this transaction should have.
J
- join() - Method in annotation type io.ebean.annotation.Formula
-
OPTIONAL - the SQL to be used in the JOIN part of the SQL to support the formula.
- JSON - io.ebean.annotation.DbJsonType
-
Store as JSON on Postgres and for other databases store as CLOB.
- JSONB - io.ebean.annotation.DbJsonType
-
Store as JSONB on Postgres and for other databases store as CLOB.
- JsonIgnore - Annotation Type in io.ebean.annotation
-
Similar to Jackson JsonIgnore but provides the option to just ignore serialize or deserialize.
L
- label() - Method in annotation type io.ebean.annotation.Transactional
-
Set a label to identify the transaction in performance metrics and logging.
- length() - Method in annotation type io.ebean.annotation.DbArray
-
For VARCHAR storage specify the column length (defaults to 1000).
- length() - Method in annotation type io.ebean.annotation.DbEnumValue
-
The column length for VARCHAR.
- length() - Method in annotation type io.ebean.annotation.DbJson
-
For VARCHAR storage specify the column length (defaults to 3000).
- length() - Method in annotation type io.ebean.annotation.DbJsonB
-
For VARCHAR storage specify the column length.
- length() - Method in annotation type io.ebean.annotation.DbMap
-
For VARCHAR storage specify the column length (defaults to 1000).
- Length - Annotation Type in io.ebean.annotation
-
A non-JPA standard alternative to using
@Column(length).
M
- MANDATORY - io.ebean.annotation.TxType
-
A transaction MUST already have been started.
- mapping() - Method in annotation type io.ebean.annotation.DocStore
-
Additional mapping that can be defined on the properties.
- MARIADB - io.ebean.annotation.Platform
-
MariaDB.
- Max - Annotation Type in io.ebean.annotation
-
Specify a property to be an MAX aggregation.
- maxIdleSecs() - Method in annotation type io.ebean.annotation.CacheBeanTuning
-
The maximum time (in seconds) that a cache entry is allowed to stay in the cache when it has not been accessed.
- maxIdleSecs() - Method in annotation type io.ebean.annotation.CacheQueryTuning
-
The maximum time (in seconds) that a cache entry is allowed to stay in the cache when it has not been accessed.
- maxSecsToLive() - Method in annotation type io.ebean.annotation.CacheBeanTuning
-
The maximum time (in seconds) a cache entry is allowed to stay in the cache.
- maxSecsToLive() - Method in annotation type io.ebean.annotation.CacheQueryTuning
-
The maximum time (in seconds) a cache entry is allowed to stay in the cache.
- maxSize() - Method in annotation type io.ebean.annotation.CacheBeanTuning
-
The maximum size for the cache.
- maxSize() - Method in annotation type io.ebean.annotation.CacheQueryTuning
-
The maximum size for the cache.
- Min - Annotation Type in io.ebean.annotation
-
Specify a property to be an MIN aggregation.
- mode() - Method in annotation type io.ebean.annotation.DbPartition
-
The partition mode.
- MONTH - io.ebean.annotation.PartitionMode
-
Month based partitioning.
- MYSQL - io.ebean.annotation.Platform
-
MySql.
- MYSQL55 - io.ebean.annotation.Platform
-
MySql 5.5.
N
- name() - Method in annotation type io.ebean.annotation.DbArray
-
The name of the column (Optional).
- name() - Method in annotation type io.ebean.annotation.DbJson
-
The name of the column (Optional).
- name() - Method in annotation type io.ebean.annotation.DbJsonB
-
The name of the column (Optional).
- name() - Method in annotation type io.ebean.annotation.DbMap
-
The name of the column (Optional).
- name() - Method in annotation type io.ebean.annotation.DocMapping
-
The property name the mapping applies to.
- name() - Method in annotation type io.ebean.annotation.Index
-
Name of the index.
- name() - Method in annotation type io.ebean.annotation.View
-
The name of the view this entity bean is based on.
- naturalKey() - Method in annotation type io.ebean.annotation.Cache
-
Specify the properties that is a natural unique identifier for the bean.
- nearCache() - Method in annotation type io.ebean.annotation.Cache
-
If set to true additionally use a near cache (for Redis and similar L2 cache options).
- NEVER - io.ebean.annotation.TxType
-
If there is an existing transaction throws an Exception.
- noConstraint() - Method in annotation type io.ebean.annotation.DbForeignKey
-
Set to true when we do not wish any foreign key constraint to be created.
- noIndex() - Method in annotation type io.ebean.annotation.DbForeignKey
-
Set to true when we do not wish an index to be created on the foreign key column(s).
- NONE - io.ebean.annotation.PersistBatch
-
Do not use JDBC Batch mode.
- NONE - io.ebean.annotation.TxIsolation
-
No Isolation level.
- norms() - Method in annotation type io.ebean.annotation.DocProperty
-
Set to false such that norms are not stored.
- noRollbackFor() - Method in annotation type io.ebean.annotation.Transactional
-
The Throwable's that will explicitly NOT cause a rollback to occur.
- NOT_SUPPORTED - io.ebean.annotation.TxType
-
Suspends an existing transaction if required.
- NotNull - Annotation Type in io.ebean.annotation
-
A non-JPA standard alternative to using
@Column(nullable=false)or javax validation@NotNull. - nullValue() - Method in annotation type io.ebean.annotation.DocCode
-
Set a value to use instead of null.
- nullValue() - Method in annotation type io.ebean.annotation.DocProperty
-
Set a value to use instead of null.
- nullValue() - Method in annotation type io.ebean.annotation.DocSortable
-
Set a value to use instead of null.
- NUODB - io.ebean.annotation.Platform
-
NuoDB.
O
- OFFSETS - io.ebean.annotation.DocProperty.Option
-
Doc number, term frequencies, term positions and start/end offsets are indexed.
- onDelete() - Method in annotation type io.ebean.annotation.DbForeignKey
-
Specify the onDelete mode.
- onUpdate() - Method in annotation type io.ebean.annotation.DbForeignKey
-
Do NOT change this - seriously, don't do it.
- options() - Method in annotation type io.ebean.annotation.DocMapping
-
Mapping options.
- options() - Method in annotation type io.ebean.annotation.DocProperty
-
The index options for this property.
- ORACLE - io.ebean.annotation.Platform
-
Oracle preferred platform 12c and higher.
- ORACLE11 - io.ebean.annotation.Platform
-
Oracle 11 platform.
P
- PartitionMode - Enum in io.ebean.annotation
-
Common partition modes.
- persist() - Method in annotation type io.ebean.annotation.DocStore
-
Specify the behavior when bean Insert, Update, Delete events occur.
- PersistBatch - Enum in io.ebean.annotation
-
Defines the mode for JDBC batch processing.
- Platform - Enum in io.ebean.annotation
-
Built in supported platforms.
- platforms() - Method in annotation type io.ebean.annotation.DbMigration
-
Specific platforms this migration change applies to.
- platforms() - Method in annotation type io.ebean.annotation.Formula
- platforms() - Method in annotation type io.ebean.annotation.Index
-
Platforms this index applies to - default is all platforms.
- platforms() - Method in annotation type io.ebean.annotation.Where
-
The platform where this annotation is active.
- POSITIONS - io.ebean.annotation.DocProperty.Option
-
Doc number, term frequencies and term positions are indexed.
- postAdd() - Method in annotation type io.ebean.annotation.DbMigration
-
DdlScript that will be executed after the 'add' command.
- postAlter() - Method in annotation type io.ebean.annotation.DbMigration
-
DdlScript that will be executed after the 'alter' command
- POSTGRES - io.ebean.annotation.Platform
-
Postgres preferred platform for 10+.
- POSTGRES9 - io.ebean.annotation.Platform
-
Postgres 9.
- PostSoftDelete - Annotation Type in io.ebean.annotation
-
Marks a method as executing after a Soft Delete.
- preAdd() - Method in annotation type io.ebean.annotation.DbMigration
-
DdlScript that will be executed before the 'add' command
- preAlter() - Method in annotation type io.ebean.annotation.DbMigration
-
DdlScripts that will be executed before the 'alter' command.
- PreSoftDelete - Annotation Type in io.ebean.annotation
-
Marks a method as executing prior to a Soft Delete.
- profileId() - Method in annotation type io.ebean.annotation.Transactional
-
A key used to identify a specific transaction for profiling purposes.
- property() - Method in annotation type io.ebean.annotation.DbPartition
-
The property or column to partition on.
Q
- QUEUE - io.ebean.annotation.DocStoreMode
-
Add the event to the queue for processing later (delaying the update to the document store).
- queueId() - Method in annotation type io.ebean.annotation.DocStore
-
A unique Id used when queuing reindex events.
R
- READ_COMMITED - io.ebean.annotation.TxIsolation
-
Read Committed Isolation level.
- READ_UNCOMMITTED - io.ebean.annotation.TxIsolation
-
Read uncommitted Isolation level.
- ReadAudit - Annotation Type in io.ebean.annotation
-
Marks an entity bean as being included in read auditing.
- readOnly() - Method in annotation type io.ebean.annotation.Cache
-
When set to true the beans returned from a query will default to be readOnly.
- readOnly() - Method in annotation type io.ebean.annotation.Transactional
-
Set this to true if the transaction should be only contain queries.
- refreshInterval() - Method in annotation type io.ebean.annotation.DocStore
-
Set the refresh interval for the index.
- region() - Method in annotation type io.ebean.annotation.Cache
-
Specify a named cache region.
- region() - Method in annotation type io.ebean.annotation.InvalidateQueryCache
-
Specify a named cache region.
- REPEATABLE_READ - io.ebean.annotation.TxIsolation
-
Repeatable Read Isolation level.
- replicas() - Method in annotation type io.ebean.annotation.DocStore
-
The number of replicas this index should use.
- REQUIRED - io.ebean.annotation.TxType
-
Uses an existing transaction and if none exists will starts a new Transaction.
- REQUIRES_NEW - io.ebean.annotation.TxType
-
Always start a new transaction.
- RESTRICT - io.ebean.annotation.ConstraintMode
-
Restrict - The usual default behavior for foreign constraints (also known as 'No Action').
- rollbackFor() - Method in annotation type io.ebean.annotation.Transactional
-
The Throwable's that will explicitly cause a rollback to occur.
S
- searchAnalyzer() - Method in annotation type io.ebean.annotation.DocProperty
-
The analyzer to use for searches.
- select() - Method in annotation type io.ebean.annotation.Formula
-
The SQL to be used in the SELECT part of the SQL to populate a property.
- SEQUENCE - io.ebean.annotation.IdentityType
-
Using a database SEQUENCE for the identity value.
- sequenceName() - Method in annotation type io.ebean.annotation.Identity
-
Sequence name when using type SEQUENCE.
- SERIALIZABLE - io.ebean.annotation.TxIsolation
-
Serializable Isolation level.
- serialize() - Method in annotation type io.ebean.annotation.Expose
-
If
true, the field marked with this annotation is written out in the JSON while serializing. - serialize() - Method in annotation type io.ebean.annotation.JsonIgnore
-
If
true, the field marked with this annotation is written out in the JSON while serializing. - SET_DEFAULT - io.ebean.annotation.ConstraintMode
-
Set the value to 'default' when a referenced id is deleted.
- SET_NULL - io.ebean.annotation.ConstraintMode
-
Set the value to null when a referenced id is deleted.
- shards() - Method in annotation type io.ebean.annotation.DocStore
-
The number of shards this index should use.
- skipCache() - Method in annotation type io.ebean.annotation.Transactional
-
Set this to true such that the L2 cache is not used by queries that otherwise would.
- SoftDelete - Annotation Type in io.ebean.annotation
-
Used to indicate a property on an entity bean used to control 'soft delete' (also known as 'logical delete').
- sortable() - Method in annotation type io.ebean.annotation.DocProperty
-
Set this to true to get an additional un-analysed 'raw' field to use for sorting etc.
- Sql - Annotation Type in io.ebean.annotation
-
Mark and entity bean that is used solely via RawSql.
- SQLANYWHERE - io.ebean.annotation.Platform
-
SQLAnywhere.
- SQLITE - io.ebean.annotation.Platform
-
SQLite.
- SQLSERVER - io.ebean.annotation.Platform
-
Microsoft SQL Server (preferred platform 2017).
- SQLSERVER16 - io.ebean.annotation.Platform
-
Microsoft SQL Server 2016 platform (Non UTF8 types and Identity by default).
- SQLSERVER17 - io.ebean.annotation.Platform
-
Microsoft SQL Server 2017 platform (UTF8 types and Sequence).
- start() - Method in annotation type io.ebean.annotation.Identity
-
Optional START WITH value of an IDENTITY or SEQUENCE.
- storage() - Method in annotation type io.ebean.annotation.DbEnumValue
-
Specify the database type used to store the values (VARCHAR or INTEGER).
- storage() - Method in annotation type io.ebean.annotation.DbJson
-
Specify the database type used to store the JSON content.
- StorageEngine - Annotation Type in io.ebean.annotation
-
Specify a storage engine to use with a specific table.
- store() - Method in annotation type io.ebean.annotation.DocCode
-
Set to true to have the property additionally stored separately from _source.
- store() - Method in annotation type io.ebean.annotation.DocProperty
-
Set to true to have the property additionally stored separately from _source.
- store() - Method in annotation type io.ebean.annotation.DocSortable
-
Set to true to have the property additionally stored separately from _source.
- Sum - Annotation Type in io.ebean.annotation
-
Specify a property to be an SUM aggregation.
- SUPPORTS - io.ebean.annotation.TxType
-
Uses the existing transaction if one exists, otherwise the method does not run with a transaction.
T
- TenantId - Annotation Type in io.ebean.annotation
-
Marks a property as mapping to the "Tenant Id" when using Partition based multi-tenancy support.
- Transactional - Annotation Type in io.ebean.annotation
-
Specify transaction scoping for a method.
- trimFrequency() - Method in annotation type io.ebean.annotation.CacheBeanTuning
-
The frequency (in seconds) that cache trimming should occur.
- trimFrequency() - Method in annotation type io.ebean.annotation.CacheQueryTuning
-
The frequency (in seconds) that cache trimming should occur.
- TxIsolation - Enum in io.ebean.annotation
-
The Transaction Isolation levels.
- TxType - Enum in io.ebean.annotation
-
Used to define the transactional scope for executing a method.
- type() - Method in annotation type io.ebean.annotation.Identity
-
The type of identity for the associated entity bean.
- type() - Method in annotation type io.ebean.annotation.Transactional
-
The type of transaction scoping.
U
- unique() - Method in annotation type io.ebean.annotation.Index
-
If set true indicates this is a unique index.
- UnmappedJson - Annotation Type in io.ebean.annotation
-
Marks a Map property on a bean that unmapped JSON properties go into.
- update() - Method in annotation type io.ebean.annotation.DocStore
-
Specify the behavior when bean Update occurs.
- UPDATE - io.ebean.annotation.DocStoreMode
-
Update the document store when transaction succeeds.
- UpdatedTimestamp - Annotation Type in io.ebean.annotation
-
Deprecated.
- updatesThatInclude() - Method in annotation type io.ebean.annotation.ChangeLog
-
When specified only include update requests that have at least one of the given properties as a dirty property.
V
- value() - Method in annotation type io.ebean.annotation.Aggregation
-
Aggregation formula using sum, count, avg, min, max.
- value() - Method in annotation type io.ebean.annotation.DbComment
-
The database table or column comment.
- value() - Method in annotation type io.ebean.annotation.DbDefault
-
The defaultValue for the column.
- value() - Method in annotation type io.ebean.annotation.DbMigration.List
- value() - Method in annotation type io.ebean.annotation.DbName
-
The name of the database.
- value() - Method in annotation type io.ebean.annotation.EnumValue
-
Specify the value to persist for a specific enum value.
- value() - Method in annotation type io.ebean.annotation.FetchPreference
-
The fetch preference used - low value means higher preference.
- value() - Method in annotation type io.ebean.annotation.Formula.List
- value() - Method in annotation type io.ebean.annotation.Indices
-
Array with
Indexdefinitions. - value() - Method in annotation type io.ebean.annotation.Length
- value() - Method in annotation type io.ebean.annotation.StorageEngine
-
The platform specific storage engine clause that would be part of create table statements.
- value() - Method in annotation type io.ebean.annotation.Where.List
- valueOf(String) - Static method in enum io.ebean.annotation.ChangeLogInsertMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.ConstraintMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.DbEnumType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.DbJsonType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.DocProperty.Option
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.DocStoreMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.IdentityGenerated
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.IdentityType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.PartitionMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.PersistBatch
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.Platform
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.TxIsolation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ebean.annotation.TxType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.ebean.annotation.ChangeLogInsertMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.ConstraintMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.DbEnumType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.DbJsonType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.DocProperty.Option
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.DocStoreMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.IdentityGenerated
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.IdentityType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.PartitionMode
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.PersistBatch
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.Platform
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.TxIsolation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.ebean.annotation.TxType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VARCHAR - io.ebean.annotation.DbEnumType
-
Store values as database VARCHAR.
- VARCHAR - io.ebean.annotation.DbJsonType
-
Store as database VARCHAR.
- View - Annotation Type in io.ebean.annotation
-
Annotate an entity bean with @View to indicates the bean is based on a view.
W
- WEEK - io.ebean.annotation.PartitionMode
-
Weekly partitioning.
- WhenCreated - Annotation Type in io.ebean.annotation
-
For a timestamp property that is set to the datetime when the entity is created/inserted.
- WhenModified - Annotation Type in io.ebean.annotation
-
For a timestamp property that is set to the datetime when the entity was last modified.
- Where - Annotation Type in io.ebean.annotation
-
Add an Literal to add to the where clause when a many property (List, Set or Map) is loaded or refreshed.
- Where.List - Annotation Type in io.ebean.annotation
-
Repeatable support for
Where. - WhoCreated - Annotation Type in io.ebean.annotation
-
Mapped onto a entity bean property that represents the user id of who created the entity>
- WhoModified - Annotation Type in io.ebean.annotation
-
Mapped onto a entity bean property that represents the user id of who last modified the entity>
- withConstraint() - Method in annotation type io.ebean.annotation.DbEnumValue
-
When true DDL should generate a database constraint for the enum values.
Y
- YEAR - io.ebean.annotation.PartitionMode
-
Year based partitioning.
All Classes All Packages