SoftDeleteWithBooleanFeature
#updateBy post-execution handler.
#updateBy post-execution handler.
#updateBy post-execution handler.
#updateBy post-execution handler.
#updateBy post-execution handler.
#updateBy post-execution handler.
#updateBy pre-execution handler.
#updateBy pre-execution handler.
#updateBy pre-execution handler.
#updateBy pre-execution handler.
#updateBy pre-execution handler.
#updateBy pre-execution handler.
Entities finder builder.
Entities finder builder.
mapper
registered conditions
limit
offset
Select query builder.
Select query builder.
Update query builder/executor.
Update query builder/executor.
Returns default table alias.
Returns default table alias. This method is abstract and should be implemented with unique name. override def defaultAlias = createAlias("sm")
Extracts entity from ResultSet.
Extracts entity from ResultSet.
Returns actual value from identity value.
Returns identity value from raw value.
Returns identity value from raw value.
raw value
identity value
Adds new attribute to be inserted when creation.
Adds new attribute to be inserted when creation.
named value
self
#createWithNamedValues post-execution.
Registered afterUpdateByHandlers.
Registered afterUpdateByHandlers.
#deleteBy post-execution.
Registered afterUpdateByHandlers.
Registered afterUpdateByHandlers.
Registers #updateBy post-execution handler.
Registers #updateBy post-execution handler.
event handler
Registered afterUpdateByHandlers.
Registered afterUpdateByHandlers.
Applies includes operations to query result.
Applies includes operations to query result.
entity
session
repository
entity with included attributes
Applies includes operations to query results.
Applies includes operations to query results.
entities
session
repository
entities with included attributes
Extracts entity from ResultSet.
Extracts entity from ResultSet.
Extracts entity from ResultSet.
Extracts entity from ResultSet.
Associations
Associations
AutoSession definition.
AutoSession definition.
Calculates average of a column.
Calculates average of a column.
#createWithNamedValues pre-execution.
Registered beforeUpdateByHandlers.
Registered beforeUpdateByHandlers.
#deleteBy pre-execution.
Registered beforeUpdateByHandlers.
Registered beforeUpdateByHandlers.
Registers #updateBy pre-execution handler.
Registers #updateBy pre-execution handler.
event handler
Registered beforeUpdateByHandlers.
Registered beforeUpdateByHandlers.
Returns a query part which represents primary key search condition.
Returns a query part which represents primary key search condition.
primary key
query part
Calculates rows.
Calculates rows.
Returns column names.
Returns column names.
Returns connection pool.
Returns actual value from identity value.
Returns actual value from identity value.
actual value type
identity
actual value
Count only.
Count only.
Counts all rows by condition.
Counts all rows by condition.
Creates a new table alias for this mapper.
Creates a new table alias for this mapper.
Creates a new join definition.
Creates a new join definition.
join type
left mapper and table alias
right mapper and table alias
join condition
join definition
Creates a new entity with non-permitted parameters.
Creates a new entity with non-permitted parameters.
CAUTION: If you use this method in some web apps, you might have mass assignment vulnerability.
parameters
db session
created count
Creates a new entity with named values.
Creates a new entity with named values.
named values
db session
created count
Creates a new entity with permitted strong parameters.
Creates a new entity with permitted strong parameters.
permitted parameters
db session
created count
Join definitions that are enabled by default.
Join definitions that are enabled by default.
Default ordering condition.
Default ordering condition.
Returns default scope for select queries.
Returns default scope for select queries.
Returns default scope for update/delete operations.
Returns default scope for update/delete operations.
default scope
Returns th default select query builder for this mapper.
Returns th default select query builder for this mapper.
select query builder
Deletes all entities.
Deletes all entities.
Deletes entities by condition.
Deletes entities by condition.
condition
db session
deleted count
Deletes a single entity by primary key.
Deletes a single entity by primary key.
primary key
db session
deleted count
Counts distinct rows.
Counts distinct rows.
One-to-Many relationship definition.
One-to-Many relationship definition.
object Member extends RelationshipFeature[Member] { oneToMany[Group]( mapper = Group, merge = (m, c) => m.copy(company = c) ) }
Creates an extractor for this query.
Creates an extractor for this query.
sql object
belongsTo associations
hasOne associations
hasMany associations
sql object
Extracts entity with one-to-one tables.
Extracts entity with one-to-one tables.
result set
belongsTo extractors
hasOne extractors
entity
Finds all entities.
Finds all entities.
Finds all entities by condition.
Finds all entities by condition.
Finds all entities by several primary keys.
Finds all entities by several primary keys.
Finds all entities by condition and with pagination.
Finds all entities by condition and with pagination.
Finds all entities by condition and with pagination.
Finds all entities by condition and with pagination.
Finds all entities with pagination.
Finds all entities with pagination.
Finds all entities with pagination.
Finds all entities with pagination.
Finds an entity by condition.
Finds an entity by condition.
Finds a single entity by primary key.
Finds a single entity by primary key.
Generates auto-generated new Id.
Returns typed value from a strong parameter.
Returns typed value from a strong parameter.
field name
actual value
param type definition
typed value if exists
Adds includes conditions.
Adds includes conditions.
associations
extended self
is deleted flag field name.
is deleted flag field name.
Predicates the field name is valid.
Predicates the field name is valid.
Appends join definition on runtime.
Appends join definition on runtime.
associations
self
Appends limit part.
Calculates minimum value of a column.
Calculates minimum value of a column.
Merges already registered attributes to be inserted and parameters.
Merges already registered attributes to be inserted and parameters.
named values
merged attributes
Calculates minimum value of a column.
Calculates minimum value of a column.
Extracts named values from the permitted parameters.
Extracts named values from the permitted parameters.
permitted parameters
named values
Appends offset part.
Appends pagination settings as limit/offset.
Appends pagination settings as limit/offset.
pagination
query builder
Returns primary key name.
Returns primary key name. (default: "id") Notice: Not a column name but field name. For example, not "first_name" but "firstName"
Returns a select query builder that all associations are joined.
Returns a select query builder that all associations are joined.
sql object
belongsTo associations
hasOne associations
hasMany associations
select query builder
Returns select query builder object to simply fetch rows without other joined tables.
Returns select query builder object to simply fetch rows without other joined tables.
Calculates sum of a column.
Calculates sum of a column.
Returns table name.
Returns table name.
Expects mapper's name + primary key name by default.
Expects mapper's name + primary key name by default.
enitty type
mapper
fk name
Returns update query builder with condition.
Returns update query builder with condition.
where condition
update query builder
Updates entities with parameters.
Updates entities with parameters.
primary key
parameters
updated count
Returns update query builder with primary key.
Returns update query builder with primary key.
primary key
update query builder
Primary key should be Database's auto-increment value if true.
Primary key should be Database's auto-increment value if true.
Primary key generation should be done by #generateNewId if true.
Primary key generation should be done by #generateNewId if true.
Appends a raw where condition.
Appends a raw where condition.
query builder
Appends where conditions.
Provides a code block with a table alias.
Provides a code block with a table alias.
Provides a code block with a table alias.
Provides a code block with a table alias.
Provides a code block with the column name provider.
Provides a code block with the column name provider.
Replaces table name on runtime.
Replaces table name on runtime.
table name
self
#createWithNamedValues post-execution.
#createWithNamedValues post-execution.
named values
generated id
(Since version 1.3.12) Use afterCreate(handler) instead
#deleteBy post-execution.
#deleteBy post-execution.
condition
deleted count
count
(Since version 1.3.12) Use afterDeleteBy(handler) instead
#createWithNamedValues pre-execution.
#createWithNamedValues pre-execution.
named values
(Since version 1.3.12) Use beforeCreate(handler) instead
#deleteBy pre-execution.
#deleteBy pre-execution.
condition
(Since version 1.3.12) Use beforeDeleteBy(handler) instead
(Since version 1.0.0) Use #findAllByWithLimitOffset or #findAllByWithPagination instead. This method will be removed since version 1.1.0.
(Since version 1.0.0) Use #findAllWithLimitOffset or #findAllWithPagination instead. This method will be removed since version 1.1.0.
Soft delete with boolean value.
entity