A B C D E F G H I J K L M N O P Q R S T U V W Y

A

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.AmountProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.BooleanProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.CompositePropertyFactory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.ElasticRefProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.EnumProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.InstantProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.IntegerProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.LocalDateProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.LocalTimeProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.LongProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.MongoRefProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.NestedListProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.SQLEntityRefProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.StringIntMapProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.StringListMapProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.StringListProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.StringLocalDateTimeMapProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.StringMapProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.StringNestedMapProperty.Factory

accepts(EntityDescriptor, Field) - Method in class sirius.db.mixing.properties.StringProperty.Factory

accepts(EntityDescriptor, Field) - Method in interface sirius.db.mixing.PropertyFactory

Determines if the given field is handled by this property factory.

AccessPath - Class in sirius.db.mixing

Determines how to access the field of a property within the entity.

AccessPath() - Constructor for class sirius.db.mixing.AccessPath

accessPath - Variable in class sirius.db.mixing.Property

Contains the access path used to obtain the target object containing the field

add(E) - Method in class sirius.db.mixing.types.BaseEntityRefList

Adds the given entity to the list.

add(T) - Method in class sirius.db.mixing.types.SafeList

Adds a new item to the list.

add(String, String) - Method in class sirius.db.mixing.types.StringListMap

Adds the given value to the list of the given key.

addAggregation(String, JSONObject) - Method in class sirius.db.es.ElasticQuery

Adds the given aggregation for the given name.

addAll(Collection<T>) - Method in class sirius.db.mixing.types.SafeList

Adds all items to the list.

addBatch() - Method in class sirius.db.jdbc.batch.BatchQuery

Adds the current parameter set as batch.

addBeforeDeleteHandler(Consumer<Object>) - Method in class sirius.db.mixing.EntityDescriptor

Adds a before delete handler for entities managed by this descriptor.

addCascadeDeleteHandler(Consumer<Object>) - Method in class sirius.db.mixing.EntityDescriptor

Adds a cascade handler for entities managed by this descriptor.

addCollapsedInnerHits(String, int) - Method in class sirius.db.es.ElasticQuery

Adds a description to obtain a sublist of collapsed results.

addColumn(int, String) - Method in class sirius.db.jdbc.schema.ForeignKey

Adds a column to the key

addColumn(int, String) - Method in class sirius.db.jdbc.schema.Key

Adds a column to the key

addComposite(Class<? extends Composite>) - Method in class sirius.db.mixing.EntityDescriptor

Used to add a class to the list of contained composites within the described entity.

addDateAggregation(String, Mapping, List<DateRange>) - Method in class sirius.db.es.ElasticQuery

Adds a date (bucket) aggregation.

addFields(EntityDescriptor, AccessPath, Class<?>, Consumer<Property>) - Static method in class sirius.db.mixing.EntityDescriptor

addForeignColumn(int, String) - Method in class sirius.db.jdbc.schema.ForeignKey

Adds a foreign column which has to be matched be the local ones.

addInParam(Object) - Method in class sirius.db.jdbc.SQLCall

Adds an in parameter.

addOutParam(String, int) - Method in class sirius.db.jdbc.SQLCall

Adds an out parameter.

addParameter(Object) - Method in class sirius.db.jdbc.SmartQuery.Compiler

Adds a query parameter.

addTermAggregation(Mapping) - Method in class sirius.db.es.ElasticQuery

Adds a term (bucket) aggregation for the given field.

addTermAggregation(String, Mapping, int) - Method in class sirius.db.es.ElasticQuery

Adds a term (bucket) aggregation for the given field.

addToSet(String, String) - Method in class sirius.db.mixing.types.StringListMap

Adds the given value to the list of the given key.

addToSet(Mapping, Object) - Method in class sirius.db.mongo.Updater

Adds the given value to the given set / list.

addToSet(String, Object) - Method in class sirius.db.mongo.Updater

Adds the given value to the given set / list.

addValidationHandler(BiConsumer<Object, Consumer<String>>) - Method in class sirius.db.mixing.EntityDescriptor

Adds a validation handler

AfterDelete - Annotation Type in sirius.db.mixing.annotations

Used to mark methods in Mixables which will be called once an entity was deleted.

afterDelete(BaseEntity<?>) - Method in class sirius.db.mixing.EntityDescriptor

Invokes all afterDeleteHandlers.

afterDeleteHandlers - Variable in class sirius.db.mixing.EntityDescriptor

A list of all additional handlers to be executed once an entity was successfully deleted

AfterSave - Annotation Type in sirius.db.mixing.annotations

Used to mark methods in Mixables which will be called once an entity was saved.

afterSave(Object) - Method in class sirius.db.mixing.EntityDescriptor

Executes all afterSaveHandlers once an entity was saved to the database.

afterSaveHandlers - Variable in class sirius.db.mixing.EntityDescriptor

A list of all additional handlers to be executed once an entity is was saved

alias - Variable in class sirius.db.jdbc.TransformedQuery

aliasCounter - Variable in class sirius.db.jdbc.SmartQuery.Compiler

allIn(Class<?>, Consumer<Doc>) - Method in class sirius.db.mongo.Finder

Executes the query for the given collection and calls the given processor for each document.

allIn(String, Consumer<Doc>) - Method in class sirius.db.mongo.Finder

Executes the query for the given collection and calls the given processor for each document.

alternativePropertyKey - Variable in class sirius.db.mixing.Property

Contains the alternative i18n key used to determine the label (official name) of the property.

AmountProperty - Class in sirius.db.mixing.properties

Represents an Amount field within a Mixable.

AmountProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

Analyzed - Annotation Type in sirius.db.es.annotations

Only for String fields.

Analyzed.IndexOption - Enum in sirius.db.es.annotations

Spexifies index options passed to elasticsearch.

ANALYZER_TRIGRAM - Static variable in annotation type sirius.db.es.annotations.Analyzed

Sets the Analyzed.analyzer() to "trigram".

ANALYZER_WHITESPACE - Static variable in annotation type sirius.db.es.annotations.Analyzed

Sets the Analyzed.analyzer() to "whitespace".

and(List<C>) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Combines the list of constraints using AND

and(C...) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Combines the list of constraints using AND

append(String, Function<Object, Object>) - Method in class sirius.db.mixing.AccessPath

Creates a new access path which appends the given prefix and accessor to the current access path.

appendSQL(SmartQuery.Compiler) - Method in class sirius.db.jdbc.constraints.Exists

appendSQL(SmartQuery.Compiler) - Method in class sirius.db.jdbc.constraints.SQLConstraint

Generates the appropriate SQL into the given compiler

apply(Object) - Method in class sirius.db.mixing.AccessPath

Applies the access path of the given object.

applyFetchSize(PreparedStatement, Limit) - Method in class sirius.db.jdbc.SQLQuery

applyMaxRows(PreparedStatement, Limit) - Method in class sirius.db.jdbc.SQLQuery

applyTo(String, Query<?, ?, ?>) - Method in class sirius.db.mixing.DateRange

Applies this date range to the given query in the given field.

areColumnsEqual(TableColumn, TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

areColumnsEqual(TableColumn, TableColumn) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Determines if two given column are equal or not.

areDefaultsDifferent(TableColumn, TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

areTypesEqual(int, int) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

areTypesEqual(int, int) - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

assertUnique(Mapping, Object, Mapping...) - Method in class sirius.db.mixing.BaseEntity

Ensures that the given value in the given field is unique within the given side constraints.

asSQLQuery() - Method in class sirius.db.jdbc.SmartQuery

Converts this query into a plain SQLQuery which will return rows instead of entities.

asString(StringBuilder) - Method in class sirius.db.es.constraints.ElasticConstraint

asString(StringBuilder) - Method in class sirius.db.jdbc.constraints.Exists

asString(StringBuilder) - Method in class sirius.db.mixing.query.constraints.Constraint

Creates a string representation of this constraint.

asString(StringBuilder) - Method in class sirius.db.mongo.constraints.MongoConstraint

autoDeleteQuery(String...) - Method in class sirius.db.jdbc.batch.BatchContext

Returns an autoinitializing delete query.

autoFindQuery(String...) - Method in class sirius.db.jdbc.batch.BatchContext

Returns an autoinitializing find query.

autoInsertQuery(boolean, String...) - Method in class sirius.db.jdbc.batch.BatchContext

Returns an autoinitializing insert query.

autoInsertQuery(String...) - Method in class sirius.db.jdbc.batch.BatchContext

Returns an autoinitializing insert query.

autoUpdateByIdQuery(String...) - Method in class sirius.db.jdbc.batch.BatchContext

Returns an autoinitializing update query which uses SQLEntity.ID as mapping to compare.

autoUpdateQuery(String...) - Method in class sirius.db.jdbc.batch.BatchContext

Returns an autoinitializing update query.

avarage - Variable in class sirius.db.jdbc.batch.BatchQuery

B

BaseEntity<I> - Class in sirius.db.mixing

Represents the base class for all entities which can be managed using Mixing.

BaseEntity() - Constructor for class sirius.db.mixing.BaseEntity

BaseEntityRef<I,E extends BaseEntity<I>> - Class in sirius.db.mixing.types

Represents a reference from one entity to another.

BaseEntityRef(Class<E>, BaseEntityRef.OnDelete) - Constructor for class sirius.db.mixing.types.BaseEntityRef

BaseEntityRef.OnDelete - Enum in sirius.db.mixing.types

Declares cascade actions which determine what happens if a referenced entity is deleted.

BaseEntityRefList<E extends BaseEntity<String>,L extends BaseEntityRefList<E,L>> - Class in sirius.db.mixing.types

Represents a list of IDs (strings) which represents subclasses of BaseEntity.

BaseEntityRefList(Class<E>, BaseEntityRef.OnDelete) - Constructor for class sirius.db.mixing.types.BaseEntityRefList

BaseEntityRefListProperty - Class in sirius.db.mixing.properties

Represents an BaseEntityRefList field within a Mixable.

BaseEntityRefListProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

BaseEntityRefProperty<I,E extends BaseEntity<I>,R extends BaseEntityRef<I,E>> - Class in sirius.db.mixing.properties

Base implementation for handling properties of type BaseEntityRef.

BaseEntityRefProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.BaseEntityRefProperty

BaseMapper<B extends BaseEntity<?>,C extends Constraint,Q extends Query<?,? extends B,C>> - Class in sirius.db.mixing

Declares the common functionality of a mapper which is responsible for storing and loading entities to and from a database.

BaseMapper() - Constructor for class sirius.db.mixing.BaseMapper

BaseMapProperty - Class in sirius.db.mixing.properties

Represents a SafeMap field within a Mixable.

BaseMapProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.BaseMapProperty

BaseQuery<Q,E extends BaseEntity<?>> - Class in sirius.db.mixing.query

Base class for queries within mixing.

BaseQuery(EntityDescriptor) - Constructor for class sirius.db.mixing.query.BaseQuery

Creates a new query for entities of the given type.

BaseSQLQuery - Class in sirius.db.jdbc

Abstract class to provide common functionality when executing a query and iterating over its result set.

BaseSQLQuery() - Constructor for class sirius.db.jdbc.BaseSQLQuery

BasicDatabaseDialect - Class in sirius.db.jdbc.schema

Provides a base implementation of DatabaseDialect.

BasicDatabaseDialect() - Constructor for class sirius.db.jdbc.schema.BasicDatabaseDialect

batch() - Method in class sirius.db.es.Elastic

Creates a batch context used for bulk updates.

batchBacklog - Variable in class sirius.db.jdbc.batch.BatchQuery

batchBacklogLimit - Variable in class sirius.db.jdbc.batch.BatchQuery

BatchContext - Class in sirius.db.jdbc.batch

Bundles the preparation and execution of a bunch of batch queries.

BatchContext(Supplier<String>, Duration) - Constructor for class sirius.db.jdbc.batch.BatchContext

Creates a new context with the given debugging description and the expected runtime.

BatchQuery<E extends SQLEntity> - Class in sirius.db.jdbc.batch

Provides an abstract wrapper around a PreparedStatement to be used within a BatchContext.

BatchQuery(BatchContext, Class<E>, String[]) - Constructor for class sirius.db.jdbc.batch.BatchQuery

Creates a new instance for the given context, type and mappings.

BatchSQLQuery - Class in sirius.db.jdbc.batch

Represents an sql query which can be used within a BatchContext by creating a CustomQuery.

BatchSQLQuery(CustomQuery) - Constructor for class sirius.db.jdbc.batch.BatchSQLQuery

BeforeDelete - Annotation Type in sirius.db.mixing.annotations

Used to mark methods in Mixables which will be called before an entity is deleted.

beforeDelete(Object) - Method in class sirius.db.mixing.EntityDescriptor

Invokes all beforeDeleteHandlers and then all cascadeDeleteHandlers for the given entity.

beforeDeleteHandlers - Variable in class sirius.db.mixing.EntityDescriptor

A list of all additional handlers to be executed once an entity is about to be deleted

beforeLastYear() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on everything before the last year.

BeforeSave - Annotation Type in sirius.db.mixing.annotations

Used to mark methods in Mixables which will be called before an entity is saved.

beforeSave(Object) - Method in class sirius.db.mixing.EntityDescriptor

Executes all beforedSaveHandlers known to the descriptor.

beforeSaveHandlerCollector - Variable in class sirius.db.mixing.EntityDescriptor

Collects handlers which are executed before entity is saved, need to be in order (some checks might depend on others), BeforeSave permits to specify a property which is used to here to sort the handlers.

beforeThisYear() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on everything before this year.

BooleanProperty - Class in sirius.db.mixing.properties

Represents a Boolean field within a Mixable.

BooleanProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

BoolQueryBuilder - Class in sirius.db.es.constraints

Represents a boolean query which is the actual work horse of Elasticsearch queries.

BoolQueryBuilder() - Constructor for class sirius.db.es.constraints.BoolQueryBuilder

build() - Method in class sirius.db.es.constraints.BoolQueryBuilder

Compiles the boolen query into a constraint.

build() - Method in class sirius.db.es.constraints.NestedQuery

Compiles the query into a constraint.

build() - Method in class sirius.db.jdbc.constraints.Like

Generates a constraint for the given settings

build() - Method in class sirius.db.mixing.query.constraints.CSVFilter

Generates the effective constraint.

build() - Method in class sirius.db.mixing.query.constraints.OneInField

Generates the effective constraint.

buildSQL() - Method in class sirius.db.jdbc.batch.BatchQuery

Determines the SQL statement to prepare in BatchQuery.prepareStmt().

buildSQL() - Method in class sirius.db.jdbc.batch.CustomQuery

buildSQL() - Method in class sirius.db.jdbc.batch.DeleteQuery

buildSQL() - Method in class sirius.db.jdbc.batch.FindQuery

buildSQL() - Method in class sirius.db.jdbc.batch.InsertQuery

buildSQL() - Method in class sirius.db.jdbc.batch.UpdateQuery

bulk(List<JSONObject>) - Method in class sirius.db.es.LowLevelClient

Executes a list of bulk statements.

BulkContext - Class in sirius.db.es

Simplifies bulk inserts, updates and deletes against Elasticsearch.

BulkContext(LowLevelClient) - Constructor for class sirius.db.es.BulkContext

Creates a new instance using the given client.

C

call() - Method in class sirius.db.jdbc.SQLCall

Invokes the call

callDuration - Variable in class sirius.db.es.Elastic

callDuration - Variable in class sirius.db.mongo.Mongo

callDuration - Variable in class sirius.db.redis.Redis

Capability - Enum in sirius.db.jdbc

Encapsulates functions or features which are not supported by all databases.

captureAndReplaceTranslationState(String, EntityDescriptor) - Method in class sirius.db.jdbc.SmartQuery.Compiler

Returns the currently active translation state and replaces all settings for the new alias and base descriptor.

cascadeDeleteHandlers - Variable in class sirius.db.mixing.EntityDescriptor

A list of all additional handlers to be executed once an entity was deleted

checkColumnSettings(TableColumn, TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

checkForEquality(String, String) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

checkNullability(Object) - Method in class sirius.db.mixing.properties.AmountProperty

checkNullability(Object) - Method in class sirius.db.mixing.Property

Checks if the value is non-null or the property accepts null values.

checkUniqueness(Object, Object) - Method in class sirius.db.mixing.Property

Checks the uniqueness of the given value and entity if an Unique annotation is present

clear() - Method in class sirius.db.mixing.types.SafeList

Clears the list.

clear() - Method in class sirius.db.mixing.types.SafeMap

Clears the entire map.

clear(String) - Method in class sirius.db.mixing.types.StringListMap

Clears the list for the given key.

clearParameters() - Method in class sirius.db.jdbc.batch.CustomQuery

Resets all previously set parameters.

CLICKHOUSE_CAPABILITIES - Static variable in enum sirius.db.jdbc.Capability

Contains the capabilities of a Clickhouse database

ClickhouseDatabaseDialect - Class in sirius.db.jdbc.schema

Defines the dialect used to sync the schema against a MySQL database.

ClickhouseDatabaseDialect() - Constructor for class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

close() - Method in class sirius.db.es.BulkContext

Closes the bulk context and executes all statements which are still queued.

close() - Method in class sirius.db.jdbc.batch.BatchContext

close() - Method in class sirius.db.jdbc.batch.BatchQuery

Closes the query by executing the last batch and releasing all resources.

closeScroll(String) - Method in class sirius.db.es.LowLevelClient

Closes a scroll query.

coerceToId(Object) - Method in class sirius.db.es.types.ElasticRef

coerceToId(Object) - Method in class sirius.db.jdbc.SQLEntityRef

coerceToId(Object) - Method in class sirius.db.mixing.types.BaseEntityRef

Converts the given object into an id.

coerceToId(Object) - Method in class sirius.db.mongo.types.MongoRef

collapse(Mapping) - Method in class sirius.db.es.ElasticQuery

Collapses by the given field.

collapse(String) - Method in class sirius.db.es.ElasticQuery

Collapses by the given field.

collectValues() - Method in class sirius.db.mixing.query.constraints.CSVFilter

columnAliases - Variable in class sirius.db.mixing.EntityDescriptor

commaSeparatedValues - Variable in class sirius.db.mixing.query.constraints.CSVFilter

commit() - Method in class sirius.db.es.BulkContext

Forces the execution of a bulk update (if statements are queued).

commit() - Method in class sirius.db.jdbc.batch.BatchQuery

Forces a batch to be processed (independent of it size, as long as it isn't empty).

compile() - Method in class sirius.db.mixing.query.QueryCompiler

Compiles the query into a constraint.

compileDefaultSearch(List<QueryField>, QueryCompiler.FieldValue) - Method in class sirius.db.mixing.query.QueryCompiler

compileFieldEquals(Mapping, QueryCompiler.FieldValue) - Method in class sirius.db.mixing.query.QueryCompiler

Compiler(EntityDescriptor) - Constructor for class sirius.db.jdbc.SmartQuery.Compiler

Creates a new compiler for the given entity descriptor.

compileSearchToken(Mapping, QueryField.Mode, String) - Method in class sirius.db.es.constraints.ElasticQueryCompiler

compileSearchToken(Mapping, QueryField.Mode, String) - Method in class sirius.db.jdbc.constraints.SQLQueryCompiler

compileSearchToken(Mapping, QueryField.Mode, String) - Method in class sirius.db.mixing.query.QueryCompiler

compileSearchToken(Mapping, QueryField.Mode, String) - Method in class sirius.db.mongo.constraints.MongoQueryCompiler

completeTableInfos(Table) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

completeTableInfos(Table) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Performs DB-specific functions after a Table was read from the DB-metadata.

Composite - Class in sirius.db.mixing

Base class for all composites.

Composite() - Constructor for class sirius.db.mixing.Composite

CompositePropertyFactory - Class in sirius.db.mixing.properties

Compiles a Composite field within a Mixable into respective Property instances.

CompositePropertyFactory() - Constructor for class sirius.db.mixing.properties.CompositePropertyFactory

composites - Variable in class sirius.db.mixing.EntityDescriptor

Contains a set of all composites contained within this entity.

computeAggregations() - Method in class sirius.db.es.ElasticQuery

Executes a request which just contains aggregations and will not fetch any search items in the request body.

computeLockInfo(Jedis, String) - Method in class sirius.db.redis.Redis

computeRequiredSchemaChanges() - Method in class sirius.db.jdbc.schema.Schema

(Re-)Computes the changes required on the database schema to match the expectations of the software.

constaints - Variable in class sirius.db.jdbc.SmartQuery

Constraint - Class in sirius.db.mixing.query.constraints

Represents a constraint which can be applied to a Query.

Constraint() - Constructor for class sirius.db.mixing.query.constraints.Constraint

contains(String) - Method in class sirius.db.jdbc.constraints.Like

Sepcifies a value which needs to occur anywhere in the target field.

contains(Mapping) - Static method in class sirius.db.mixing.query.QueryField

Informs the compiler, that by default a fully expanding search like a contains query may be generated for this field.

contains(E) - Method in class sirius.db.mixing.types.BaseEntityRefList

Determines if the given entity is in the list.

contains(T) - Method in class sirius.db.mixing.types.SafeList

Determines if the list contains the given item.

contains(String, String) - Method in class sirius.db.mixing.types.StringListMap

Determines if the list stored for key contains the given value.

containsAll(Mapping, Value) - Method in class sirius.db.es.constraints.ElasticFilterFactory

containsAll(Mapping, Value) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Creates a new constraint for the given field which asserts that all of the given values in the string is present.

containsAny(Mapping, Value) - Method in class sirius.db.es.constraints.ElasticFilterFactory

containsAny(Mapping, Value) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Creates a new constraint for the given field which asserts that one of the given values in the string is present.

containsKey(K) - Method in class sirius.db.mixing.types.SafeMap

Determines if the map contains the given key.

containsNone(Mapping, Object...) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Creates a constraint which ensures that the given field doesn't contain any of the given values.

containsNonpersistentValue() - Method in class sirius.db.mixing.types.BaseEntityRef

Determines if the given entity value was not yet persisted to the database.

containsOne(Mapping, Object...) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Creates a filter builder which ensures that the given field contains at least on of the given values.

context - Variable in class sirius.db.jdbc.batch.BatchQuery

ContextInfo - Class in sirius.db.mixing

Represents a context info which can be supplied for BaseMapper.find(Class, Object, ContextInfo...).

ContextInfo(String, Value) - Constructor for class sirius.db.mixing.ContextInfo

Creates a new info object for the given key and value.

continueScroll(int, String) - Method in class sirius.db.es.LowLevelClient

Continues a scroll query.

contributeToTable(Table) - Method in interface sirius.db.jdbc.schema.SQLPropertyInfo

Appends columns, keys and foreign keys to the given table to match the settings specified by this property

contributeToTable(Table) - Method in class sirius.db.mixing.properties.AmountProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.BooleanProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.ElasticRefProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.EnumProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.InstantProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.IntegerProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.LocalDateProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.LocalTimeProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.LongProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.MongoRefProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.SQLEntityRefProperty

contributeToTable(Table) - Method in class sirius.db.mixing.properties.StringProperty

convertValue(Object) - Static method in class sirius.db.jdbc.Databases

Transforms the given value into its database representation.

copy() - Method in class sirius.db.jdbc.SmartQuery

Creates a full copy of the query which can be modified without modifying this query.

copy() - Method in class sirius.db.mixing.Nested

Creates a copy of this object.

copyList() - Method in class sirius.db.mixing.types.SafeList

Creates a copy of the underlying list.

copyMap() - Method in class sirius.db.mixing.types.SafeMap

Creates a copy of the underlying map.

copyValue(String) - Method in class sirius.db.mixing.types.BaseEntityRefList

copyValue(N) - Method in class sirius.db.mixing.types.NestedList

copyValue(T) - Method in class sirius.db.mixing.types.SafeList

Creates a copy of the given value.

copyValue(V) - Method in class sirius.db.mixing.types.SafeMap

Creates a copy of the given value.

copyValue(Integer) - Method in class sirius.db.mixing.types.StringIntMap

copyValue(String) - Method in class sirius.db.mixing.types.StringList

copyValue(List<String>) - Method in class sirius.db.mixing.types.StringListMap

copyValue(LocalDateTime) - Method in class sirius.db.mixing.types.StringLocalDateTimeMap

copyValue(String) - Method in class sirius.db.mixing.types.StringMap

copyValue(N) - Method in class sirius.db.mixing.types.StringNestedMap

copyValue(Tuple<Double, Double>) - Method in class sirius.db.mongo.types.MultiPointLocation

count() - Method in class sirius.db.es.ElasticQuery

count(List<String>, String, String, JSONObject) - Method in class sirius.db.es.LowLevelClient

Determines the number of hits for a given query.

count() - Method in class sirius.db.jdbc.SmartQuery

count() - Method in class sirius.db.mixing.query.Query

Executes the query and counts the number of results.

count() - Method in class sirius.db.mongo.MongoQuery

countIn(Class<?>) - Method in class sirius.db.mongo.Finder

Counts the number of documents in the result of the given query.

countIn(String) - Method in class sirius.db.mongo.Finder

Counts the number of documents in the result of the given query.

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.AmountProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.BooleanProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.CompositePropertyFactory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.ElasticRefProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.EnumProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.InstantProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.IntegerProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.LocalDateProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.LocalTimeProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.LongProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.MongoRefProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.NestedListProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.SQLEntityRefProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.StringIntMapProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.StringListMapProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.StringListProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.StringLocalDateTimeMapProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.StringMapProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.StringNestedMapProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in class sirius.db.mixing.properties.StringProperty.Factory

create(EntityDescriptor, AccessPath, Field, Consumer<Property>) - Method in interface sirius.db.mixing.PropertyFactory

Computes a Property for the given field.

createConnection(String) - Method in class sirius.db.jdbc.batch.BatchContext

createEntity(ElasticEntity, EntityDescriptor) - Method in class sirius.db.es.Elastic

createEntity(SQLEntity, EntityDescriptor) - Method in class sirius.db.jdbc.OMA

createEntity(B, EntityDescriptor) - Method in class sirius.db.mixing.BaseMapper

Creates a new entity in the underlying database.

createEntity(MongoEntity, EntityDescriptor) - Method in class sirius.db.mongo.Mango

createFunctionCall(String, Integer) - Method in class sirius.db.jdbc.Database

Creates a new call wrapper which permits safe and convenient function calls.

createIndex(String, int, int) - Method in class sirius.db.es.LowLevelClient

Creates the given index.

createIndices(MongoDatabase) - Method in interface sirius.db.mongo.IndexDescription

Invoked once the Mongo DB is first accessed and permits to create required indices.

createIndices(MongoDatabase) - Method in class sirius.db.mongo.Mango

createPreparedStatement(Connection) - Method in class sirius.db.jdbc.SQLQuery

createProcedureCall(String) - Method in class sirius.db.jdbc.Database

Creates a new call wrapper which permits safe and convenient procedure calls.

createQuery(String) - Method in class sirius.db.jdbc.Database

Creates a new query wrapper which permits safe and convenient queries.

createScroll(List<String>, String, String, int, int, int, JSONObject) - Method in class sirius.db.es.LowLevelClient

Creates a scroll search.

createStmt(String, boolean) - Method in class sirius.db.jdbc.batch.BatchQuery

Prepares a new statement for the given sql and options.

CSVFilter<C extends Constraint> - Class in sirius.db.mixing.query.constraints

Represents a constraint which checks if the given field contains one or all of the values given as a comma separated string.

CSVFilter(FilterFactory<C>, Mapping, String, CSVFilter.Mode) - Constructor for class sirius.db.mixing.query.constraints.CSVFilter

CSVFilter.Mode - Enum in sirius.db.mixing.query.constraints

Specifies the matching mode for a filter.

ctx - Static variable in class sirius.db.mixing.query.QueryCompiler

customQuery(Class<? extends SQLEntity>, boolean, String) - Method in class sirius.db.jdbc.batch.BatchContext

Prepares the given SQL statement as custom query.

CustomQuery - Class in sirius.db.jdbc.batch

Wraps a SQL statement as BatchSQLQuery.

CustomQuery(BatchContext, Class<? extends SQLEntity>, boolean, String) - Constructor for class sirius.db.jdbc.batch.CustomQuery

customSplitter(String) - Method in class sirius.db.mixing.query.constraints.CSVFilter

Signals that this constraint should split the give values String using the given Regular Expression

customTransform(Object) - Method in class sirius.db.es.constraints.ElasticFilterFactory

customTransform(Object) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

customTransform(Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Permits to provive database dependent transformations.

customTransform(Object) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

D

data() - Method in class sirius.db.mixing.types.SafeList

Provides readonly access to the underlying list.

data - Variable in class sirius.db.mixing.types.SafeMap

data() - Method in class sirius.db.mixing.types.SafeMap

Provides readonly access to the underlying map.

Database - Class in sirius.db.jdbc

Represents a database connection obtained via Databases.get(String).

Database(String) - Constructor for class sirius.db.jdbc.Database

DatabaseDialect - Interface in sirius.db.jdbc.schema

Contains methods used by SchemaTool to generate SQL which conforms to the dialect of a special database.

DatabaseMetricProvider() - Constructor for class sirius.db.jdbc.Databases.DatabaseMetricProvider

Databases - Class in sirius.db.jdbc

Provides a DataSource which can be configured via the system configuration.

Databases() - Constructor for class sirius.db.jdbc.Databases

Databases.DatabaseMetricProvider - Class in sirius.db.jdbc

Provides some metrics across all managed data sources.

DateRange - Class in sirius.db.mixing

Represents a date range which will collect and count all matching entities in a query to provide an appropriate facet filter.

DateRange(String, String, LocalDateTime, LocalDateTime) - Constructor for class sirius.db.mixing.DateRange

Creates a new DateRange with the given unique key, translated (shown) name and two dates specifying the range

db - Variable in class sirius.db.jdbc.SmartQuery

db() - Method in class sirius.db.mongo.Mongo

Provides direct access to the Mongo DB for non-trivial operations.

dbs - Static variable in class sirius.db.jdbc.BaseSQLQuery

decodeLocalDateTime(long) - Static method in class sirius.db.jdbc.Databases

Decodes a long back into a LocalDateTime.

DEFAULT_MAX_CONSTRAINT_NAME_LENGTH - Static variable in class sirius.db.jdbc.schema.BasicDatabaseDialect

DEFAULT_REALM - Static variable in class sirius.db.mixing.Mixing

Contains the name of the default realm.

DEFAULT_SPLITTER - Static variable in class sirius.db.mixing.query.constraints.CSVFilter

DEFAULT_TERM_AGGREGATION_BUCKET_COUNT - Static variable in class sirius.db.es.ElasticQuery

Contains the default number of buckets being collected and reported for an aggregation.

defaultAlias - Variable in class sirius.db.jdbc.SmartQuery.Compiler

DefaultValue - Annotation Type in sirius.db.mixing.annotations

Defines a default value which is added to the CREATE TABLE statement when generating the schema.

defaultValue - Variable in class sirius.db.mixing.Property

Contains a string representation of the default value for the column

delete() - Method in class sirius.db.es.ElasticQuery

delete(String, String, String, String, Integer) - Method in class sirius.db.es.LowLevelClient

Deletes the given document.

delete(E, boolean, boolean) - Method in class sirius.db.jdbc.batch.DeleteQuery

Deletes all entities where the compared mappings match the ones given in the example.

delete() - Method in class sirius.db.jdbc.SmartQuery

delete(E) - Method in class sirius.db.mixing.BaseMapper

Deletes the given entity from the database.

delete() - Method in class sirius.db.mixing.query.Query

Deletes all matches using the BaseMapper.delete(BaseEntity) of the appropriate mapper.

delete() - Method in class sirius.db.mongo.Mongo

Returns a fluent query builder to delete one or more documents in the database

delete() - Method in class sirius.db.mongo.MongoQuery

deleteByQuery(List<String>, String, String, JSONObject) - Method in class sirius.db.es.LowLevelClient

Deletes all documents matched by the given query.

deleteEntity(ElasticEntity, boolean, EntityDescriptor) - Method in class sirius.db.es.Elastic

deleteEntity(SQLEntity, boolean, EntityDescriptor) - Method in class sirius.db.jdbc.OMA

deleteEntity(B, boolean, EntityDescriptor) - Method in class sirius.db.mixing.BaseMapper

Deletes the give entity from the database.

deleteEntity(MongoEntity, boolean, EntityDescriptor) - Method in class sirius.db.mongo.Mango

deleteHandler - Variable in class sirius.db.mixing.types.BaseEntityRef

deleteHandler - Variable in class sirius.db.mixing.types.BaseEntityRefList

deleteQuery(Class<E>, Mapping...) - Method in class sirius.db.jdbc.batch.BatchContext

Creates a new delete query.

DeleteQuery<E extends SQLEntity> - Class in sirius.db.jdbc.batch

Represents a batch query which deletes one or more entities from the database.

DeleteQuery(BatchContext, Class<E>, String[]) - Constructor for class sirius.db.jdbc.batch.DeleteQuery

Deleter - Class in sirius.db.mongo

Fluent builder to build a delete statement.

Deleter(Mongo) - Constructor for class sirius.db.mongo.Deleter

deliberatelyUnrouted() - Method in class sirius.db.es.ElasticQuery

Signals the the routing is deliberately skipped as no routing value is available.

describeProperty(JSONObject) - Method in interface sirius.db.es.ESPropertyInfo

Creates the mapping description for this property into the given JSON.

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.BooleanProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.ElasticRefProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.EnumProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.IntegerProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.LocalDateProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.LongProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.MongoRefProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.NestedListProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.SQLEntityRefProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.StringListProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.StringLocalDateTimeMapProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.StringMapProperty

describeProperty(JSONObject) - Method in class sirius.db.mixing.properties.StringProperty

descriptor - Variable in class sirius.db.jdbc.batch.BatchQuery

descriptor - Variable in class sirius.db.mixing.Property

Contains the descriptor to which this property belongs

descriptor - Variable in class sirius.db.mixing.query.BaseQuery

Contains the descriptor of the entities being queried.

descriptor - Variable in class sirius.db.mixing.query.QueryCompiler

determineDefaultValue() - Method in class sirius.db.mixing.properties.BooleanProperty

determineDefaultValue() - Method in class sirius.db.mixing.Property

Determines the default value of the column by checking for a DefaultValue annotation on the field.

determineHighestUtilization() - Method in class sirius.db.jdbc.Databases.DatabaseMetricProvider

determineId(ElasticEntity) - Method in class sirius.db.es.Elastic

Determines the id of the entity.

determineIndex(EntityDescriptor, ElasticEntity) - Method in class sirius.db.es.Elastic

Determines the index to use for the given entity.

determineLengths() - Method in class sirius.db.mixing.properties.EnumProperty

determineLengths() - Method in class sirius.db.mixing.Property

Determines the column length by checking for a Length annotation on the field.

determineNullability() - Method in class sirius.db.mixing.Property

Determines the nullability of the column by checking for a NullAllowed annotation on the field.

determineRouting(EntityDescriptor, ElasticEntity) - Method in class sirius.db.es.Elastic

Determines the routing value to be used for the given entity.

determineTypeName(EntityDescriptor) - Method in class sirius.db.es.Elastic

Determines the type name used for a given entity type.

determineYearIndex(EntityDescriptor, Object) - Method in class sirius.db.es.Elastic

Computes the effective index name for the given descriptor and year.

discriminatorTable - Variable in class sirius.db.es.Elastic

distinct - Variable in class sirius.db.jdbc.SmartQuery

distinctFields(Mapping...) - Method in class sirius.db.jdbc.SmartQuery

Specifies the fields to select, which also have to be DISTINCT.

Doc - Class in sirius.db.mongo

A simple wrapper of a document in Mongo DB.

Doc(Document) - Constructor for class sirius.db.mongo.Doc

Wraps a result from Mongo DB

dockerDetected - Variable in class sirius.db.es.Elastic

dump() - Method in class sirius.db.jdbc.schema.Table

Provides a full report of all elements of this table.

E

eachIn(Class<?>, Function<Doc, Boolean>) - Method in class sirius.db.mongo.Finder

Executes the query for the given collection and calls the given processor for each document as long as it returns true.

eachIn(String, Function<Doc, Boolean>) - Method in class sirius.db.mongo.Finder

Executes the query for the given collection and calls the given processor for each document as long as it returns true.

ed - Variable in class sirius.db.jdbc.SmartQuery.Compiler

effectiveAnd(List<ElasticConstraint>) - Method in class sirius.db.es.constraints.ElasticFilterFactory

effectiveAnd(List<SQLConstraint>) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

effectiveAnd(List<C>) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Combines the list of constraints using AND

effectiveAnd(List<MongoConstraint>) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

effectiveOr(List<ElasticConstraint>) - Method in class sirius.db.es.constraints.ElasticFilterFactory

effectiveOr(List<SQLConstraint>) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

effectiveOr(List<C>) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Combines the list of constraints using OR

effectiveOr(List<MongoConstraint>) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

Elastic - Class in sirius.db.es

Provides the mapper used to communicate with Elasticsearch.

Elastic() - Constructor for class sirius.db.es.Elastic

elastic - Static variable in class sirius.db.es.ElasticEntity

elastic - Static variable in class sirius.db.mixing.Mixable

ElasticConstraint - Class in sirius.db.es.constraints

Defines a constraint which is accepted by ElasticQuery and most probably generated by ElasticFilterFactory.

ElasticConstraint(JSONObject) - Constructor for class sirius.db.es.constraints.ElasticConstraint

Creates a new constraint represented as JSON.

ElasticEntity - Class in sirius.db.es

Represents the base class for all entities which are managed via Elastic and stored in Elasticsearch.

ElasticEntity() - Constructor for class sirius.db.es.ElasticEntity

ElasticFilterFactory - Class in sirius.db.es.constraints

Generates filters and constraints for ElasticQuery.

ElasticFilterFactory() - Constructor for class sirius.db.es.constraints.ElasticFilterFactory

ElasticMetricsProvider - Class in sirius.db.es

Provides metrics for Elasticsearch (if configured).

ElasticMetricsProvider() - Constructor for class sirius.db.es.ElasticMetricsProvider

ElasticQuery<E extends ElasticEntity> - Class in sirius.db.es

Provides a fluent query API for Elasticsearch.

ElasticQuery(EntityDescriptor, LowLevelClient) - Constructor for class sirius.db.es.ElasticQuery

Creates a new query for the given type using the given client.

ElasticQuery.InnerHitsBuilder - Class in sirius.db.es

Used to describe inner hits which are determine for field collapsing.

ElasticQueryCompiler - Class in sirius.db.es.constraints

Provides a query compiler for ElasticQuery and ElasticFilterFactory.

ElasticQueryCompiler(FilterFactory<ElasticConstraint>, EntityDescriptor, String, List<QueryField>) - Constructor for class sirius.db.es.constraints.ElasticQueryCompiler

Creates a new instance for the given factory entity and query.

ElasticRef<E extends ElasticEntity> - Class in sirius.db.es.types

Represents a reference from one entity to another.

ElasticRef(Class<E>, BaseEntityRef.OnDelete) - Constructor for class sirius.db.es.types.ElasticRef

ElasticRefList<E extends ElasticEntity> - Class in sirius.db.es.types

Represents a list of entities being referenced by id.

ElasticRefList(Class<E>, BaseEntityRef.OnDelete) - Constructor for class sirius.db.es.types.ElasticRefList

Creates a new list for the given type and delete handler.

ElasticRefProperty - Class in sirius.db.mixing.properties

Represents a reference to another ElasticEntity field within a Mixable.

ElasticRefProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.ElasticRefProperty

ElasticRefProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

encodeLocalDateTime(LocalDateTime) - Static method in class sirius.db.jdbc.Databases

Encodes a LocalDateTime as a long.

Engine - Annotation Type in sirius.db.mixing.annotations

Can be placed on a SQLEntity to specify the database engine to use.

ensurePositiveLength(TableColumn, int) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

ensureYearlyIndexExists(EntityDescriptor, int) - Method in class sirius.db.es.IndexMappings

Ensures that the index for the given entity type and year exists and contains the appropriate mappings.

EntityDescriptor - Class in sirius.db.mixing

Used by Mixing to describe all properties and consistency checks of a managed entity.

EntityDescriptor(Class<?>) - Constructor for class sirius.db.mixing.EntityDescriptor

Creates a new entity for the given reference instance.

EntityLoadAction - Class in sirius.db.mixing

Loads all entities known by Mixing.

EntityLoadAction() - Constructor for class sirius.db.mixing.EntityLoadAction

Once a new instance is created - which only happens during framework initialization, we reset the list of known entities as a new discrovery run will start.

entityRef - Variable in class sirius.db.mixing.properties.BaseEntityRefProperty

EnumProperty - Class in sirius.db.mixing.properties

Represents an Enum field within a Mixable.

EnumProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

eq(Mapping, Object) - Method in class sirius.db.es.constraints.NestedQuery

Adds a simple FilterFactory.eq(Mapping, Object) filter as inner filter.

eq(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field = value as constraint

eq(Mapping, Object) - Method in class sirius.db.mixing.query.Query

Adds a constraint which ensures that the given field contains the given value.

eq(Mapping) - Static method in class sirius.db.mixing.query.QueryField

Informs the compiler, that only real equality checks are permitted for this field.

eq(Mapping, Object) - Method in class sirius.db.mongo.MongoQuery

eqIgnoreEmpty(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field = value as constraint However, if the value is null, no constraint will be generated.

eqIgnoreNull(Mapping, Object) - Method in class sirius.db.mixing.query.Query

Adds a constraint which ensures that the given field contains the given value.

eqIgnoreNull(Mapping, Object) - Method in class sirius.db.mongo.MongoQuery

eqOrEmpty(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field = value OR empty(field) as constraint

equals(Object) - Method in class sirius.db.jdbc.schema.ForeignKey

equals(Object) - Method in class sirius.db.jdbc.schema.Key

equals(Object) - Method in class sirius.db.jdbc.schema.Table

equals(Object) - Method in class sirius.db.jdbc.schema.TableColumn

equals(Object) - Method in class sirius.db.jdbc.SQLEntity

equals(Object) - Method in class sirius.db.mixing.BaseEntity

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in class sirius.db.mixing.EntityDescriptor

equals(Object) - Method in class sirius.db.mixing.Nested

equals(Object) - Method in class sirius.db.mixing.Property

equals(Object) - Method in class sirius.db.mixing.types.SafeList

equals(Object) - Method in class sirius.db.mixing.types.SafeMap

equalValue(String, String) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

eqValue(Mapping, Object) - Method in class sirius.db.es.constraints.ElasticFilterFactory

eqValue(Mapping, Object) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

eqValue(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field = value as constraint

eqValue(Mapping, Object) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

ESOption - Enum in sirius.db.es.annotations

Used to describe a tri-state property which is either true, false or default, which will use the default value used by Elasticsearch.

ESPropertyInfo - Interface in sirius.db.es

Describes the mapping to use for a Property.

exec(Supplier<String>, Consumer<Jedis>) - Method in class sirius.db.redis.Redis

Executes one or more Redis commands without any return value.

execCount(SmartQuery.Compiler, Connection) - Method in class sirius.db.jdbc.SmartQuery

execFind(Object, EntityDescriptor, Connection) - Method in class sirius.db.jdbc.OMA

execIterate(Function<E, Boolean>, SmartQuery.Compiler, Limit, boolean, ResultSet) - Method in class sirius.db.jdbc.SmartQuery

execute(Database) - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

Executes the change against the given database.

execute(Command.Output, String...) - Method in class sirius.db.mongo.MongoCommand

execute(Command.Output, String...) - Method in class sirius.db.redis.RedisCommand

executeBatchUpdate() - Method in class sirius.db.jdbc.batch.CustomQuery

Executes the statement as batched update.

executeFor(Class<?>) - Method in class sirius.db.mongo.Updater

Executes the update on the given collection.

executeFor(MongoEntity) - Method in class sirius.db.mongo.Updater

Executes the update on the given entity.

executeFor(String) - Method in class sirius.db.mongo.Updater

Executes the update on the given collection.

executeJoinFetches(SQLEntity, Set<String>, ResultSet) - Method in class sirius.db.jdbc.SmartQuery.Compiler

executeSchemaUpdateAction(String) - Method in class sirius.db.jdbc.schema.Schema

Executes the schema change action with the given id.

executeUpdate() - Method in class sirius.db.jdbc.batch.CustomQuery

Executes the prepared statement as update (or delete).

executeUpdate() - Method in class sirius.db.jdbc.SQLQuery

Executes the query as update.

executeUpdateReturnKeys() - Method in class sirius.db.jdbc.SQLQuery

Executes the update and returns the generated keys.

exists() - Method in class sirius.db.es.ElasticQuery

exists(List<String>, String, String, JSONObject) - Method in class sirius.db.es.LowLevelClient

Determines if a given query has at least one result.

Exists - Class in sirius.db.jdbc.constraints

Generates an EXISTS subquery mapping the given field to the field of the queried entity.

Exists(Mapping, Class<? extends SQLEntity>, Mapping) - Constructor for class sirius.db.jdbc.constraints.Exists

exists() - Method in class sirius.db.jdbc.SmartQuery

exists() - Method in class sirius.db.mixing.query.Query

Determines if the query would have at least one matching entity.

exists() - Method in class sirius.db.mongo.MongoQuery

existsIn(Mapping, Class<? extends SQLEntity>, Mapping) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

Generates an EXISTS clause: EXISTS(SELECT * FROM other WHERE e.outerColumn = other.innerColumn.

F

factories - Static variable in class sirius.db.mixing.EntityDescriptor

Contains all known property factories.

Factory() - Constructor for class sirius.db.mixing.properties.AmountProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.BaseEntityRefListProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.BooleanProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.ElasticRefProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.EnumProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.InstantProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.IntegerProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.LocalDateProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.LocalDateTimeProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.LocalTimeProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.LongProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.MongoRefProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.MultiPointLocationProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.NestedListProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.SQLEntityRefProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.StringIntMapProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.StringListMapProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.StringListProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.StringLocalDateTimeMapProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.StringMapProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.StringNestedMapProperty.Factory

Factory() - Constructor for class sirius.db.mixing.properties.StringProperty.Factory

factory - Variable in class sirius.db.mixing.query.constraints.CSVFilter

factory - Variable in class sirius.db.mixing.query.constraints.OneInField

factory - Variable in class sirius.db.mixing.query.QueryCompiler

failOnOverflow(List<E>) - Method in class sirius.db.mixing.query.BaseQuery

fetchAll(ContextInfo...) - Method in class sirius.db.mixing.types.BaseEntityRefList

Retruns all entity in the list by resolving them against the database.

fetchAllAvailable(ContextInfo...) - Method in class sirius.db.mixing.types.BaseEntityRefList

Retruns all entity in the list by resolving them against the database.

fetchGeneratedKeys(PreparedStatement) - Method in class sirius.db.jdbc.Databases

Returns all generated keys wrapped as row

fetchRow - Variable in class sirius.db.jdbc.SQLEntity

field - Variable in class sirius.db.mixing.Property

The field which generated the property (which stores the column value in the Java world)

field - Variable in class sirius.db.mixing.query.constraints.CSVFilter

field - Variable in class sirius.db.mixing.query.constraints.OneInField

fieldNames - Variable in class sirius.db.jdbc.BaseSQLQuery

fields - Variable in class sirius.db.jdbc.Row

fields - Variable in class sirius.db.jdbc.SmartQuery

fields(Mapping...) - Method in class sirius.db.jdbc.SmartQuery

Specifies which fields to select.

fields(Mapping...) - Method in class sirius.db.mongo.MongoQuery

Limits the fields being returned to the given list.

FieldValue(Object, boolean) - Constructor for class sirius.db.mixing.query.QueryCompiler.FieldValue

filled(Mapping) - Method in class sirius.db.es.constraints.ElasticFilterFactory

filled(Mapping) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

filled(Mapping) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Generates a constraint which ensures that the given field is filled (not null)

filled(Mapping) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

fillValues(List<Object>, String, PreparedStatement) - Method in class sirius.db.jdbc.Database

filter(JSONObject) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a FILTER constraint for the given query.

filter(ElasticConstraint) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a FILTER constraint for the given query.

filter(JSONObject) - Method in class sirius.db.es.ElasticQuery

Adds a FILTER constraint to the query.

FilterFactory<C extends Constraint> - Class in sirius.db.mixing.query.constraints

Defines a factory to create common filters or constraints to be used in a Query.

FilterFactory() - Constructor for class sirius.db.mixing.query.constraints.FilterFactory

filterObject - Variable in class sirius.db.mongo.QueryBuilder

FILTERS - Static variable in class sirius.db.es.Elastic

Constains the factory used to generate filters for a ElasticQuery.

filters() - Method in class sirius.db.es.Elastic

filters() - Method in class sirius.db.es.ElasticQuery

FILTERS - Static variable in class sirius.db.jdbc.OMA

Constains the factory used to generate filters for a SmartQuery.

filters() - Method in class sirius.db.jdbc.OMA

filters() - Method in class sirius.db.jdbc.SmartQuery

filters() - Method in class sirius.db.mixing.BaseMapper

Returns the filter factory which is used by this mapper.

filters() - Method in class sirius.db.mixing.query.Query

filters() - Method in class sirius.db.mongo.Mango

filters() - Method in class sirius.db.mongo.MongoQuery

FILTERS - Static variable in class sirius.db.mongo.QueryBuilder

Represents the filter factory used by mong queries.

find(Class<E>, String) - Method in class sirius.db.es.types.ElasticRef

find(E) - Method in class sirius.db.jdbc.batch.FindQuery

Tries to find a real database entity where the mappings to compare match the given example entity.

find(Class<E>, Long) - Method in class sirius.db.jdbc.SQLEntityRef

find(Class<E>, Object, ContextInfo...) - Method in class sirius.db.mixing.BaseMapper

Performs a database lookup to select the entity of the given type with the given id.

find(Class<E>, Value) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

Actually resolves the the type and value into an entity.

find(Class<ElasticEntity>, Value) - Method in class sirius.db.mixing.properties.ElasticRefProperty

find(Class<MongoEntity>, Value) - Method in class sirius.db.mixing.properties.MongoRefProperty

find(Class<SQLEntity>, Value) - Method in class sirius.db.mixing.properties.SQLEntityRefProperty

find(Class<E>, I) - Method in class sirius.db.mixing.types.BaseEntityRef

Performs the lookup of the entity with the given id.

find() - Method in class sirius.db.mongo.Mongo

Returns a fluent query builder to find one or more documents in the database

find(Class<E>, String) - Method in class sirius.db.mongo.types.MongoRef

findDescriptor(String) - Method in class sirius.db.mixing.Mixing

Returns the descriptor for the given entity type.

findEntity(Object, EntityDescriptor, Function<String, Value>) - Method in class sirius.db.es.Elastic

findEntity(E) - Method in class sirius.db.es.Elastic

findEntity(Object, EntityDescriptor, Function<String, Value>) - Method in class sirius.db.jdbc.OMA

Tries to find the entity with the given id

findEntity(E) - Method in class sirius.db.jdbc.OMA

findEntity(Object, EntityDescriptor, Function<String, Value>) - Method in class sirius.db.mixing.BaseMapper

Tries to find the entity with the given id.

findEntity(E) - Method in class sirius.db.mixing.BaseMapper

findEntity(Object, EntityDescriptor, Function<String, Value>) - Method in class sirius.db.mongo.Mango

findEntity(E) - Method in class sirius.db.mongo.Mango

Finder - Class in sirius.db.mongo

Fluent builder to build a find statement.

Finder(Mongo) - Constructor for class sirius.db.mongo.Finder

findOrFail(Class<E>, Object, ContextInfo...) - Method in class sirius.db.mixing.BaseMapper

Tries to BaseMapper.find(Class, Object, ContextInfo...) the entity with the given id.

findProperty(String) - Method in class sirius.db.mixing.EntityDescriptor

Returns the property for the given name.

findQuery(Class<E>, Mapping...) - Method in class sirius.db.jdbc.batch.BatchContext

Creates a find query.

FindQuery<E extends SQLEntity> - Class in sirius.db.jdbc.batch

Represents a batch query which finds and entity in the database.

FindQuery(BatchContext, Class<E>, String[]) - Constructor for class sirius.db.jdbc.batch.FindQuery

first() - Method in class sirius.db.jdbc.BaseSQLQuery

Executes the given query returning the first matching row wrapped as Optional.

first() - Method in class sirius.db.mixing.query.BaseQuery

Returns the first item matched by the query.

forceDelete(ElasticEntity) - Method in class sirius.db.es.BulkContext

Queues an BaseMapper.forceDelete(BaseEntity) in the batch context.

forceDelete(E) - Method in class sirius.db.mixing.BaseMapper

Deletes the given entity from the database even if it is Versioned and was concurrently modified.

forceEmpty - Variable in class sirius.db.mixing.query.constraints.OneInField

forceEmpty() - Method in class sirius.db.mixing.query.constraints.OneInField

Signals that an empty input list is not ignored but enforces the target field to be empty.

forEach(Consumer<? super T>) - Method in class sirius.db.mixing.types.SafeList

forEach(Consumer<? super Map.Entry<K, V>>) - Method in class sirius.db.mixing.types.SafeMap

ForeignKey - Class in sirius.db.jdbc.schema

Represents a foreign key.

ForeignKey() - Constructor for class sirius.db.jdbc.schema.ForeignKey

G

gather(MetricsCollector) - Method in class sirius.db.es.ElasticMetricsProvider

gather(MetricsCollector) - Method in class sirius.db.jdbc.Databases.DatabaseMetricProvider

gather(MetricsCollector) - Method in class sirius.db.mongo.MongoMetricsProvider

gather(MetricsCollector) - Method in class sirius.db.redis.RedisMetricProvider

generateAddColumn(Table, TableColumn) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateAddColumn(Table, TableColumn) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Generates an alter statement to add the given column.

generateAddColumn(Table, TableColumn) - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

generateAddForeignKey(Table, ForeignKey) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateAddForeignKey(Table, ForeignKey) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateAddForeignKey(Table, ForeignKey) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the table so that the given foreign key is added

generateAddKey(Table, Key) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateAddKey(Table, Key) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateAddKey(Table, Key) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the table so that the given key is added

generateAlterColumnTo(Table, String, TableColumn) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateAlterColumnTo(Table, String, TableColumn) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the given column.

generateAlterColumnTo(Table, String, TableColumn) - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

generateAlterForeignKey(Table, ForeignKey, ForeignKey) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateAlterForeignKey(Table, ForeignKey, ForeignKey) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateAlterForeignKey(Table, ForeignKey, ForeignKey) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the table so that the given foreign key is updated * @param table the table to alter

generateAlterKey(Table, Key, Key) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateAlterKey(Table, Key, Key) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateAlterKey(Table, Key, Key) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the table so that the given key is updated

generateAlterPrimaryKey(Table) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateAlterPrimaryKey(Table) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateAlterPrimaryKey(Table) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the table so that the PK is updated.

generateConstraint(FilterFactory<C>, EntityDescriptor, String) - Method in interface sirius.db.mixing.query.QueryTagHandler

Computes the constraint.

generateCreateTable(Table) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateCreateTable(Table) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Builds a CREATE TABLE statement.

generateCreateTable(Table) - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

generateDropColumn(Table, TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateDropColumn(Table, TableColumn) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateDropColumn(Table, TableColumn) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Generates an alter statement to drop the given column.

generateDropForeignKey(Table, ForeignKey) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateDropForeignKey(Table, ForeignKey) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateDropForeignKey(Table, ForeignKey) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the table so that the given foreign key is dropped

generateDropKey(Table, Key) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateDropKey(Table, Key) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

generateDropKey(Table, Key) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Alters the table so that the given key is dropped

generateDropTable(Table) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

generateDropTable(Table) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Builds a DROP TABLE statement.

generateId() - Method in class sirius.db.KeyGenerator

Generates an unique random io.

generateSecureId() - Method in class sirius.db.KeyGenerator

Generates a long unique id.

generateTableAlias() - Method in class sirius.db.jdbc.SmartQuery.Compiler

Generates an unique table alias.

get(String, String, String, String, boolean) - Method in class sirius.db.es.LowLevelClient

Performs a lookup for the given document.

get(String) - Method in class sirius.db.jdbc.Databases

Provides access to the selected database.

get(K) - Method in class sirius.db.mixing.types.SafeMap

Returns the value stored for the given key.

get(String) - Method in class sirius.db.mongo.Doc

Returns the value of the requested field wrapped as Value.

get(Mapping) - Method in class sirius.db.mongo.Doc

Returns the value of the requested field wrapped as Value.

getAggregationBuckets(String) - Method in class sirius.db.es.ElasticQuery

Returns the buckets which were computed as an aggregation while executing the query.

getAnnotation(Class<A>) - Method in class sirius.db.mixing.Property

Returns the anotation of the given type.

getCollection(Class<? extends MongoEntity>) - Method in class sirius.db.mongo.Mango

getColor() - Method in class sirius.db.mixing.query.QueryTag

Returns the color or CSS class used to render this tag.

getColumns() - Method in class sirius.db.jdbc.schema.ForeignKey

Returns the columns that make up the key.

getColumns() - Method in class sirius.db.jdbc.schema.Key

Returns the columns that make up the key.

getColumns() - Method in class sirius.db.jdbc.schema.Table

Returns a mutable list of columns of this table.

getConnection(String) - Method in class sirius.db.jdbc.batch.BatchContext

getConnection() - Method in class sirius.db.jdbc.Database

Creates a new connection to the database.

getConstraintCharacterLimit() - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

Determines the length a constraint should have.

getConstraintCharacterLimit() - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

getDatabase(String) - Method in class sirius.db.jdbc.OMA

Provides the underlying database instance used to perform the actual statements.

getDatabase(String) - Method in class sirius.db.jdbc.schema.Schema

Provides the underlying database instance used to perform the actual statements.

getDatabases() - Method in class sirius.db.jdbc.Databases

Returns a list of all known (configured) databases from the system config.

getDatasource() - Method in class sirius.db.jdbc.Database

Provides access to the underlying DataSource representing the connection pool.

getDefaultAlias() - Method in class sirius.db.jdbc.TranslationState

getDefaultValue() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the default value as string.

getDefaultValue() - Method in class sirius.db.mixing.Property

Returns the default value to use.

getDefaultValueAsString(TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

getDefinition() - Method in class sirius.db.mixing.Property

Returns the class name and field name which "defined" this property.

getDeleteHandler() - Method in class sirius.db.mixing.types.BaseEntityRef

Returns the delete handler.

getDeleteHandler() - Method in class sirius.db.mixing.types.BaseEntityRefList

Returns the delete handler to use.

getDesciptors() - Method in class sirius.db.mixing.Mixing

Returns all known descriptors.

getDescription() - Method in class sirius.db.mongo.MongoCommand

getDescription() - Method in class sirius.db.redis.RedisCommand

getDescriptor() - Method in class sirius.db.jdbc.batch.BatchQuery

Determines the descriptor for the our entity type.

getDescriptor() - Method in class sirius.db.mixing.BaseEntity

Returns the descriptor which maps the entity to the database table.

getDescriptor(Class<?>) - Method in class sirius.db.mixing.Mixing

Returns the descriptor of the given entity class.

getDescriptor(String) - Method in class sirius.db.mixing.Mixing

Returns the descriptor for the given entity type.

getDescriptor() - Method in class sirius.db.mixing.Property

Returns the entity descriptor to which this property belongs

getDescriptor() - Method in class sirius.db.mixing.query.BaseQuery

Returns the underlying descriptor

getEd() - Method in class sirius.db.jdbc.TranslationState

getEffectiveKeyName(Table, Key) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

getEffectiveKeyName(Table, Key) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Computes the effective name used for a key.

getEngine(Table) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

getEntityDescriptor() - Method in class sirius.db.jdbc.SmartQuery

Returns the EntityDescriptor for the type of entities addressed by this query.

getEntityRef(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

getEntityRefList(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

getError() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

Returns the last error reported by the database.

getFailedIds() - Method in class sirius.db.es.BulkContext

Returns all _id-fields of sub-requests which failed within this bulk request.

getFailureMessage() - Method in class sirius.db.es.BulkContext

Returns the failure message for this bulk request.

getFetchRow() - Method in class sirius.db.jdbc.SQLEntity

If the entity was created as the result of a TransformedQuery, the original Row is accessible via this method.

getField() - Method in class sirius.db.mixing.Property

Returns the field which will store the database value

getField() - Method in class sirius.db.mixing.query.QueryField

getFields() - Method in class sirius.db.jdbc.Row

Deprecated.

use Row.getFieldsList() which honors the field names in terms of upper- and lowercase.

getFieldsList() - Method in class sirius.db.jdbc.Row

Returns all stored fields as map.

getForeignColumns() - Method in class sirius.db.jdbc.schema.ForeignKey

Returns the columns matched in the referenced table.

getForeignKey(String) - Method in class sirius.db.jdbc.schema.Table

Returns the foreign key with the given name.

getForeignKeys() - Method in class sirius.db.jdbc.schema.Table

Returns a mutable list of foreign keys of this table.

getForeignTable() - Method in class sirius.db.jdbc.schema.ForeignKey

Returns the name of the referenced table.

getFrom() - Method in class sirius.db.mixing.DateRange

getHostConnection() - Method in class sirius.db.jdbc.Database

Tries to obtain a host connection which is not bound to a specific database or schema.

getId() - Method in class sirius.db.es.ElasticEntity

getId() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

Returns an unique ID which identifies this change

getId() - Method in class sirius.db.jdbc.SQLEntity

Returns the ID of the entity.

getId() - Method in class sirius.db.mixing.BaseEntity

Returns the id of the entity.

getId() - Method in class sirius.db.mixing.types.BaseEntityRef

Returns the id of the referenced entity.

getId() - Method in class sirius.db.mongo.MongoEntity

getIdAsString() - Method in class sirius.db.mixing.BaseEntity

Returns a string representation of the entity ID.

getInfo() - Method in class sirius.db.redis.Redis

Returns a map of monitoring info about the redis server.

getJDBCType(Class<?>) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

getJDBCType(Class<?>) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Converts the given class into the JDBC-Value (@see Types).

getJdbcTypeName(int) - Static method in class sirius.db.jdbc.schema.SchemaTool

Generates a type name for the given int constant for a JDBC type defined in Types.

getJoins() - Method in class sirius.db.jdbc.SmartQuery.Compiler

Provides access to the currently generated JOINs.

getJoins() - Method in class sirius.db.jdbc.TranslationState

getJoinTable() - Method in class sirius.db.jdbc.TranslationState

getKey(String) - Method in class sirius.db.jdbc.schema.Table

Returns the key with the given name.

getKey() - Method in class sirius.db.mixing.ContextInfo

Returns the key of this info.

getKey() - Method in class sirius.db.mixing.DateRange

getKey() - Method in class sirius.db.mongo.constraints.MongoConstraint

getKeys() - Method in class sirius.db.jdbc.schema.Table

Returns a mutable list of keys of this table.

getLabel() - Method in class sirius.db.mixing.EntityDescriptor

Returns the "end user friendly" name of the entity.

getLabel() - Method in class sirius.db.mixing.Property

Returns the name of the property which is shown to the user.

getLabel() - Method in class sirius.db.mixing.query.QueryTag

Returns the label shown to the user.

getLegacyInfo() - Method in class sirius.db.mixing.EntityDescriptor

Provides access to the "legacy" block in the system config which is stored for this entity type.

getLength() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the overall max. length of the column.

getLength() - Method in class sirius.db.mixing.Property

Returns the length of the generated column.

getLimit() - Method in class sirius.db.mixing.query.BaseQuery

getList(String) - Method in class sirius.db.mixing.types.StringListMap

Returns the list associated with the given key.

getList(String) - Method in class sirius.db.mongo.Doc

Returns the list contained in the given field

getList(Mapping) - Method in class sirius.db.mongo.Doc

Returns the list contained in the given field

getLockList() - Method in class sirius.db.redis.Redis

Returns a list of all currently held locks.

getLongConnectionThresholdMillis() - Static method in class sirius.db.jdbc.Databases

Converts the threshold for "long connections" into a long containing milliseconds for performance reasons.

getLongQueryThresholdMillis() - Static method in class sirius.db.jdbc.Databases

Converts the threshold for "slow queries" into a long containing milliseconds for performance reasons.

getLowLevelClient() - Method in class sirius.db.es.Elastic

Provides access to the underlying low level client.

getMap(Object) - Method in class sirius.db.mixing.properties.BaseMapProperty

getMappableClasses() - Static method in class sirius.db.mixing.EntityLoadAction

Contains a list of all known entity types.

getMappableClasses() - Static method in class sirius.db.mixing.NestedLoadAction

Contains a list of all known entity types.

getMapper() - Method in class sirius.db.es.ElasticEntity

getMapper() - Method in class sirius.db.jdbc.SQLEntity

getMapper() - Method in class sirius.db.mixing.BaseEntity

Provides the mapper which is used to actually manage the entity.

getMapper() - Method in class sirius.db.mixing.EntityDescriptor

Returns the mapper in charge of managing entities of this type.

getMapper() - Method in class sirius.db.mongo.MongoEntity

getMixins() - Method in class sirius.db.mixing.EntityDescriptor

Returns all mixins known for the describes entity.

getMode() - Method in class sirius.db.mixing.query.QueryField

getName() - Method in class sirius.db.jdbc.schema.ForeignKey

Returns the name of the foreign key.

getName() - Method in class sirius.db.jdbc.schema.Key

Returns the name of the key.

getName() - Method in class sirius.db.jdbc.schema.Table

Returns the name of the table.

getName() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the name of the column.

getName() - Method in class sirius.db.mixing.Mapping

Returns the field name for which this mapping was created.

getName() - Method in class sirius.db.mixing.Property

Returns the name of the property.

getName() - Method in class sirius.db.mongo.MongoCommand

getName() - Method in class sirius.db.redis.RedisCommand

getNameForType(Class<?>) - Method in class sirius.db.mixing.Mixing

Each entity type can be addressed by its class or by a unique name, which is its simple class name in upper case.

getNestedDescriptor() - Method in class sirius.db.mixing.properties.NestedListProperty

getNestedDescriptor() - Method in class sirius.db.mixing.properties.StringNestedMapProperty

getNestedList(Object) - Method in class sirius.db.mixing.properties.NestedListProperty

getNestedType() - Method in class sirius.db.mixing.types.NestedList

Returns the type of objects stored in this list.

getNestedType() - Method in class sirius.db.mixing.types.StringNestedMap

Returns the type of items stored as values in this map.

getNumActive() - Method in class sirius.db.jdbc.Database

Return the number of active connections

getNumIdle() - Method in class sirius.db.jdbc.Database

Return the number of idle connections

getObject() - Method in class sirius.db.mongo.constraints.MongoConstraint

getObject(String) - Method in class sirius.db.mongo.Doc

Returns the object stored for the given field.

getObject(Mapping) - Method in class sirius.db.mongo.Doc

Returns the object stored for the given field.

getOldName() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the old name of the column.

getParent() - Method in class sirius.db.mixing.Mapping

Returns the parent field.

getPassword() - Method in class sirius.db.jdbc.Database

Returns the JDBC password supplied to the database.

getPluralLabel() - Method in class sirius.db.mixing.EntityDescriptor

Returns the "end user friendly" plural of the entity.

getPrecision() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the precision of the column.

getPrimaryKey() - Method in class sirius.db.jdbc.schema.Table

Returns the columns which make up the primary key

getPriority() - Method in class sirius.db.jdbc.schema.Schema

getPriority() - Method in interface sirius.db.mixing.PropertyFactory

getPriority() - Method in class sirius.db.mongo.Mongo

getPriority() - Method in class sirius.db.redis.Redis

getProperties() - Method in class sirius.db.jdbc.batch.BatchQuery

Transforms the mappings into a list of properties.

getProperties() - Method in class sirius.db.jdbc.batch.InsertQuery

getProperties() - Method in class sirius.db.mixing.EntityDescriptor

Returns all properties known by this descriptor.

getPropertiesToUpdate() - Method in class sirius.db.jdbc.batch.UpdateQuery

getProperty(Mapping) - Method in class sirius.db.mixing.EntityDescriptor

Returns the property for the given column.

getProperty(String) - Method in class sirius.db.mixing.EntityDescriptor

Returns the property for the given name.

getPropertyName() - Method in class sirius.db.mixing.Property

Returns the effective property name.

getQuery() - Method in class sirius.db.jdbc.SmartQuery.Compiler

getReadyFuture() - Method in class sirius.db.es.Elastic

Provides a future which is fulfilled once the Elasticsearch client is fully initialized.

getReadyFuture() - Method in class sirius.db.jdbc.OMA

Provides a Future which is fullfilled once the framework is ready.

getReadyFuture() - Method in class sirius.db.jdbc.schema.Schema

Provides a Future which is fullfilled when then schema is fully initialized

getRealm() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

getRealm() - Method in class sirius.db.mixing.EntityDescriptor

Returns the realm of entities of this type.

getReason() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

Contains a short description of what the change will cause.

getReferencedDescriptor() - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

Returns the EntityDescriptor of the referenced entity.

getReferencedDescriptor() - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

Returns the EntityDescriptor of the referenced entity.

getReferencedType() - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

Returns the entity class of the referenced type.

getReferenceEntityRefList() - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

getReferenceInstance() - Method in class sirius.db.mixing.EntityDescriptor

Each descriptor keeps a single instance of the entity as reference to determine default values etc.

getRelationName() - Method in class sirius.db.mixing.EntityDescriptor

Returns the technical simple name to use.

getRelationName(Class<?>) - Static method in class sirius.db.mongo.QueryBuilder

getRestClient() - Method in class sirius.db.es.LowLevelClient

Returns the underlying REST client.

getReturnValue() - Method in class sirius.db.jdbc.SQLCall

Returns the return value of the function call

getScale() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the number decimal places after the comma.

getSchema(Database) - Method in class sirius.db.jdbc.schema.SchemaTool

Reads the DB-schema for the given connection.

getSchemaUpdateActions() - Method in class sirius.db.jdbc.schema.Schema

Lists the update actions which need to be performed on the current database to match the expectation of the software.

getSELECTBuilder() - Method in class sirius.db.jdbc.SmartQuery.Compiler

Provides access to the string builder which generates the SELECT part of the query.

getSize() - Method in class sirius.db.jdbc.Database

Returns the maximal number of concurrent connections

getSource() - Method in class sirius.db.jdbc.schema.Table

getSource() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the underlying property if available

getSql() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

A list of SQL statements which have to be executed to perform the required change.

getString(String) - Method in class sirius.db.mongo.Doc

Returns the string contents of the given field

getString(Mapping) - Method in class sirius.db.mongo.Doc

Returns the string contents of the given field

getStringList(String) - Method in class sirius.db.mongo.Doc

Returns the list of strings contained in the given field

getStringList(Mapping) - Method in class sirius.db.mongo.Doc

Returns the list of strings contained in the given field

getSublist(Object) - Method in class sirius.db.jdbc.Row

Returns a sub list which was stored for a given key.

getTopic() - Method in interface sirius.db.redis.Subscriber

Returns the name of the topic to subscribe to.

getTrigger() - Method in class sirius.db.mixing.EntityLoadAction

getTrigger() - Method in class sirius.db.mixing.MixinLoadAction

getTrigger() - Method in class sirius.db.mixing.NestedLoadAction

getType() - Method in class sirius.db.jdbc.schema.TableColumn

Returns the JDBC type of the column.

getType() - Method in class sirius.db.mixing.EntityDescriptor

Returns the entity class managed by this descriptor.

getType() - Method in class sirius.db.mixing.query.QueryTag

The type of the tag, used to identify the QueryTagHandler to use.

getType() - Method in class sirius.db.mixing.types.BaseEntityRef

Returns the entity type being referenced.

getType() - Method in class sirius.db.mixing.types.BaseEntityRefList

Returns the underlying entity type.

getTypeName(TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

getTypeName(TableColumn) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

getTypeName(TableColumn) - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

getTypeName() - Method in class sirius.db.mixing.BaseEntity

Each entity type can be addressed by its class or by a unique name, which is its simple class name in upper case.

getUnderlyingObject() - Method in class sirius.db.mongo.Doc

Retruns the underlying Mongo DB Obect.

getUniqueName() - Method in class sirius.db.mixing.BaseEntity

Returns an unique name of this entity.

getUniqueName(String, Object) - Method in class sirius.db.mixing.Mixing

Computes the unique name of an entity based on its descriptor type and id.

getUniqueName(Class<?>, Object) - Method in class sirius.db.mixing.Mixing

Computes the unique name of an entity based on its type and id.

getUniqueObjectName() - Method in class sirius.db.mixing.types.BaseEntityRef

Returns the Unique Object Name for the referenced entity.

getUntil() - Method in class sirius.db.mixing.DateRange

getUrl() - Method in class sirius.db.jdbc.Database

Returns the JDBC connection URL

getUsername() - Method in class sirius.db.jdbc.Database

Returns the JDBC username supplied to the database.

getValue(Object) - Method in class sirius.db.jdbc.Row

Returns the value associated with the given key.

getValue(String) - Method in class sirius.db.jdbc.SQLCall

Returns the named out parameter

getValue() - Method in class sirius.db.mixing.ContextInfo

Returns the value of this info.

getValue(Object) - Method in class sirius.db.mixing.Property

Obtains the field value from the given entity.

getValue() - Method in class sirius.db.mixing.query.QueryCompiler.FieldValue

Returns the value itself

getValue() - Method in class sirius.db.mixing.query.QueryTag

Returns the filter value passed to the QueryTagHandler.

getValue() - Method in class sirius.db.mixing.types.BaseEntityRef

Returns the effective entity object which is referenced.

getValueAsCopy(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

getValueAsCopy(Object) - Method in class sirius.db.mixing.properties.BaseMapProperty

getValueAsCopy(Object) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty

getValueAsCopy(Object) - Method in class sirius.db.mixing.properties.NestedListProperty

getValueAsCopy(Object) - Method in class sirius.db.mixing.properties.StringListProperty

getValueAsCopy(Object) - Method in class sirius.db.mixing.Property

For modifyable datatypes like collections, this returns the value as copy so that further modifications will not change the returned value.

getValueForDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.Property

Obtains the database value from the given entity.

getValueFromField(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

getValueFromField(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

getValueFromField(Object) - Method in class sirius.db.mixing.properties.BaseMapProperty

getValueFromField(Object) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty

getValueFromField(Object) - Method in class sirius.db.mixing.properties.NestedListProperty

getValueFromField(Object) - Method in class sirius.db.mixing.properties.StringListProperty

getValueFromField(Object) - Method in class sirius.db.mixing.Property

Obtains the value from the field in the given target object

getValueInObject(String, String) - Method in class sirius.db.mongo.Doc

Returns the inner value stored in the object in the given field.

getValueInObject(Mapping, String) - Method in class sirius.db.mongo.Doc

Returns the inner value stored in the object in the given field.

getVersion() - Method in class sirius.db.mixing.BaseEntity

Returns the version of the entity.

getWHEREBuilder() - Method in class sirius.db.jdbc.SmartQuery.Compiler

Provides access to the string builder which generates the WHERE part of the query.

gt(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field > value as constraint

gte(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field >= value as constraint

gteOrEmpty(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field >= value OR empty(field) as constraint

gtOrEmpty(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field > value OR empty(field) as constraint

gtValue(Mapping, Object, boolean) - Method in class sirius.db.es.constraints.ElasticFilterFactory

gtValue(Mapping, Object, boolean) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

gtValue(Mapping, Object, boolean) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field > value as constraint

gtValue(Mapping, Object, boolean) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

H

handle(MutableGlobalContext, Class<?>) - Method in class sirius.db.mixing.EntityLoadAction

handle(MutableGlobalContext, Class<?>) - Method in class sirius.db.mixing.MixinLoadAction

handle(MutableGlobalContext, Class<?>) - Method in class sirius.db.mixing.NestedLoadAction

handleNotFoundAsResponse(ResponseException) - Method in class sirius.db.es.LowLevelClient

handlePubSubMessage(String, String, Subscriber) - Method in class sirius.db.redis.Redis

hasCapability(Capability) - Method in class sirius.db.jdbc.Database

Determines if the current driver has the requested capability.

hasComposite(Class<? extends Composite>) - Method in class sirius.db.mixing.EntityDescriptor

Determines if a composite of the given type is present within this entity.

hasDatabase(String) - Method in class sirius.db.jdbc.Databases

Determines if a databse with the given name is present in the configuration.

hasEscapedDefaultValue(TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

hashCode() - Method in class sirius.db.jdbc.schema.ForeignKey

hashCode() - Method in class sirius.db.jdbc.schema.Key

hashCode() - Method in class sirius.db.jdbc.schema.Table

hashCode() - Method in class sirius.db.jdbc.schema.TableColumn

hashCode() - Method in class sirius.db.jdbc.SQLEntity

Returns a hash code value for the object.

hashCode() - Method in class sirius.db.mixing.BaseEntity

Returns a hash code value for the object.

hashCode() - Method in class sirius.db.mixing.EntityDescriptor

hashCode() - Method in class sirius.db.mixing.Nested

hashCode() - Method in class sirius.db.mixing.Property

hashCode() - Method in class sirius.db.mixing.types.SafeList

hashCode() - Method in class sirius.db.mixing.types.SafeMap

hasValidationWarnings(B) - Method in class sirius.db.mixing.BaseMapper

Determines if the given entity has validation warnings.

hasValidationWarnings(Object) - Method in class sirius.db.mixing.EntityDescriptor

Determines if the given entity has validation warnings.

hasValue(String) - Method in class sirius.db.jdbc.Row

Determines if a value for a given key is present.

I

ID - Static variable in class sirius.db.es.ElasticEntity

Contains the ID which is auto-generated when inserting a new entity into Elasticsearch.

ID - Static variable in class sirius.db.jdbc.SQLEntity

Contains the unique ID of the entity.

id - Variable in class sirius.db.jdbc.SQLEntity

id - Variable in class sirius.db.mixing.types.BaseEntityRef

id() - Method in class sirius.db.mongo.Doc

Returns the ID of the document

ID - Static variable in class sirius.db.mongo.MongoEntity

Contains the id of the entity.

id - Variable in class sirius.db.mongo.MongoEntity

ID_FIELD - Static variable in class sirius.db.es.Elastic

Contains the name of the ID field used by Elasticsearch

IDENTITY - Static variable in class sirius.db.mixing.AccessPath

Represents a NO-OP access path which is used for all fields which are directly contained in the entity.

ignoreCase() - Method in class sirius.db.jdbc.constraints.Like

Specifies that upper- and lowercase should not be distinguished.

ignoreEmpty() - Method in class sirius.db.jdbc.constraints.Like

Permits to skip this constraint if the given filter value is empty.

illegalFieldValue(Value) - Method in class sirius.db.mixing.Property

Creates an exception which represents an illegal value for this property

in(int, int, int...) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

inc(Mapping, int) - Method in class sirius.db.mongo.Updater

Increments the given field by the given value.

inc(String, int) - Method in class sirius.db.mongo.Updater

Increments the given field by the given value.

index(String, String, String, String, Integer, JSONObject) - Method in class sirius.db.es.LowLevelClient

Tells Elasticsearch to create or update the given document with the given data.

Index - Annotation Type in sirius.db.mixing.annotations

Defines an additional index on an SQLEntity.

INDEX_ASCENDING - Static variable in class sirius.db.mongo.Mango

Defines the value used to desclare an index as sorted in ascending order.

INDEX_DESCENDING - Static variable in class sirius.db.mongo.Mango

Defines the value used to desclare an index as sorted in descending order.

IndexDescription - Interface in sirius.db.mongo

Used to setup indices in Mongo DB on system startup.

indexExists(String) - Method in class sirius.db.es.LowLevelClient

Determines if the given index exists.

IndexMappings - Class in sirius.db.es

Creates the mappings for all available Elasticsearch entities.

IndexMappings() - Constructor for class sirius.db.es.IndexMappings

IndexMode - Annotation Type in sirius.db.es.annotations

Changes the index mode of the annotated field.

Indices - Annotation Type in sirius.db.mixing.annotations

Provides a container to make Index repeatable.

INFO_USED_MEMORY - Static variable in class sirius.db.redis.Redis

Contains the entry name of the info section under which redis reports the amount of consumed ram

initialize() - Method in class sirius.db.jdbc.Databases

initialize() - Method in class sirius.db.jdbc.schema.Schema

initialize() - Method in class sirius.db.mixing.EntityDescriptor

Loads all properties from the fields being present in the target type.

initialize() - Method in class sirius.db.mixing.Mixing

initializeClient() - Method in class sirius.db.mongo.Mongo

inMixin(Class<?>) - Method in class sirius.db.mixing.Mapping

References a mixin for an inner composite or referenced type.

inner(Mapping) - Method in class sirius.db.mixing.Mapping

References an inner field of a composite represented by this mapping.

InnerHitsBuilder(String, int) - Constructor for class sirius.db.es.ElasticQuery.InnerHitsBuilder

insert(E, boolean, boolean) - Method in class sirius.db.jdbc.batch.InsertQuery

Inserts an entity into the database.

insert() - Method in class sirius.db.mongo.Mongo

Returns a fluent query builder to insert a document into the database

Inserter - Class in sirius.db.mongo

Fluent builder to build an insert statement.

Inserter(Mongo) - Constructor for class sirius.db.mongo.Inserter

insertQuery(Class<E>, boolean, Mapping...) - Method in class sirius.db.jdbc.batch.BatchContext

Creates a new insert query.

insertQuery(Class<E>, Mapping...) - Method in class sirius.db.jdbc.batch.BatchContext

Creates a new insert query.

InsertQuery<E extends SQLEntity> - Class in sirius.db.jdbc.batch

Represents a batch query which inserts an entity into the database.

InsertQuery(BatchContext, Class<E>, boolean, String[]) - Constructor for class sirius.db.jdbc.batch.InsertQuery

insertRow(String, Context) - Method in class sirius.db.jdbc.Database

Generates an INSERT statement for the given table inserting all supplied parameters in ctx.

insertRow(String, Map<String, Object>) - Method in class sirius.db.jdbc.Database

Boilerplate method to use Database.insertRow(String, sirius.kernel.commons.Context) with plan maps.

InstantProperty - Class in sirius.db.mixing.properties

Represents an Instant field within a Mixable.

InstantProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

IntegerProperty - Class in sirius.db.mixing.properties

Represents an Integer field within a Mixable.

IntegerProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

into(Class<?>) - Method in class sirius.db.mongo.Inserter

Executes the insert statement into the given collection.

into(String) - Method in class sirius.db.mongo.Inserter

Executes the insert statement into the given collection.

invert(ElasticConstraint) - Method in class sirius.db.es.constraints.ElasticFilterFactory

invert(SQLConstraint) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

invert(C) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Effectively inverts the given constraint

invert(MongoConstraint) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

invokeHandlerForRow(Function<E, Boolean>, Row) - Method in class sirius.db.jdbc.TransformedQuery

is(Class<?>) - Method in class sirius.db.mixing.Mixable

is(Object) - Method in class sirius.db.mixing.types.BaseEntityRef

Determines if the referenced entity is equal to the given entity or id.

isAnyMappingChanged() - Method in class sirius.db.mixing.BaseEntity

Checks whether any Mapping of the current SQLEntity changed.

isAutoIncrement() - Method in class sirius.db.jdbc.schema.TableColumn

Determines whether auto inctement is enabled for this column.

isChanged(Mapping...) - Method in class sirius.db.mixing.BaseEntity

Determines if at least one of the given Mappings were changed in this SQLEntity since it was last fetched from the database.

isChanged(BaseEntity<?>, Property) - Method in class sirius.db.mixing.EntityDescriptor

Determines if the value for the property was changed since it was last fetched from the database.

isColumnCaseSensitive() - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

isColumnCaseSensitive() - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Determines whether casing of columns should be fixed.

isColumnCaseSensitive() - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

isConfigured() - Method in class sirius.db.es.Elastic

Determines if an appropriate configuration is available (e.g. a host to connect to).

isConfigured(String) - Method in class sirius.db.jdbc.schema.Schema

Determines if a JDBC database is configured for the given realm

isConfigured() - Method in class sirius.db.mongo.Mongo

Determines if access to Mongo DB is configured by checking if a host is given.

isConfigured() - Method in class sirius.db.redis.Redis

Determines if access to Redis is configured.

isDataLossPossible() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

Determines if dataloss is possible when executing this change.

isEmpty() - Method in class sirius.db.es.BulkContext

Returns whether any executable commands are queued.

isEmpty() - Method in class sirius.db.mixing.types.BaseEntityRef

Opposite of BaseEntityRef.isFilled().

isEmpty() - Method in class sirius.db.mixing.types.SafeList

Determines if the list is empty.

isEmpty() - Method in class sirius.db.mixing.types.SafeMap

Determines if the map is empty.

isExact() - Method in class sirius.db.mixing.query.QueryCompiler.FieldValue

Determins if the value must not be processed any further.

isExecuted() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

Determines if the change was already executed.

isFailed() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

Determines if the change was successfully executed.

isFetched(BaseEntity<?>, Property) - Method in class sirius.db.mixing.EntityDescriptor

Determines if a value was fetched in the given entity for the given property.

isFilled() - Method in class sirius.db.mixing.types.BaseEntityRef

Determines if an entity is referenced.

isFilled() - Method in class sirius.db.mixing.types.SafeList

Determines if the list is not empty.

isFilled() - Method in class sirius.db.mixing.types.SafeMap

Determines if the map is not empty.

isLocked(String) - Method in class sirius.db.redis.Redis

Determines if the given lock is currently locked by this or another node.

isNeedsQuotation(TableColumn) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

isNew() - Method in class sirius.db.jdbc.SQLEntity

isNew() - Method in class sirius.db.mixing.BaseEntity

Determines if the entity is new (not yet written to the database).

isNullable() - Method in class sirius.db.jdbc.schema.TableColumn

Determines the nullability of the column.

isNullable() - Method in class sirius.db.mixing.Property

Determines if this property accepts null values

isReady() - Method in class sirius.db.jdbc.OMA

Determines if the framework is ready yet.

isRouted(EntityDescriptor) - Method in class sirius.db.es.Elastic

Determines if the entity of the given descriptor requires a routing value.

isStoredPerYear(EntityDescriptor) - Method in class sirius.db.es.Elastic

Determines if the given entity type is stored per year.

isUnique(Mapping, Object, Mapping...) - Method in class sirius.db.es.ElasticEntity

isUnique() - Method in class sirius.db.jdbc.schema.Key

Determines if this key also enforces an unique constraint

isUnique(Mapping, Object, Mapping...) - Method in class sirius.db.jdbc.SQLEntity

isUnique(Mapping, Object, Mapping...) - Method in class sirius.db.mixing.BaseEntity

Determines if the given value in the given field is unique within the given side constraints.

isUnique(Mapping, Object, Mapping...) - Method in class sirius.db.mongo.MongoEntity

isValueLoaded() - Method in class sirius.db.mixing.types.BaseEntityRef

Determines if the entity object for the referenced id is loaded.

isVersioned() - Method in class sirius.db.mixing.EntityDescriptor

Determines if the underlying entity uses optimistic locking.

iterate(Function<E, Boolean>) - Method in class sirius.db.es.ElasticQuery

iterate(Function<Row, Boolean>, Limit) - Method in class sirius.db.jdbc.BaseSQLQuery

Executes the given query by invoking the given handler for each result row.

iterate(Function<Row, Boolean>, Limit) - Method in class sirius.db.jdbc.batch.BatchSQLQuery

iterate(Function<E, Boolean>) - Method in class sirius.db.jdbc.SmartQuery

iterate(Function<Row, Boolean>, Limit) - Method in class sirius.db.jdbc.SQLQuery

iterate(Function<E, Boolean>) - Method in class sirius.db.jdbc.TransformedQuery

iterate(Function<E, Boolean>) - Method in class sirius.db.mixing.query.BaseQuery

Calls the given function on all items in the result, as long as it returns true.

iterate(Function<E, Boolean>) - Method in class sirius.db.mongo.MongoQuery

iterateAll(Consumer<Row>, Limit) - Method in class sirius.db.jdbc.BaseSQLQuery

Executes the given query by invoking the Consumer for each result row.

iterateAll(Consumer<E>) - Method in class sirius.db.mixing.query.BaseQuery

Calls the given consumer on all items in the result.

iterator() - Method in class sirius.db.mixing.types.SafeList

iterator() - Method in class sirius.db.mixing.types.SafeMap

J

jedis - Variable in class sirius.db.redis.Redis

join(Mapping) - Method in class sirius.db.mixing.Mapping

Joins the referenced field described by joinMapping.

joins - Variable in class sirius.db.jdbc.SmartQuery.Compiler

joinTable - Variable in class sirius.db.jdbc.SmartQuery.Compiler

K

Key - Class in sirius.db.jdbc.schema

Represents a database key or index.

Key() - Constructor for class sirius.db.jdbc.schema.Key

KEY - Static variable in class sirius.db.mixing.properties.StringMapProperty

Contains the name of the field used to store the map key

key - Variable in class sirius.db.mongo.constraints.MongoConstraint

key - Variable in class sirius.db.redis.Redis.LockInfo

The full name of the lock, as found in redis

KEY_CURRENT - Static variable in class sirius.db.jdbc.schema.BasicDatabaseDialect

KEY_TARGET - Static variable in class sirius.db.jdbc.schema.BasicDatabaseDialect

KeyGenerator - Class in sirius.db

Used generate IDs or keys in distributed environments where numeric sequences aren't suitable.

KeyGenerator() - Constructor for class sirius.db.KeyGenerator

L

label - Variable in class sirius.db.mixing.Property

Contains a used defined name.

lastFiveMinutes() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the last five minutes.

lastFiveteenMinutes() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the last 15 minutes.

lastHour() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the last hour.

lastMonth() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the last month.

lastTwoHours() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the last two hours.

lastWeek() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the last week.

lastYear() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the last year.

legacyInfo - Variable in class sirius.db.mixing.EntityDescriptor

Length - Annotation Type in sirius.db.mixing.annotations

Specifies the column length, most probably of string (CHAR) columns.

length - Variable in class sirius.db.mixing.Property

Contains the length of this property

Like - Class in sirius.db.jdbc.constraints

Represents a LIKE constraint.

Like(Mapping) - Constructor for class sirius.db.jdbc.constraints.Like

like(Mapping) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

Creates a LIKE constraint for the given field.

like(Mapping) - Static method in class sirius.db.mixing.query.QueryField

Informs the compiler, that by default, equality checks are used for this field.

limit - Variable in class sirius.db.mixing.query.BaseQuery

Contains the max number of items to fetch (or 0 for "unlimited")

limit(int) - Method in class sirius.db.mixing.query.BaseQuery

Specifies the max. number of items to fetch.

limit(int, int) - Method in class sirius.db.mongo.Finder

Adds a limit to the query.

limit(int) - Method in class sirius.db.mongo.Finder

Adds a limit to the query.

limit(int, int) - Method in class sirius.db.mongo.MongoQuery

Adds a limit to the query.

limit(int) - Method in class sirius.db.mongo.MongoQuery

link() - Method in class sirius.db.mixing.EntityDescriptor

Links all properties to setup foreign keys and delete constraints.

link() - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

link() - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

link() - Method in class sirius.db.mixing.Property

Links this property.

loadCreatedId(SQLEntity, Row) - Static method in class sirius.db.jdbc.OMA

Loads an auto generated id from the given row.

loadIntoRow(ResultSet) - Method in class sirius.db.jdbc.BaseSQLQuery

Lob - Annotation Type in sirius.db.mixing.annotations

Marks a CHAR column as CLOB / TEXT which can store very large amounts of data.

LocalDateProperty - Class in sirius.db.mixing.properties

Represents a date property which contains no associated time value.

LocalDateProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.LocalDateProperty

LocalDateProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

LocalDateTimeProperty - Class in sirius.db.mixing.properties

Represents a timestamp property which contains a date along with a time value.

LocalDateTimeProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.LocalDateTimeProperty

LocalDateTimeProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

LocalTimeProperty - Class in sirius.db.mixing.properties

Represents an LocalTime field within a Mixable.

LocalTimeProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

LockInfo(String, String, String, LocalDateTime, Long) - Constructor for class sirius.db.redis.Redis.LockInfo

LOG - Static variable in class sirius.db.es.Elastic

Contains the logger used by everything related to Elasticsearch

LOG - Static variable in class sirius.db.jdbc.Databases

LOG - Static variable in class sirius.db.jdbc.OMA

Contains the central logger for the OMA facility.

LOG - Static variable in class sirius.db.mixing.Mixing

LOG - Static variable in class sirius.db.mongo.Mongo

LOG - Static variable in class sirius.db.redis.Redis

LongProperty - Class in sirius.db.mixing.properties

Represents an Long field within a Mixable.

LongProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

lowercaseValues - Variable in class sirius.db.mixing.query.constraints.CSVFilter

lowercaseValues() - Method in class sirius.db.mixing.query.constraints.CSVFilter

Signals that this constraint should convert the values to lowercase before being applied

LowLevelClient - Class in sirius.db.es

Provides a low-level client against Elasticsearch.

LowLevelClient(RestClient) - Constructor for class sirius.db.es.LowLevelClient

Creates a new client based on the given REST client which handle load balancing and connection management.

lt(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field < value as constraint

lte(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field <= value as constraint

lteOrEmpty(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field <= OR empty(field) value as constraint

ltOrEmpty(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field < OR empty(field) value as constraint

ltValue(Mapping, Object, boolean) - Method in class sirius.db.es.constraints.ElasticFilterFactory

ltValue(Mapping, Object, boolean) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

ltValue(Mapping, Object, boolean) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field < value as constraint

ltValue(Mapping, Object, boolean) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

M

make(EntityDescriptor, JSONObject) - Static method in class sirius.db.es.Elastic

Creates a new instance of the given entity type for the given data.

make(Class<? extends BaseMapper<?, ?, ?>>, String, ValueSupplier<String>) - Method in class sirius.db.mixing.EntityDescriptor

Creates an entity from the given result row.

make(EntityDescriptor, Doc) - Static method in class sirius.db.mongo.Mango

Creates a new entity for the given descriptor based on the given doc.

makeNewInstance(Class<A>) - Method in class sirius.db.mixing.Mixable

mango - Static variable in class sirius.db.mixing.Mixable

Mango - Class in sirius.db.mongo

Provides the mapper used to communicate with MongoDB.

Mango() - Constructor for class sirius.db.mongo.Mango

mango - Static variable in class sirius.db.mongo.MongoEntity

many() - Method in class sirius.db.mongo.Updater

Specifies that multiple documents should be updated.

manyFrom(Class<?>) - Method in class sirius.db.mongo.Deleter

Executes the delete statement on the given collection.

manyFrom(String) - Method in class sirius.db.mongo.Deleter

Executes the delete statement on the given collection.

mapper - Variable in class sirius.db.mixing.EntityDescriptor

Mapping - Class in sirius.db.mixing

Represents a column (property) name which is used in queries.

MAPPING_DOC_VALUES - Static variable in class sirius.db.es.IndexMappings

Mapping key used to tell ES about the doc_values setting.

MAPPING_INDEX - Static variable in class sirius.db.es.IndexMappings

Mapping key used to tell ES if a property is indexed (searchable).

MAPPING_NORMS - Static variable in class sirius.db.es.IndexMappings

Mapping key used to tell ES if and how to store norms.

MAPPING_STORED - Static variable in class sirius.db.es.IndexMappings

Mapping key used to tell ES if and how a property is stored

MAPPING_TYPE - Static variable in class sirius.db.es.IndexMappings

Mapping key used to tell ES the mapping type of a field.

MAPPING_TYPE_KEWORD - Static variable in class sirius.db.es.IndexMappings

Mapping value used to mark a field as "keywors" meaning that it is indexed but not analyzed.

mappings - Variable in class sirius.db.jdbc.batch.BatchQuery

matches(String) - Method in class sirius.db.jdbc.constraints.Like

Specifies a value to match in the given field.

MAX_BATCH_BACKLOG - Static variable in class sirius.db.jdbc.batch.BatchQuery

Defines the default batch size used by a query.

MAX_LIST_SIZE - Static variable in class sirius.db.mixing.query.BaseQuery

Contains the maximal number of elements to be returned in BaseQuery.queryList().

messageDuration - Variable in class sirius.db.redis.Redis

migrateSchemaTo(Database, List<Table>, boolean) - Method in class sirius.db.jdbc.schema.SchemaTool

Generates a list of schema change actions.

Mixable - Class in sirius.db.mixing

A mixable can be extended by Mixins.

Mixable() - Constructor for class sirius.db.mixing.Mixable

Mixin - Annotation Type in sirius.db.mixing.annotations

Marks a class as mixin for another target class (which is either an SQLEntity or a Composite).

mixin(Class<?>) - Static method in class sirius.db.mixing.Mapping

Creates a new Mapping for a mixin class.

mixing - Static variable in class sirius.db.jdbc.batch.BatchQuery

mixing - Static variable in class sirius.db.mixing.BaseEntity

mixing - Variable in class sirius.db.mixing.BaseMapper

mixing - Static variable in class sirius.db.mixing.Mixable

Mixing - Class in sirius.db.mixing

Provides a lookup facility to the descriptor for an entity.

Mixing() - Constructor for class sirius.db.mixing.Mixing

mixing - Static variable in class sirius.db.mixing.properties.BaseEntityRefProperty

mixing - Static variable in class sirius.db.mixing.query.BaseQuery

mixing - Static variable in class sirius.db.mongo.QueryBuilder

MixinLoadAction - Class in sirius.db.mixing

Loads all Mixins so that they don't have to wear a Register annotation.

MixinLoadAction() - Constructor for class sirius.db.mixing.MixinLoadAction

mixins - Variable in class sirius.db.mixing.EntityDescriptor

Contains a set of all mixins available for this entity.

mode - Variable in class sirius.db.mixing.query.constraints.CSVFilter

modify() - Method in class sirius.db.mixing.types.SafeList

Provides read and write access to the underlying list.

modify() - Method in class sirius.db.mixing.types.SafeMap

Provides read and write access to the underlying map.

Mongo - Class in sirius.db.mongo

Provides a thin layer above Mongo DB with fluent APIs for CRUD operations.

Mongo() - Constructor for class sirius.db.mongo.Mongo

mongo - Static variable in class sirius.db.mongo.MongoEntity

mongo - Variable in class sirius.db.mongo.QueryBuilder

MongoCommand - Class in sirius.db.mongo

Reports statistics and controls tracing via the system console.

MongoCommand() - Constructor for class sirius.db.mongo.MongoCommand

MongoConstraint - Class in sirius.db.mongo.constraints

Defines a constraint which is accepted by MongoQuery and most probably generated by MongoFilterFactory.

MongoConstraint(String, Object) - Constructor for class sirius.db.mongo.constraints.MongoConstraint

Creates a new constraint for the given field.

MongoEntity - Class in sirius.db.mongo

Represents the base class for all entities which are managed via Mango and stored in MongoDB.

MongoEntity() - Constructor for class sirius.db.mongo.MongoEntity

MongoFilterFactory - Class in sirius.db.mongo.constraints

Generates filters and constraints for MongoQuery.

MongoFilterFactory() - Constructor for class sirius.db.mongo.constraints.MongoFilterFactory

MongoMetricsProvider - Class in sirius.db.mongo

Provides metrics for Mongo DB (if configured).

MongoMetricsProvider() - Constructor for class sirius.db.mongo.MongoMetricsProvider

MongoQuery<E extends MongoEntity> - Class in sirius.db.mongo

Creates a new query against MongoDB.

MongoQuery(EntityDescriptor) - Constructor for class sirius.db.mongo.MongoQuery

Creates a new query for the given descriptor.

MongoQueryCompiler - Class in sirius.db.mongo.constraints

Provides a query compiler for MongoQuery and MongoFilterFactory.

MongoQueryCompiler(MongoFilterFactory, EntityDescriptor, String, List<QueryField>) - Constructor for class sirius.db.mongo.constraints.MongoQueryCompiler

Creates a new instance for the given factory entity and query.

MongoRef<E extends MongoEntity> - Class in sirius.db.mongo.types

Represents a reference from one entity to another.

MongoRef(Class<E>, BaseEntityRef.OnDelete) - Constructor for class sirius.db.mongo.types.MongoRef

MongoRefList<E extends MongoEntity> - Class in sirius.db.mongo.types

Represents a list of entities being referenced by id.

MongoRefList(Class<E>, BaseEntityRef.OnDelete) - Constructor for class sirius.db.mongo.types.MongoRefList

Creates a new list for the given type and delete handler.

MongoRefProperty - Class in sirius.db.mixing.properties

Represents a reference to another MongoEntity field within a Mixable.

MongoRefProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.MongoRefProperty

MongoRefProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

MultiPointLocation - Class in sirius.db.mongo.types

Represents a list of 2D locations which can be stored in MongoDB for geo queries.

MultiPointLocation() - Constructor for class sirius.db.mongo.types.MultiPointLocation

MultiPointLocationProperty - Class in sirius.db.mixing.properties

Permits to store a MultiPointLocation as location aware "MultiPoint" in MongoDB.

MultiPointLocationProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

must(JSONObject) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a MUST constraint for the given query.

must(ElasticConstraint) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a MUST constraint for the given query.

must(JSONObject) - Method in class sirius.db.es.ElasticQuery

Adds a MUST filter to the query.

must(ElasticConstraint) - Method in class sirius.db.es.ElasticQuery

Adds a MUST filter to the query.

mustNot(JSONObject) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a MUST NOT constraint for the given query.

mustNot(ElasticConstraint) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a MUST NOT constraint for the given query.

mustNot(JSONObject) - Method in class sirius.db.es.ElasticQuery

Adds a MUST NOT filter to the query.

mustNot(ElasticConstraint) - Method in class sirius.db.es.ElasticQuery

Adds a MUST NOT filter to the query.

MYSQL_CAPABILITIES - Static variable in enum sirius.db.jdbc.Capability

Contains the capabilities of a MySQL database

MySQLDatabaseDialect - Class in sirius.db.jdbc.schema

Defines the dialect used to sync the schema against a MySQL database.

MySQLDatabaseDialect() - Constructor for class sirius.db.jdbc.schema.MySQLDatabaseDialect

N

name - Variable in class sirius.db.jdbc.Database

name - Variable in class sirius.db.mixing.Property

Contains the effective property name.

name - Variable in class sirius.db.redis.Redis.LockInfo

The name of the lock, without any reids prefixes

nameAsMapping - Variable in class sirius.db.mixing.Property

Represents the name of the property a Mapping

named(String) - Method in class sirius.db.es.constraints.ElasticConstraint

Makes this constraint a named query.

named(String) - Static method in class sirius.db.mixing.Mapping

Creates a new Mapping.

ne(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field !

ne(Mapping, Object) - Method in class sirius.db.mixing.query.Query

Adds a constraint which ensures that the given field does not contain the given value.

nearSphere(Mapping, Document, int) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

Builds a filter which represents a geospatial query.

nearSphere(Mapping, double, double, int) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

Builds a filter which represents a geospatial query for a point.

nested(Mapping) - Method in class sirius.db.es.constraints.ElasticFilterFactory

Executes a nested query.

nested(Mapping) - Method in class sirius.db.mixing.Mapping

References a field of a nested list or map represented by this mapping.

nested(String) - Method in class sirius.db.mixing.Mapping

References a dynamic inner property of a nested map represented by this mapping.

Nested - Class in sirius.db.mixing

Base class for all nested objects.

Nested() - Constructor for class sirius.db.mixing.Nested

NESTED_SEPARATOR - Static variable in class sirius.db.mixing.Mapping

Used to join several field names (e.g. for nesteds).

NestedList<N extends Nested> - Class in sirius.db.mixing.types

Represents a list of Nested objects.

NestedList(Class<N>) - Constructor for class sirius.db.mixing.types.NestedList

Creates a new list for the given type.

NestedListProperty - Class in sirius.db.mixing.properties

Represents an NestedList field within a MongoEntity.

NestedListProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.NestedListProperty

NestedListProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

NestedLoadAction - Class in sirius.db.mixing

Loads all nested objects known by Mixing.

NestedLoadAction() - Constructor for class sirius.db.mixing.NestedLoadAction

Once a new instance is created - which only happens during framework initialization, we reset the list of known entities as a new discrovery run will start.

nestedMapContains(Mapping, String, String) - Method in class sirius.db.es.constraints.ElasticFilterFactory

Creates a filter which ensures, that a nested StringMap or StringListMap contains the given key and value.

NestedQuery - Class in sirius.db.es.constraints

Executes a nested query.

NestedQuery(Mapping) - Constructor for class sirius.db.es.constraints.NestedQuery

Creates a new nested query for elements in the given field / list.

neValue(Mapping, Object) - Method in class sirius.db.es.constraints.ElasticFilterFactory

neValue(Mapping, Object) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

neValue(Mapping, Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Represents field !

neValue(Mapping, Object) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

NEW - Static variable in class sirius.db.mixing.BaseEntity

Contains the constant used to mark a new (unsaved) entity.

NON_PERSISTENT_ENTITY_ID - Static variable in class sirius.db.jdbc.SQLEntity

Represents the id which signals that the entity was not persisted yet.

noneInField(Mapping, List<Object>) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Creates a constraint which ensures that the given field doesn't contain any of the given values.

noneInField(Mapping, List<Object>) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

not(C) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Inverts the given constraint.

notFilled(Mapping) - Method in class sirius.db.es.constraints.ElasticFilterFactory

notFilled(Mapping) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

notFilled(Mapping) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Generates a constraint which ensures that the given field is not filled (null)

notFilled(Mapping) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

nullable - Variable in class sirius.db.mixing.Property

Determines the nullability of the property

NullAllowed - Annotation Type in sirius.db.mixing.annotations

Determines the nullability of a column.

numConnects - Static variable in class sirius.db.jdbc.Databases

Numeric - Annotation Type in sirius.db.mixing.annotations

Specifies the numeric precision of a NUMBER column.

numQueries - Static variable in class sirius.db.jdbc.Databases

numSlowQueries - Static variable in class sirius.db.jdbc.Databases

numUses - Static variable in class sirius.db.jdbc.Databases

O

object - Variable in class sirius.db.mongo.constraints.MongoConstraint

oma - Static variable in class sirius.db.jdbc.batch.BatchQuery

OMA - Class in sirius.db.jdbc

Provides the mapper used to communicate with JDBC / SQL databases.

OMA() - Constructor for class sirius.db.jdbc.OMA

oma - Static variable in class sirius.db.jdbc.SQLEntity

oma - Static variable in class sirius.db.mixing.Mixable

on(Class<E>, BaseEntityRef.OnDelete) - Static method in class sirius.db.es.types.ElasticRef

Generates an entity reference to the given entity type.

on(Class<E>, BaseEntityRef.OnDelete) - Static method in class sirius.db.jdbc.SQLEntityRef

Generates an entity reference to the given entity type.

on(Class<E>, BaseEntityRef.OnDelete) - Static method in class sirius.db.mongo.types.MongoRef

Generates an entity reference to the given entity type.

onAfterDelete(Object) - Method in class sirius.db.mixing.Property

Invoked after an entity was deleted from the database

onAfterSave(Object) - Method in class sirius.db.mixing.Property

Invoked after an entity was written to the database

onBeforeDelete(Object) - Method in class sirius.db.mixing.Property

Invoked before an entity is deleted from the database

onBeforeSave(Object) - Method in class sirius.db.mixing.Property

Invoked before an entity is written to the database.

onBeforeSaveChecks(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

onBeforeSaveChecks(Object) - Method in class sirius.db.mixing.properties.NestedListProperty

onBeforeSaveChecks(Object) - Method in class sirius.db.mixing.properties.StringProperty

onBeforeSaveChecks(Object) - Method in class sirius.db.mixing.Property

Invoked before an entity is written to the database.

onDeleteCascade(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

onDeleteCascade(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

onDeleteReject(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

onDeleteReject(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

onDeleteSetNull(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

onDeleteSetNull(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

one() - Method in class sirius.db.mixing.query.BaseQuery

Returns the single item matched by the query.

oneInField(Mapping, List<Object>) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Creates a filter builder which ensures that the given field contains at least on of the given values.

OneInField<C extends Constraint> - Class in sirius.db.mixing.query.constraints

Represents a constraint which verifies that the given field contains one of the given values.

OneInField(FilterFactory<C>, Mapping, Collection<Object>) - Constructor for class sirius.db.mixing.query.constraints.OneInField

oneInField(Mapping, List<Object>) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

onMessage(String) - Method in interface sirius.db.redis.Subscriber

Invoked for each message received from redis for the subscribed topic.

OnValidate - Annotation Type in sirius.db.mixing.annotations

Used to mark methods in Mixables which will be called once is validated.

OptimisticLockException - Exception in sirius.db.mixing

Signals that a concurrent modification occured on an versioned entity which supports optimistic locking.

OptimisticLockException() - Constructor for exception sirius.db.mixing.OptimisticLockException

Creates a new instance without any reference to another error.

OptimisticLockException(String, Throwable) - Constructor for exception sirius.db.mixing.OptimisticLockException

Creates a new instance with a reference to the given cause.

or(List<C>) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Combines the list of constraints using OR

or(C...) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Combines the list of constraints using OR

orderAsc(Mapping) - Method in class sirius.db.es.ElasticQuery

Adds an ascending sort by the given field to the query.

orderAsc(Mapping) - Method in class sirius.db.jdbc.SmartQuery

orderAsc(Mapping) - Method in class sirius.db.mixing.query.Query

Adds a sort constraint to order by the given field ascending.

orderAsc(Mapping) - Method in class sirius.db.mongo.MongoQuery

orderByAsc(String) - Method in class sirius.db.es.ElasticQuery.InnerHitsBuilder

Adds a sort criteria for the given field, sorting ascending

orderByAsc(Mapping) - Method in class sirius.db.mongo.Finder

Adds a sort constraint to order by the given field ascending.

orderByAsc(String) - Method in class sirius.db.mongo.Finder

Adds a sort constraint to order by the given field ascending.

orderByDesc(String) - Method in class sirius.db.es.ElasticQuery.InnerHitsBuilder

Adds a sort criteria for the given field, sorting descending

orderByDesc(Mapping) - Method in class sirius.db.mongo.Finder

Adds a sort constraint to order by the given field descending.

orderByDesc(String) - Method in class sirius.db.mongo.Finder

Adds a sort constraint to order by the given field descending.

orderBys - Variable in class sirius.db.jdbc.SmartQuery

orderDesc(Mapping) - Method in class sirius.db.es.ElasticQuery

Adds a descending sort by the given field to the query.

orderDesc(Mapping) - Method in class sirius.db.jdbc.SmartQuery

orderDesc(Mapping) - Method in class sirius.db.mixing.query.Query

Adds a sort constraint to order by the given field descending.

orderDesc(Mapping) - Method in class sirius.db.mongo.MongoQuery

Ordinal - Annotation Type in sirius.db.mixing.annotations

Marker annotation used on enums to make EnumProperty store the ordinal index of the enum constant in the database instead of the name.

orEmpty - Variable in class sirius.db.mixing.query.constraints.CSVFilter

orEmpty() - Method in class sirius.db.mixing.query.constraints.CSVFilter

Signals the constraint to also accept an empty target field if containsAny is used.

orEmpty - Variable in class sirius.db.mixing.query.constraints.OneInField

orEmpty() - Method in class sirius.db.mixing.query.constraints.OneInField

Signals that this constraint is also fulfilled if the target field is empty.

original() - Method in class sirius.db.mixing.types.SafeList

Provides access to the list which was origrinally used to supply contents.

original() - Method in class sirius.db.mixing.types.SafeMap

Provides access to the map which was origrinally used to supply contents.

override(E) - Method in class sirius.db.mixing.BaseMapper

Performs an BaseMapper.update(BaseEntity) of the entity, without checking for concurrent modifications.

overwrite(ElasticEntity) - Method in class sirius.db.es.BulkContext

Queues an BaseMapper.override(BaseEntity) in the batch context.

P

parameters - Variable in class sirius.db.jdbc.SmartQuery.Compiler

parse(String) - Static method in class sirius.db.mixing.query.QueryTag

Parses the tag from a given search query.

parseOperation(String) - Method in class sirius.db.mixing.query.QueryCompiler

parseValue(Object, Value) - Method in class sirius.db.mixing.Property

Parses the given value and applies it to the given entity if possible.

performDelete() - Method in class sirius.db.es.LowLevelClient

Builds a DELETE request.

performDelete(E, boolean) - Method in class sirius.db.mixing.BaseMapper

performGet() - Method in class sirius.db.es.LowLevelClient

Builds a GET request.

performPost() - Method in class sirius.db.es.LowLevelClient

Builds a POST request.

performPut() - Method in class sirius.db.es.LowLevelClient

Builds a PUT request.

performUpdate(E, boolean) - Method in class sirius.db.mixing.BaseMapper

persistedData - Variable in class sirius.db.mixing.BaseEntity

pollQueue(String) - Method in class sirius.db.redis.Redis

Polls an element off a queue in Redis.

postFilter(JSONObject) - Method in class sirius.db.es.ElasticQuery

Adds a post filterto the query.

postFilter(ElasticConstraint) - Method in class sirius.db.es.ElasticQuery

Adds a post filter to the query.

POSTGRES_CAPABILITIES - Static variable in enum sirius.db.jdbc.Capability

Contains the capabilities of a Postgres database

postJoinQuery - Variable in class sirius.db.jdbc.SmartQuery.Compiler

prefix(Mapping, String) - Method in class sirius.db.es.constraints.ElasticFilterFactory

Creates a prefix query.

prefix() - Method in class sirius.db.mixing.AccessPath

Returns the prefix appended to all fields to generate unique property names.

preJoinQuery - Variable in class sirius.db.jdbc.SmartQuery.Compiler

prepareStmt() - Method in class sirius.db.jdbc.batch.BatchQuery

Prepares a new statement if not done already.

prepareUpdate(String) - Method in class sirius.db.mongo.Updater

prepareValues(Context, StringBuilder, StringBuilder, List<Object>) - Method in class sirius.db.jdbc.Database

processResultSet(Function<Row, Boolean>, Limit, ResultSet, TaskContext) - Method in class sirius.db.jdbc.BaseSQLQuery

processResultSet(Function<Row, Boolean>, Limit, ResultSet, TaskContext) - Method in class sirius.db.jdbc.SQLQuery

properties - Variable in class sirius.db.jdbc.batch.BatchQuery

properties - Variable in class sirius.db.mixing.EntityDescriptor

Contains all properties (defined via fields, composites or mixins)

Property - Class in sirius.db.mixing

Maps a field, which is either defined in an entity, a composite or a mixin to a mapped property.

Property(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.Property

Creates a new property for the given descriptor, access path and field.

PropertyFactory - Interface in sirius.db.mixing

Describes a property factory which generates a Property for a given Field.

propertyKey - Variable in class sirius.db.mixing.Property

Contains the i18n key used to determine the label (official name) of the property.

propertyName - Variable in class sirius.db.mixing.Property

Contains the effective property name.

publish(String, String) - Method in class sirius.db.redis.Redis

Broadcasts a message to a pub-sub topic in redis.

pull(Mapping, Object) - Method in class sirius.db.mongo.Updater

Removes all occurences of the given value from the list in the given field.

pull(String, Object) - Method in class sirius.db.mongo.Updater

Removes all occurences of the given value from the list in the given field.

pullAll(Mapping, Object...) - Method in class sirius.db.mongo.Updater

Removes all occurences of the given values from the list in the given field.

pullAll(String, Object...) - Method in class sirius.db.mongo.Updater

Removes all occurences of the given values from the list in the given field.

pushToQueue(String, String) - Method in class sirius.db.redis.Redis

Pushes a piece of data to a queue in Redis.

put(K, V) - Method in class sirius.db.mixing.types.SafeMap

Puts the given key and value into the map.

put(String, Object) - Method in class sirius.db.mongo.Doc

Updates the underlying object, without updating the database.

put(Mapping, Object) - Method in class sirius.db.mongo.Doc

Updates the underlying object, without updating the database.

putMapping(String, String, JSONObject) - Method in class sirius.db.es.LowLevelClient

Creates the given mapping.

Q

qry - Variable in class sirius.db.jdbc.TransformedQuery

query - Variable in class sirius.db.jdbc.batch.BatchQuery

query - Variable in class sirius.db.jdbc.batch.BatchSQLQuery

query() - Method in class sirius.db.jdbc.batch.CustomQuery

Executes the statement as query.

Query<Q,E extends BaseEntity<?>,C extends Constraint> - Class in sirius.db.mixing.query

Describes the minimal functionality to be supported by a query generated by a mapper.

Query(EntityDescriptor) - Constructor for class sirius.db.mixing.query.Query

query(Supplier<String>, Function<Jedis, T>) - Method in class sirius.db.redis.Redis

Executes one or more Redis commands and returns a value of the given type.

QueryBuilder<S> - Class in sirius.db.mongo

Base class for queries providing a filter builder.

QueryCompiler<C extends Constraint> - Class in sirius.db.mixing.query

Parses an SQL like query and compiles it into a Constraint.

QueryCompiler(FilterFactory<C>, EntityDescriptor, String, List<QueryField>) - Constructor for class sirius.db.mixing.query.QueryCompiler

Creates a new instance for the given factory entity and query.

QueryCompiler.FieldValue - Class in sirius.db.mixing.query

Represents a value parsed for a field.

queryDuration - Static variable in class sirius.db.jdbc.Databases

queryError(SmartQuery.Compiler, Exception) - Method in class sirius.db.jdbc.SmartQuery

QueryField - Class in sirius.db.mixing.query

Annotates a field to be used in FilterFactory.queryString(EntityDescriptor, String, QueryField...).

QueryField.Mode - Enum in sirius.db.mixing.query

Determines the way, the filter value can be applied to a given field.

queryFirst() - Method in class sirius.db.jdbc.BaseSQLQuery

Executes the given query returning the first matching row.

queryFirst() - Method in class sirius.db.mixing.query.BaseQuery

Returns the first item matched by the query.

queryList() - Method in class sirius.db.jdbc.BaseSQLQuery

Executes the given query returning the result as list

queryList(Limit) - Method in class sirius.db.jdbc.BaseSQLQuery

Executes the given query returning the result as list with at most maxRows entries

queryList() - Method in class sirius.db.mixing.query.BaseQuery

Returns a list of all items in the result.

queryOne() - Method in class sirius.db.mixing.query.BaseQuery

Returns the first item matched by the query.

queryString(EntityDescriptor, String, List<QueryField>) - Method in class sirius.db.es.constraints.ElasticFilterFactory

queryString(EntityDescriptor, String, List<QueryField>) - Method in class sirius.db.jdbc.constraints.SQLFilterFactory

queryString(EntityDescriptor, String, QueryField...) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Compiles the given query for the given entity while searching in the given fields.

queryString(EntityDescriptor, String, List<QueryField>) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Compiles the given query for the given entity while searching in the given fields.

queryString(String, QueryField...) - Method in class sirius.db.mixing.query.Query

Adds a query string filter to the given query.

queryString(EntityDescriptor, String, List<QueryField>) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

QueryTag - Class in sirius.db.mixing.query

Can be embedded in a query parsed by the QueryCompiler.

QueryTag(String, String, String, String) - Constructor for class sirius.db.mixing.query.QueryTag

Creates a new tag.

QueryTagHandler<C extends Constraint> - Interface in sirius.db.mixing.query

Compiles a tag value provided by a QueryTag into a Constraint.

R

readBackParameters(CallableStatement) - Method in class sirius.db.jdbc.SQLCall

readColumns(ResultSet) - Method in class sirius.db.jdbc.Databases

Reads and returns all available columns of the given result set as upper case.

reader - Variable in class sirius.db.mixing.query.QueryCompiler

readTableRow(List<Table>, Connection, ResultSet) - Method in class sirius.db.jdbc.schema.SchemaTool

readyFuture - Variable in class sirius.db.es.Elastic

Realm - Annotation Type in sirius.db.mixing.annotations

Specifies the realm to use for an entity.

Redis - Class in sirius.db.redis

Provides a thin layer to access Redis.

Redis() - Constructor for class sirius.db.redis.Redis

Redis.LockInfo - Class in sirius.db.redis

Data object for storing information of a redis lock

RedisCommand - Class in sirius.db.redis

Reports all available statistics for Redis.

RedisCommand() - Constructor for class sirius.db.redis.RedisCommand

RedisMetricProvider - Class in sirius.db.redis

Provides metrics for Redis (if configured).

RedisMetricProvider() - Constructor for class sirius.db.redis.RedisMetricProvider

referencedDescriptor - Variable in class sirius.db.mixing.properties.BaseEntityRefProperty

referencedType - Variable in class sirius.db.mixing.properties.BaseEntityRefProperty

refreshOrFail(E) - Method in class sirius.db.mixing.BaseMapper

Tries to fetch a fresh (updated) instance of the given entity from the database.

regex(Mapping, Object, String) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

Builds a filter which represents a regex filter for the given field and expression.

RelationName - Annotation Type in sirius.db.mixing.annotations

Specifies the relation name to used for an entity.

remove(E) - Method in class sirius.db.mixing.types.BaseEntityRefList

Removes the given entity from the list.

remove(String, String) - Method in class sirius.db.mixing.types.StringListMap

Removes the given value from the given list.

resolve(String, ContextInfo...) - Method in class sirius.db.es.types.ElasticRefList

resolve(String, ContextInfo...) - Method in class sirius.db.mixing.BaseMapper

Tries to resolve the BaseEntity.getUniqueName() into an entity.

resolve(String, ContextInfo...) - Method in class sirius.db.mixing.types.BaseEntityRefList

Resolves a given ID into an entity instance.

resolve(String, ContextInfo...) - Method in class sirius.db.mongo.types.MongoRefList

resolveOrFail(String, ContextInfo...) - Method in class sirius.db.mixing.BaseMapper

Tries to BaseMapper.resolve(String, ContextInfo...) the given name into an entity.

resolveType(Class<?>) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

restoreTranslationState(TranslationState) - Method in class sirius.db.jdbc.SmartQuery.Compiler

Restores a previously captured translation state.

rewritePropertyName(String) - Method in class sirius.db.mixing.EntityDescriptor

Applies legacy renaming rules to determine the effective property name based on the name generated by the property.

rootFetch - Variable in class sirius.db.jdbc.SmartQuery.Compiler

RoutedBy - Annotation Type in sirius.db.es.annotations

Marks the field / property which is used as routing info for an Elasticsearch index.

routedBy(String) - Static method in class sirius.db.es.Elastic

Provides a "routed by" context for BaseMapper.find(Class, Object, ContextInfo...).

routeTable - Variable in class sirius.db.es.Elastic

routing(String) - Method in class sirius.db.es.ElasticQuery

Specifies the routing value to use.

Row - Class in sirius.db.jdbc

A small wrapper class to represent a result row.

Row() - Constructor for class sirius.db.jdbc.Row

S

safeClose() - Method in class sirius.db.jdbc.batch.BatchContext

safeClose() - Method in class sirius.db.jdbc.batch.BatchQuery

Releases all resources with graceful error handling

SafeList<T> - Class in sirius.db.mixing.types

Describes a list of objects which can be stored in an entity as property value.

SafeList() - Constructor for class sirius.db.mixing.types.SafeList

SafeMap<K,V> - Class in sirius.db.mixing.types

Describes a map of objects which can be stored in an entity as property value.

SafeMap() - Constructor for class sirius.db.mixing.types.SafeMap

Schema - Class in sirius.db.jdbc.schema

Creates the database schemata for all databases managed via Mixing and OMA.

Schema() - Constructor for class sirius.db.jdbc.schema.Schema

SchemaTool - Class in sirius.db.jdbc.schema

Helper class for manipulating and inspecting db metadata.

SchemaTool(String, DatabaseDialect) - Constructor for class sirius.db.jdbc.schema.SchemaTool

Creates a new instance for the given dialect.

SchemaUpdateAction - Class in sirius.db.jdbc.schema

Represents an action which needs to be perfomed onto a schema to make it match another schema.

SchemaUpdateAction(String) - Constructor for class sirius.db.jdbc.schema.SchemaUpdateAction

search(List<String>, String, String, int, int, JSONObject) - Method in class sirius.db.es.LowLevelClient

Executes a search.

searchFields - Variable in class sirius.db.mixing.query.QueryCompiler

select(Class<E>) - Method in class sirius.db.es.Elastic

select(Class<E>) - Method in class sirius.db.jdbc.OMA

select(Class<E>) - Method in class sirius.db.mixing.BaseMapper

Creates a query for the given type.

select(Class<E>) - Method in class sirius.db.mongo.Mango

selectFields(Mapping...) - Method in class sirius.db.mongo.Finder

Limits the fields being returned to the given list.

selectFields(String...) - Method in class sirius.db.mongo.Finder

Limits the fields being returned to the given list.

sentinelPool - Variable in class sirius.db.redis.Redis

set(String, Object) - Method in class sirius.db.jdbc.SQLQuery

Adds a parameter.

set(Map<String, Object>) - Method in class sirius.db.jdbc.SQLQuery

Sets all parameters of the given context.

set(Mapping, Object) - Method in class sirius.db.mongo.Inserter

Sets a field to the given value.

set(String, Object) - Method in class sirius.db.mongo.Inserter

Sets a field to the given value.

set(Mapping, Object) - Method in class sirius.db.mongo.Updater

Sets a field to a new value.

set(String, Object) - Method in class sirius.db.mongo.Updater

Sets a field to a new value.

setAutoIncrement(boolean) - Method in class sirius.db.jdbc.schema.TableColumn

Sets the auto increment flag of this column

setData(List<T>) - Method in class sirius.db.mixing.types.SafeList

Sets the underyling list to use.

setData(Map<K, V>) - Method in class sirius.db.mixing.types.SafeMap

Sets the underyling map to use.

setDataLossPossible(boolean) - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

setDefaultValue(String) - Method in class sirius.db.jdbc.schema.TableColumn

Specifies the default value.

setForeignTable(String) - Method in class sirius.db.jdbc.schema.ForeignKey

Sets the name of the referenced table.

setId(String) - Method in class sirius.db.es.ElasticEntity

Note that only the framework must use this to specify the ID of the entity.

setId(long) - Method in class sirius.db.jdbc.SQLEntity

Sets the ID of the entity.

setId(I) - Method in class sirius.db.mixing.types.BaseEntityRef

Sets the id of the referenced entity.

setId(String) - Method in class sirius.db.mongo.MongoEntity

setLength(int) - Method in class sirius.db.jdbc.schema.TableColumn

Specifies the max. length of the column.

setList(Mapping, Object...) - Method in class sirius.db.mongo.Inserter

Sets a field to the given list of values.

setList(String, Object...) - Method in class sirius.db.mongo.Inserter

Sets a field to the given list of values.

setList(Mapping, Object...) - Method in class sirius.db.mongo.Updater

Sets a field to the given list of values.

setList(String, Object...) - Method in class sirius.db.mongo.Updater

Sets a field to the given list of values.

setName(String) - Method in class sirius.db.jdbc.schema.ForeignKey

Sets the name of the foreign key.

setName(String) - Method in class sirius.db.jdbc.schema.Key

Sets the name of the key.

setName(String) - Method in class sirius.db.jdbc.schema.Table

Sets the name of the table.

setName(String) - Method in class sirius.db.jdbc.schema.TableColumn

Sets the name of the column.

setNullable(boolean) - Method in class sirius.db.jdbc.schema.TableColumn

Specifies the nullability of the column.

setOldName(String) - Method in class sirius.db.jdbc.schema.TableColumn

Set the old name of a column.

setParameter(int, Object) - Method in class sirius.db.jdbc.batch.CustomQuery

Sets the given parameter to the given value.

setPrecision(int) - Method in class sirius.db.jdbc.schema.TableColumn

Specifies a precision of the column.

setRealm(String) - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

setReason(String) - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

setReferencedEntity(SQLEntity, SQLEntity) - Method in class sirius.db.mixing.properties.SQLEntityRefProperty

Updates the field (SQLEntityRef within the given parent to point to the given child.

setScale(int) - Method in class sirius.db.jdbc.schema.TableColumn

Specifies the number of decimal places.

setSql(String) - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

setSql(List<String>) - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

setType(int) - Method in class sirius.db.jdbc.schema.TableColumn

Sets the JDBC type of the column.

setUnique(boolean) - Method in class sirius.db.jdbc.schema.Key

Sets the unique flag.

setupEntity(EntityDescriptor) - Method in class sirius.db.es.IndexMappings

setValue(String, Object) - Method in class sirius.db.jdbc.Row

Stores a value for the given key.

setValue(Object, Object) - Method in class sirius.db.mixing.Property

Applies the given value to the given entity.

setValue(E) - Method in class sirius.db.mixing.types.BaseEntityRef

Sets the entity being referenced.

setValueFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object, Value) - Method in class sirius.db.mixing.properties.StringProperty

setValueFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object, Value) - Method in class sirius.db.mixing.Property

Applies the given database value to the given entity.

setValueToField(Object, Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

setValueToField(Object, Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

setValueToField(Object, Object) - Method in class sirius.db.mixing.properties.BaseMapProperty

setValueToField(Object, Object) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty

setValueToField(Object, Object) - Method in class sirius.db.mixing.properties.NestedListProperty

setValueToField(Object, Object) - Method in class sirius.db.mixing.properties.StringListProperty

setValueToField(Object, Object) - Method in class sirius.db.mixing.properties.StringProperty

setValueToField(Object, Object) - Method in class sirius.db.mixing.Property

Applies the given value to the field in the given target object

setVersion(int) - Method in class sirius.db.mixing.BaseEntity

Note that only the framework must use this to specify the version of the entity.

setWHEREBuilder(StringBuilder) - Method in class sirius.db.jdbc.SmartQuery.Compiler

should(JSONObject) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a SHOULD constraint for the given query.

should(ElasticConstraint) - Method in class sirius.db.es.constraints.BoolQueryBuilder

Adds a SHOULD constraint for the given query.

shouldDropKey(Table, Table, Key) - Method in class sirius.db.jdbc.schema.ClickhouseDatabaseDialect

shouldDropKey(Table, Table, Key) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Determines if the given key should be dropped.

shouldDropKey(Table, Table, Key) - Method in class sirius.db.jdbc.schema.MySQLDatabaseDialect

simplifyMappings(Mapping[]) - Static method in class sirius.db.jdbc.batch.BatchContext

since - Variable in class sirius.db.redis.Redis.LockInfo

The timestamp when the lock was last acquired

singleFrom(Class<?>) - Method in class sirius.db.mongo.Deleter

Executes the delete statement on the given collection.

singleFrom(String) - Method in class sirius.db.mongo.Deleter

Executes the delete statement on the given collection.

singleIn(Class<?>) - Method in class sirius.db.mongo.Finder

Executes the query for the given collection and returns a single document.

singleIn(String) - Method in class sirius.db.mongo.Finder

Executes the query for the given collection and returns a single document.

sirius.db - package sirius.db

sirius.db.es - package sirius.db.es

sirius.db.es.annotations - package sirius.db.es.annotations

sirius.db.es.constraints - package sirius.db.es.constraints

sirius.db.es.types - package sirius.db.es.types

sirius.db.jdbc - package sirius.db.jdbc

Support layer for using JDBC (accessing SQL Databases).

sirius.db.jdbc.batch - package sirius.db.jdbc.batch

sirius.db.jdbc.constraints - package sirius.db.jdbc.constraints

sirius.db.jdbc.schema - package sirius.db.jdbc.schema

sirius.db.mixing - package sirius.db.mixing

sirius.db.mixing.annotations - package sirius.db.mixing.annotations

sirius.db.mixing.properties - package sirius.db.mixing.properties

sirius.db.mixing.query - package sirius.db.mixing.query

sirius.db.mixing.query.constraints - package sirius.db.mixing.query.constraints

sirius.db.mixing.types - package sirius.db.mixing.types

sirius.db.mongo - package sirius.db.mongo

Thin layer above Mongo DB.

sirius.db.mongo.constraints - package sirius.db.mongo.constraints

sirius.db.mongo.types - package sirius.db.mongo.types

sirius.db.redis - package sirius.db.redis

Thin layer above Redis (using Jedis) Operations against redis are encapsulated in Redis.query and Redis.exec.

size() - Method in class sirius.db.mixing.types.SafeList

Determines the size of the list.

size() - Method in class sirius.db.mixing.types.SafeMap

Returns the number of entries in the map.

skip - Variable in class sirius.db.mixing.query.BaseQuery

Contains the the number of items to skip before items are added to the result

skip(int) - Method in class sirius.db.mixing.query.BaseQuery

Specifies the number of items to skip before items are added to the result.

skip(int) - Method in class sirius.db.mongo.Finder

Specifies the number of items to skip before items are added to the result.

skip(int) - Method in class sirius.db.mongo.MongoQuery

SLOW_DB_LOG - Static variable in class sirius.db.jdbc.Databases

SmartQuery<E extends SQLEntity> - Class in sirius.db.jdbc

Provides a query DSL which is used to query SQLEntity instances from the database.

SmartQuery(EntityDescriptor, Database) - Constructor for class sirius.db.jdbc.SmartQuery

Creates a new query instance.

SmartQuery.Compiler - Class in sirius.db.jdbc

Represents the compiler which is used to generate SQL statements based on a SmartQuery.

sort(JSONObject) - Method in class sirius.db.es.ElasticQuery

Adds a sort statement to the query.

sort(Mapping, JSONObject) - Method in class sirius.db.es.ElasticQuery

Adds a sort statement for the given field to the query.

sortedBeforeSaveHandlers - Variable in class sirius.db.mixing.EntityDescriptor

A list of all additional handlers to be executed once an entity is about to be saved

spliterator() - Method in class sirius.db.mixing.types.SafeList

spliterator() - Method in class sirius.db.mixing.types.SafeMap

splitter - Variable in class sirius.db.mixing.query.constraints.CSVFilter

splitUniqueName(String) - Static method in class sirius.db.mixing.Mixing

Splits a unique name into the descriptor type and id.

SQLCall - Class in sirius.db.jdbc

Represents a flexible way of executing parameterized SQL calls without thinking too much about resource management.

SQLCall(Database, String, Integer) - Constructor for class sirius.db.jdbc.SQLCall

SQLConstraint - Class in sirius.db.jdbc.constraints

Defines a constraint which is accepted by SmartQuery and most probably generated by SQLFilterFactory.

SQLConstraint() - Constructor for class sirius.db.jdbc.constraints.SQLConstraint

SQLEntity - Class in sirius.db.jdbc

Represents the base class for all entities which are managed via OMA and stored in a JDBC / SQL database.

SQLEntity() - Constructor for class sirius.db.jdbc.SQLEntity

SQLEntityRef<E extends SQLEntity> - Class in sirius.db.jdbc

Represents a reference from one entity to another.

SQLEntityRef(Class<E>, BaseEntityRef.OnDelete) - Constructor for class sirius.db.jdbc.SQLEntityRef

SQLEntityRefProperty - Class in sirius.db.mixing.properties

Represents a reference to another SQLEntity field within a Mixable.

SQLEntityRefProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.SQLEntityRefProperty

SQLEntityRefProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

SQLFilterFactory - Class in sirius.db.jdbc.constraints

Generates filters and constraints for SmartQuery.

SQLFilterFactory() - Constructor for class sirius.db.jdbc.constraints.SQLFilterFactory

SQLPropertyInfo - Interface in sirius.db.jdbc.schema

Provides the schema information for a Property required to build a database schema in a SQL / JDBC database.

SQLQuery - Class in sirius.db.jdbc

Represents a flexible way of executing parameterized SQL queries without thinking too much about resource management.

SQLQuery(Database, String) - Constructor for class sirius.db.jdbc.SQLQuery

SQLQueryCompiler - Class in sirius.db.jdbc.constraints

Provides a query compiler for SmartQuery and SQLFilterFactory.

SQLQueryCompiler(FilterFactory<SQLConstraint>, EntityDescriptor, String, List<QueryField>) - Constructor for class sirius.db.jdbc.constraints.SQLQueryCompiler

Creates a new instance for the given factory entity and query.

started() - Method in class sirius.db.es.IndexMappings

started() - Method in class sirius.db.jdbc.schema.Schema

started() - Method in class sirius.db.mongo.Mongo

started() - Method in class sirius.db.redis.Redis

startsWith(String) - Method in class sirius.db.jdbc.constraints.Like

Sepcifies a value with which the target field needs to start.

startsWith(Mapping) - Static method in class sirius.db.mixing.query.QueryField

Informs the compiler, that by default an expanding search like a prefix query may be generated for this field.

stmt - Variable in class sirius.db.jdbc.batch.BatchQuery

stopped() - Method in class sirius.db.mongo.Mongo

stopped() - Method in class sirius.db.redis.Redis

StorePerYear - Annotation Type in sirius.db.es.annotations

Marks an entity which is stored in one index per year.

StringIntMap - Class in sirius.db.mixing.types

Provides a map of String to int as property value.

StringIntMap() - Constructor for class sirius.db.mixing.types.StringIntMap

StringIntMapProperty - Class in sirius.db.mixing.properties

Represents an StringIntMap field within a Mixable.

StringIntMapProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

StringList - Class in sirius.db.mixing.types

Provides a simple list of strings as property value.

StringList() - Constructor for class sirius.db.mixing.types.StringList

StringListMap - Class in sirius.db.mixing.types

Provides a map of string to list of strings as property value.

StringListMap() - Constructor for class sirius.db.mixing.types.StringListMap

StringListMapProperty - Class in sirius.db.mixing.properties

Represents an StringListMap field within an ElasticEntity or MongoEntity.

StringListMapProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

StringListProperty - Class in sirius.db.mixing.properties

Represents a StringList field within a Mixable.

StringListProperty(EntityDescriptor, AccessPath, Field) - Constructor for class sirius.db.mixing.properties.StringListProperty

StringListProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

StringLocalDateTimeMap - Class in sirius.db.mixing.types

Represents map of String pointing to LocalDateTime values.

StringLocalDateTimeMap() - Constructor for class sirius.db.mixing.types.StringLocalDateTimeMap

StringLocalDateTimeMapProperty - Class in sirius.db.mixing.properties

Represents an StringLocalDateTimeMap field within a Mixable.

StringLocalDateTimeMapProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

StringMap - Class in sirius.db.mixing.types

Provides a simple string-string map as property value.

StringMap() - Constructor for class sirius.db.mixing.types.StringMap

StringMapProperty - Class in sirius.db.mixing.properties

Represents an StringMap field within an ElasticEntity or a MongoEntity.

StringMapProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

StringNestedMap<N extends Nested> - Class in sirius.db.mixing.types

Represents map of String pointing to Nested values.

StringNestedMap(Class<N>) - Constructor for class sirius.db.mixing.types.StringNestedMap

Creates a new instance capable of storing the given nested type.

StringNestedMapProperty - Class in sirius.db.mixing.properties

Represents an StringList field within a MongoEntity.

StringNestedMapProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

StringProperty - Class in sirius.db.mixing.properties

Represents an String field within a Mixable.

StringProperty.Factory - Class in sirius.db.mixing.properties

Factory for generating properties based on their field type

SUBFIELD_SEPARATOR - Static variable in class sirius.db.mixing.Mapping

Used to join several field names (e.g. for composites or mixins).

Subscriber - Interface in sirius.db.redis

Subscribes to a publish/subscribe topic which uses redis for one to many communication.

T

Table - Class in sirius.db.jdbc.schema

Represents a database table.

Table(EntityDescriptor) - Constructor for class sirius.db.jdbc.schema.Table

Table() - Constructor for class sirius.db.jdbc.schema.Table

TableColumn - Class in sirius.db.jdbc.schema

Represents a column of a database table.

TableColumn() - Constructor for class sirius.db.jdbc.schema.TableColumn

Creates a new table column.

TableColumn(Property, int) - Constructor for class sirius.db.jdbc.schema.TableColumn

Creates a new table column which is pre-initialized with the given property and type.

temporaryDB - Variable in class sirius.db.mongo.Mongo

text(String) - Method in class sirius.db.mongo.constraints.MongoFilterFactory

Executes a $text search in the underlying fulltext index.

thisMonth() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the current month.

thisWeek() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on this week.

thisYear() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on the current year.

today() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on "today".

toJSON() - Method in class sirius.db.es.constraints.ElasticConstraint

toJSON(EntityDescriptor, ElasticEntity, JSONObject) - Method in class sirius.db.es.Elastic

Transforms the given entity to JSON.

toString() - Method in enum sirius.db.es.annotations.ESOption

toString() - Method in class sirius.db.es.ElasticQuery

toString() - Method in class sirius.db.jdbc.batch.BatchContext

toString() - Method in class sirius.db.jdbc.batch.BatchQuery

toString() - Method in class sirius.db.jdbc.Database

toString() - Method in class sirius.db.jdbc.Row

toString() - Method in class sirius.db.jdbc.schema.ForeignKey

toString() - Method in class sirius.db.jdbc.schema.Key

toString() - Method in class sirius.db.jdbc.schema.SchemaUpdateAction

toString() - Method in class sirius.db.jdbc.schema.Table

toString() - Method in class sirius.db.jdbc.schema.TableColumn

toString() - Method in class sirius.db.jdbc.SmartQuery.Compiler

toString() - Method in class sirius.db.jdbc.SmartQuery

toString() - Method in class sirius.db.jdbc.SQLCall

toString() - Method in class sirius.db.jdbc.SQLQuery

toString() - Method in class sirius.db.jdbc.TransformedQuery

toString() - Method in class sirius.db.mixing.BaseEntity

toString() - Method in class sirius.db.mixing.DateRange

toString() - Method in class sirius.db.mixing.EntityDescriptor

toString() - Method in class sirius.db.mixing.Mapping

toString() - Method in class sirius.db.mixing.Property

toString() - Method in class sirius.db.mixing.query.constraints.Constraint

toString() - Method in class sirius.db.mixing.query.QueryTag

toString() - Method in class sirius.db.mixing.types.SafeList

toString() - Method in class sirius.db.mongo.Doc

toString() - Method in class sirius.db.mongo.MongoQuery

toString() - Method in class sirius.db.mongo.QueryBuilder

toString() - Method in class sirius.db.mongo.types.MultiPointLocation

traceData - Variable in class sirius.db.mongo.Mongo

traceIfRequired(String, Watch) - Method in class sirius.db.mongo.QueryBuilder

traceLimit - Variable in class sirius.db.mongo.Mongo

tracing - Variable in class sirius.db.mongo.Mongo

transferFilters(QueryBuilder<?>) - Method in class sirius.db.mongo.QueryBuilder

Applies all filters of this query to the given target.

transferOption(String, Optional<IndexMode>, Function<IndexMode, ESOption>, JSONObject) - Method in interface sirius.db.es.ESPropertyInfo

Transfers the given option which (via IndexMode) to the mapping.

transform(Class<E>, SQLQuery) - Method in class sirius.db.jdbc.OMA

Transforms a plain SQLQuery to directly return entities of the given type.

transform(Class<E>, String, SQLQuery) - Method in class sirius.db.jdbc.OMA

Same as OMA.transform(Class, SQLQuery) but with support for aliased columns.

transform(Object) - Method in class sirius.db.mixing.query.constraints.FilterFactory

Transforms a given value into the representation expected by the database.

TransformedQuery<E extends SQLEntity> - Class in sirius.db.jdbc

A transformed query converts a plain SQLQuery into one that returns entities rather than rows.

TransformedQuery(EntityDescriptor, String, SQLQuery) - Constructor for class sirius.db.jdbc.TransformedQuery

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.AmountProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.BooleanProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.EnumProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.IntegerProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.LongProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.properties.NestedListProperty

transformFromDatasource(Class<? extends BaseMapper<?, ?, ?>>, Value) - Method in class sirius.db.mixing.Property

Converts the database value to the appropriate field value.

transformFromElastic(Value) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

transformFromElastic(Value) - Method in class sirius.db.mixing.properties.LocalDateProperty

transformFromElastic(Value) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

transformFromElastic(Value) - Method in class sirius.db.mixing.properties.StringListProperty

transformFromElastic(Value) - Method in class sirius.db.mixing.properties.StringLocalDateTimeMapProperty

transformFromElastic(Value) - Method in class sirius.db.mixing.properties.StringMapProperty

transformFromElastic(Value) - Method in class sirius.db.mixing.Property

Loads a value from an Elasticsearch database.

transformFromJDBC(Value) - Method in class sirius.db.mixing.properties.InstantProperty

transformFromJDBC(Value) - Method in class sirius.db.mixing.properties.LocalDateProperty

transformFromJDBC(Value) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

transformFromJDBC(Value) - Method in class sirius.db.mixing.properties.LocalTimeProperty

transformFromJDBC(Value) - Method in class sirius.db.mixing.Property

Loads a value from a JDBC datasource.

transformFromMongo(Value) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

transformFromMongo(Value) - Method in class sirius.db.mixing.properties.LocalDateProperty

transformFromMongo(Value) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

transformFromMongo(Value) - Method in class sirius.db.mixing.properties.StringListProperty

transformFromMongo(Value) - Method in class sirius.db.mixing.properties.StringLocalDateTimeMapProperty

transformFromMongo(Value) - Method in class sirius.db.mixing.properties.StringMapProperty

transformFromMongo(Value) - Method in class sirius.db.mixing.properties.StringNestedMapProperty

transformFromMongo(Value) - Method in class sirius.db.mixing.Property

Loads a value from a MongoDB datasource.

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.AmountProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.EnumProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.IntegerProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.LongProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.NestedListProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.StringIntMapProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.properties.StringProperty

transformToDatasource(Class<? extends BaseMapper<?, ?, ?>>, Object) - Method in class sirius.db.mixing.Property

Converts the Java object which resides in the associated field to the database value which is to be written into the database.

transformToElastic(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

transformToElastic(Object) - Method in class sirius.db.mixing.properties.BooleanProperty

transformToElastic(Object) - Method in class sirius.db.mixing.properties.LocalDateProperty

transformToElastic(Object) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

transformToElastic(Object) - Method in class sirius.db.mixing.properties.StringListProperty

transformToElastic(Object) - Method in class sirius.db.mixing.properties.StringLocalDateTimeMapProperty

transformToElastic(Object) - Method in class sirius.db.mixing.properties.StringMapProperty

transformToElastic(Object) - Method in class sirius.db.mixing.Property

Generates a value for an Elasticsearch database.

transformToJDBC(Object) - Method in class sirius.db.mixing.properties.BooleanProperty

transformToJDBC(Object) - Method in class sirius.db.mixing.properties.InstantProperty

transformToJDBC(Object) - Method in class sirius.db.mixing.properties.LocalDateProperty

transformToJDBC(Object) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

transformToJDBC(Object) - Method in class sirius.db.mixing.properties.LocalTimeProperty

transformToJDBC(Object) - Method in class sirius.db.mixing.Property

Generates a value for a JDBC datasource.

transformToMongo(Object) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.BooleanProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.LocalDateProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.StringListMapProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.StringListProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.StringLocalDateTimeMapProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.StringMapProperty

transformToMongo(Object) - Method in class sirius.db.mixing.properties.StringNestedMapProperty

transformToMongo(Object) - Method in class sirius.db.mixing.Property

Generates a value for a MongoDB datasource.

transformValue(Value) - Method in class sirius.db.mixing.properties.AmountProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.BaseEntityRefListProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.BaseEntityRefProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.BaseMapProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.BooleanProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.EnumProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.InstantProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.IntegerProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.LocalDateProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.LocalDateTimeProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.LocalTimeProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.LongProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.MultiPointLocationProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.NestedListProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.StringListProperty

transformValue(Value) - Method in class sirius.db.mixing.properties.StringProperty

transformValue(Value) - Method in class sirius.db.mixing.Property

Converts the given value, which most probably contains user input as string into the target type of this property.

Transient - Annotation Type in sirius.db.mixing.annotations

Fields marked with this annotation are not transformed into a property.

translateColumnName(String) - Method in class sirius.db.jdbc.schema.BasicDatabaseDialect

translateColumnName(String) - Method in interface sirius.db.jdbc.schema.DatabaseDialect

Converts the name (casing) to the one, used by the DB.

translateColumnName(Mapping) - Method in class sirius.db.jdbc.SmartQuery.Compiler

Translates a column name into an effective name by applying aliases and rewrites.

TranslationState - Class in sirius.db.jdbc

Keeps track of the internal JOIN and column translation state of a SmartQuery.Compiler.

TranslationState(EntityDescriptor, String, StringBuilder, Map<String, Tuple<String, EntityDescriptor>>) - Constructor for class sirius.db.jdbc.TranslationState

Trim - Annotation Type in sirius.db.mixing.annotations

Marks a string property as auto trimmed.

truncate() - Method in class sirius.db.es.ElasticQuery

truncate() - Method in class sirius.db.jdbc.SmartQuery

truncate() - Method in class sirius.db.mixing.query.Query

Deletes all matches using the capabilities of the underlying database.

truncate() - Method in class sirius.db.mongo.MongoQuery

tryAs(Class<A>) - Method in class sirius.db.mixing.Mixable

tryCommit(boolean) - Method in class sirius.db.jdbc.batch.BatchQuery

tryDelete(ElasticEntity) - Method in class sirius.db.es.BulkContext

Queues an BaseMapper.tryDelete(BaseEntity) in the batch context.

tryDelete(E) - Method in class sirius.db.mixing.BaseMapper

Tries to delete the entity from the database.

tryLock(String, Duration, Duration) - Method in class sirius.db.redis.Redis

Tries to acquire the given lock in the given timeslot.

tryLocked(String, Duration, Duration, Runnable) - Method in class sirius.db.redis.Redis

Boilerplate method to perform the given task while holding the given lock.

tryRefresh(E) - Method in class sirius.db.mixing.BaseMapper

Tries to fetch a fresh (updated) instance of the given entity from the database.

tryUpdate(ElasticEntity) - Method in class sirius.db.es.BulkContext

Queues an BaseMapper.tryUpdate(BaseEntity) in the batch context.

tryUpdate(E) - Method in class sirius.db.mixing.BaseMapper

Tries to perform an BaseMapper.update(BaseEntity) of the given entity.

ttl - Variable in class sirius.db.redis.Redis.LockInfo

The maximal time to live of the lock.

tuneStatement(PreparedStatement, Limit, boolean) - Method in class sirius.db.jdbc.SmartQuery

type - Variable in class sirius.db.jdbc.batch.BatchQuery

type - Variable in class sirius.db.mixing.EntityDescriptor

Contains the entity class

type - Variable in class sirius.db.mixing.types.BaseEntityRef

type - Variable in class sirius.db.mixing.types.BaseEntityRefList

U

Unique - Annotation Type in sirius.db.mixing.annotations

Marks a property as unique.

unlock(String) - Method in class sirius.db.redis.Redis

Releases the lock.

unlock(String, boolean) - Method in class sirius.db.redis.Redis

Releases the given lock.

unregister(BatchQuery<?>) - Method in class sirius.db.jdbc.batch.BatchContext

unset(Mapping) - Method in class sirius.db.mongo.Updater

Unsets a field.

unset(String) - Method in class sirius.db.mongo.Updater

Unsets a field.

update(E, boolean, boolean) - Method in class sirius.db.jdbc.batch.UpdateQuery

Updates the given entity in the database by comparing the mappings to compare and updating the mappings to update.

update(E) - Method in class sirius.db.mixing.BaseMapper

Writes the contents of the given entity to the database.

update() - Method in class sirius.db.mongo.Mongo

Returns a fluent query builder to update one or more documents in the database

updateByIdQuery(Class<E>, Mapping...) - Method in class sirius.db.jdbc.batch.BatchContext

Creates a new update query which uses SQLEntity.ID as mapping to compare.

updateDiscriminatorTable(EntityDescriptor, Property) - Method in class sirius.db.es.Elastic

updateEntity(ElasticEntity, boolean, EntityDescriptor) - Method in class sirius.db.es.Elastic

updateEntity(SQLEntity, boolean, EntityDescriptor) - Method in class sirius.db.jdbc.OMA

updateEntity(B, boolean, EntityDescriptor) - Method in class sirius.db.mixing.BaseMapper

Updates an existing entity in the underlying database.

updateEntity(MongoEntity, boolean, EntityDescriptor) - Method in class sirius.db.mongo.Mango

updateQuery(Class<E>, Mapping...) - Method in class sirius.db.jdbc.batch.BatchContext

Creates a new update query.

UpdateQuery<E extends SQLEntity> - Class in sirius.db.jdbc.batch

Represents a batch query which updates an entity in the database.

UpdateQuery(BatchContext, Class<E>, String[]) - Constructor for class sirius.db.jdbc.batch.UpdateQuery

Updater - Class in sirius.db.mongo

Fluent builder to build an update statement.

Updater(Mongo) - Constructor for class sirius.db.mongo.Updater

updateRouteTable(EntityDescriptor, Property) - Method in class sirius.db.es.Elastic

updateSchemaAtStartup() - Method in class sirius.db.jdbc.schema.Schema

uppercaseValues - Variable in class sirius.db.mixing.query.constraints.CSVFilter

uppercaseValues() - Method in class sirius.db.mixing.query.constraints.CSVFilter

Signals that this constraint should convert the values to uppercase before being applied

upsert() - Method in class sirius.db.mongo.Updater

Specifies that a new document should be created if the update filter does not match anything.

useLocalDate() - Method in class sirius.db.mixing.DateRange

Can be used if the DateRange should be used on a database field of type LocalDate and not LocalDateTime.

V

validate(B) - Method in class sirius.db.mixing.BaseMapper

Executes all validation handlers on the given entity.

validate(Object) - Method in class sirius.db.mixing.EntityDescriptor

Executes all validation handlers on the given entity.

validateHandlers - Variable in class sirius.db.mixing.EntityDescriptor

A list of all handlers to be executed once an entity is validated

VALUE - Static variable in class sirius.db.mixing.properties.StringMapProperty

Contains the name of the field used to store the map value

value - Variable in class sirius.db.mixing.types.BaseEntityRef

value - Variable in class sirius.db.redis.Redis.LockInfo

The current value of the lock which can be used to determine who holds the lock

valueNeedsCopy() - Method in class sirius.db.mixing.types.BaseEntityRefList

valueNeedsCopy() - Method in class sirius.db.mixing.types.NestedList

valueNeedsCopy() - Method in class sirius.db.mixing.types.SafeList

Determines if values in this list must be copied if the list is copied.

valueNeedsCopy() - Method in class sirius.db.mixing.types.SafeMap

Determines if values in this map must be copied if the map is copied.

valueNeedsCopy() - Method in class sirius.db.mixing.types.StringIntMap

valueNeedsCopy() - Method in class sirius.db.mixing.types.StringList

valueNeedsCopy() - Method in class sirius.db.mixing.types.StringListMap

valueNeedsCopy() - Method in class sirius.db.mixing.types.StringLocalDateTimeMap

valueNeedsCopy() - Method in class sirius.db.mixing.types.StringMap

valueNeedsCopy() - Method in class sirius.db.mixing.types.StringNestedMap

valueNeedsCopy() - Method in class sirius.db.mongo.types.MultiPointLocation

valueOf(String) - Static method in enum sirius.db.es.annotations.Analyzed.IndexOption

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum sirius.db.es.annotations.ESOption

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum sirius.db.jdbc.Capability

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum sirius.db.mixing.query.constraints.CSVFilter.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum sirius.db.mixing.query.QueryField.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum sirius.db.mixing.types.BaseEntityRef.OnDelete

Returns the enum constant of this type with the specified name.

values() - Static method in enum sirius.db.es.annotations.Analyzed.IndexOption

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum sirius.db.es.annotations.ESOption

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum sirius.db.jdbc.Capability

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum sirius.db.mixing.query.constraints.CSVFilter.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values - Variable in class sirius.db.mixing.query.constraints.OneInField

values() - Static method in enum sirius.db.mixing.query.QueryField.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum sirius.db.mixing.types.BaseEntityRef.OnDelete

Returns an array containing the constants of this enum type, in the order they are declared.

version - Variable in class sirius.db.mixing.BaseEntity

VERSION - Static variable in class sirius.db.mixing.BaseMapper

Contains the name of the version column used for optimistic locking.

Versioned - Annotation Type in sirius.db.mixing.annotations

Marks an entity as versioned and therefore elibile for optimitic locking

versioned - Variable in class sirius.db.mixing.EntityDescriptor

W

where(ElasticConstraint) - Method in class sirius.db.es.constraints.NestedQuery

Appends an inner constraint.

where(ElasticConstraint) - Method in class sirius.db.es.ElasticQuery

where(SQLConstraint) - Method in class sirius.db.jdbc.constraints.Exists

Adds an additional constraint to further filter the entities which must or must not exist.

where(SQLConstraint) - Method in class sirius.db.jdbc.SmartQuery

where(C) - Method in class sirius.db.mixing.query.Query

Applies the given contraints to the query.

where(MongoConstraint) - Method in class sirius.db.mongo.MongoQuery

where(Mapping, Object) - Method in class sirius.db.mongo.QueryBuilder

Adds a condition which determines which documents should be selected.

where(String, Object) - Method in class sirius.db.mongo.QueryBuilder

Adds a condition which determines which documents should be selected.

where(MongoConstraint) - Method in class sirius.db.mongo.QueryBuilder

Adds a complex filter which determines which documents should be selected.

withCustomBatchLimit(int) - Method in class sirius.db.jdbc.batch.BatchQuery

Specifies a custom batch size for this query.

withUpdatedMappings(Mapping...) - Method in class sirius.db.jdbc.batch.UpdateQuery

Specifies the list of mappings to update.

withUpdatedMappings(String...) - Method in class sirius.db.jdbc.batch.UpdateQuery

Specifies the list of mappings to update.

writeBlobToParameter(String, Blob) - Method in class sirius.db.jdbc.BaseSQLQuery

writeBlobToParameter(String, Blob) - Method in class sirius.db.jdbc.batch.BatchSQLQuery

writeBlobToParameter(String, Blob) - Method in class sirius.db.jdbc.SQLQuery

writeParameters(CallableStatement) - Method in class sirius.db.jdbc.SQLCall

Y

yearlyIndexExists(String) - Method in class sirius.db.es.IndexMappings

Determines if the given yearly index exists.

years(int...) - Method in class sirius.db.es.ElasticQuery

Specifies which years to query for entities which are stored per year.

yearsFromTo(int, int) - Method in class sirius.db.es.ElasticQuery

Specifies a range of years to query for entities which are stored per year.

yesterday() - Static method in class sirius.db.mixing.DateRange

Creates a date range filtering on "yesterday".

A B C D E F G H I J K L M N O P Q R S T U V W Y