All Classes and Interfaces
Class
Description
An abstract base class for queries that create database resources.
A skeletal implementation of the
IdGenerator interface.A skeletal implementation of the
JdbcLogger interface.A skeletal implementation for the
JdbcType interface .A generator that generates an identity value before an execution of insert.
The base abstract class for all query implementations.
A JDBC type for RDBMS specific SQL type and
ResultSet.The base abstract class for all select query implementations.
A skeletal implementation of the
Sql interface.A skeletal implementation of the
SqlFileRepository interface.A skeletal implementation for the
Wrapper interface .Defines access levels in the Java language.
The AggregateCommand class represents a command designed to execute an aggregate operation on a
stream of entities and return a result.
Indicates a strategy for aggregating database records into hierarchical entity structures.
Represents a strategy type for defining an aggregate structure that involves a root entity and
its associated entities.
Used to add an alias to a column in the select clause.
The
AliasManager class is responsible for managing alias mappings for entity and property
metamodels.Indicates that a generated code that implements the annotated interface is annotated with some
annotations.
Used in conjunction with the
AnnotateWith annotation to indicate which kind of annotation
is specified for generated code.Defines the locations where annotations may appear in Java code.
A query implementation for creating a SQL array.
Indicates a method that creates an
Array instance for use with SQL array types.A JDBC type for
Types.ARRAY and Array.A wrapper for the
Array class.Represents a property in an entity class that is used as a primary key with an
application-assigned value.
Indicates an association relationship between entities.
Handles the iteration of
AssociationEntityPool results from a query execution and manages
the creation and configuration of object providers used to process the results.Indicates the execution of associations between entities.
Represents an association linker that connects two entity types based on a property path.
Represents the option about the associate and associateWith operators.
Represents a property that defines an association between entity classes.
An auto batch delete query that is executed against an entity class.
The context class for post-delete processing in batch operations.
The context class for pre-delete processing in batch operations.
An auto batch insert query that is executed against an entity class.
The context class for post-insert batch processing.
The context class for pre-insert batch processing.
An abstract base class for auto batch modification queries.
An auto batch update query that is executed against an entity class.
A context class for post-update processing in batch update operations.
A context class for pre-update processing in batch update operations.
An auto delete query that is executed against an entity class.
Context class for post-delete operations.
Context class for pre-delete operations.
An auto function query that calls a database function.
Defines types for auto generated keys.
A query implementation for automatically inserting an entity into a database table.
A context class for post-insert entity processing.
A context class for pre-insert entity processing.
An abstract base class for queries that automatically modify entities in a database.
An abstract base class for queries that call database modules.
A query implementation for automatically inserting multiple entities into a database table.
A context class for post-insert entity processing.
A context class for pre-insert entity processing.
An auto procedure query that calls a database stored procedure.
A query implementation for automatically updating an entity.
A context class for post-update processing.
A context class for pre-update processing.
A builder that builds an SQL statement for a batch execution.
Indicates a batch delete.
A command to execute a batch delete.
An executor that execute SQL DELETE statements in batches.
An interface for batch DELETE queries.
Indicates a batch insert operation.
A command to execute a batch insert.
An executor that execute SQL INSERT statements in batches.
An interface for batch INSERT queries.
An abstract command for batch modification operations (insert, update, delete).
A query that performs batch operations to modify data in a database.
Thrown to indicate that optimistic locking is failed in a batch processing.
A batch processing result for immutable entities.
Thrown to indicate that a batch processing is failed.
Thrown to indicate that an unique constraint violation occurs in a batch processing.
Indicates a method that performs batch update operations on multiple entities.
A command to execute a batch update.
An executor that execute SQL UPDATE statements in batches.
An interface for batch UPDATE queries.
A helper class for batch update queries.
A JDBC type for
Types.DECIMAL and BigDecimal.A wrapper for the
BigDecimal class.A JDBC type for
Types.BIGINT and BigInteger.A wrapper for the
BigInteger class.A query that creates a BLOB (Binary Large Object) in the database.
Indicates a method that creates a
Blob instance for handling large binary data in the
database.A JDBC type for
Types.BLOB and Blob.A wrapper for the
Blob class.A JDBC type for
Types.BOOLEAN and Boolean.A wrapper for the
Boolean class.Represents that the implementation can build an SQL.
The built-in implementation for
IdentityIdGenerator.The built-in implementation for
SequenceIdGenerator.The built-in implementation for
TableIdGenerator.A JDBC type for
Types.BINARY and byte[].A wrapper for the
byte[] class.A JDBC type for
Types.SMALLINT and Byte.A wrapper for the
Byte class.A callable SQL.
A commenter that appends information about the caller class and the caller method.
A helper for classes.
Deprecated.
Deprecated.
Use the optimized
SqlTokenUtil instead.A query that creates a CLOB (Character Large Object) in the database.
Indicates a method that creates a
Clob instance for handling large text data in the
database.A JDBC type for
Types.CLOB and Clob.A wrapper for the
Clob class.Indicates a database column.
Overrides the column mapping for a specific property within an embeddable object.
Represents the metadata for a database column.
A core interface for executing database operations in the Doma framework.
A factory interface for creating
Command implementation objects.A context for a comment.
A commenter for SQL strings.
A runtime configuration for DAOs (Data Access Objects).
Thrown to indicate that there is an inadequate configuration in a
Config object.A provider for a
Config object.Provides default implementations for the
Config interface.A query that counts the number of rows that would be returned by a SELECT statement.
A command to create a database object.
A query that creates a database resource.
A builder interface for database-specific SQL criteria operations.
Indicates a DAO interface.
Indicates a class that implements a DAO interface.
Indicates that the annotated annotation may be applied to methods of
Dao annotated
interfaces.Thrown to indicate that the DAO method is not found.
Indicates a data type (aka domain class).
A JDBC type for
Types.DATE and Date.A wrapper for the
Date class.A dialect for Db2.
A description for a default property.
The default implementation of
StatisticManager.Indicates a delete operation.
An interface for assembling DELETE queries.
An assembler for delete statements.
A builder for an SQL DELETE statement.
A command that executes DELETE SQL statements.
An interface for DELETE queries.
A command that executes an SQL DELETE statement and retrieves a result set generated from a
RETURNING clause.
Represents the settings for a DELETE criteria query.
A database dialect interface that abstracts differences between various RDBMS implementations.
Represents the option that decides whether to append the DISTINCT keyword or not.
The root exception in the Doma framework.
Thrown to indicate that an argument does not meet the preconditions required by a method.
Indicates a domain class.
A converter interface for mapping between domain objects and their corresponding basic values.
Indicates an aggregation of
DomainConverter classes.A description for a domain type.
A factory for domain descriptions.
Indicates a class that implements a domain type.
Thrown to indicate that the domain description is not found.
Thrown to indicate that an argument is
null and null values are not allowed for this
parameter.A JDBC type for
Types.DOUBLE and Double.A wrapper for the
Double class.Thrown to indicate that a column is duplicated in a result set.
A handler for columns that are duplicated in a result set.
Specifies how to handle duplicate key violations during insert operations.
Indicates a class that can be embedded within an entity class.
Represents the metadata for a class annotated with
Embeddable.Indicates an embedded property.
Represents a property in an entity class that is mapped to an embeddable object.
Represents the metadata for an embedded property within an entity.
Indicates an entity class.
Indicates that an annotated annotation may be applied to fields of
Entity annotated
classes.A callback listener interface that is invoked during entity lifecycle events.
A provider for an
EntityListener object.Exception thrown when access to an entity property fails.
Exception thrown when a property is referenced but not defined in an entity class.
Exception thrown when a property is not found in an entity class.
Describes a property of an entity class that maps to a database column.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
QueryDsl instead.Represents a queryable statement for entities.
Describes metadata for an entity class that maps to a database table.
A factory for entity descriptions.
Indicates an implementation of an entity type.
Exception thrown when an entity type implementation is not found.
A JDBC type for
Types.VARCHAR and Enum.A wrapper for the
Enum class.The aggregation of functions that are available in expressions in SQL templates.
Indicates that an arbitrary class should be handled as if it was a
Domain annotated
class.Deprecated, for removal: This API element is subject to removal in a future version.
Defines how to fetch rows from an SQL SELECT result set.
A wrapper interface for accessing and manipulating object fields.
A JDBC type for
Types.FLOAT and Float.A wrapper for the
Float class.Represents the option that decides whether to append the FOR UPDATE clause or not.
Indicates a stored function call.
A command that executes a database function.
An interface for database function queries.
A property type for entity ID fields whose values are automatically generated.
A visitor implementation that sets an ID value in a number wrapper.
Indicates a strategy to generate identifiers.
Defines strategies to generate identifiers for entity primary keys.
An SQL file repository that caches the results of SQL parsing without limit.
A dialect for H2 version 1.2.126 and below.
A dialect for H2 version 1.4.199 and below.
A dialect for H2 version 1.4.200 and above.
The having declaration.
A dialect for HSQLDB.
Indicates an entity identifier that is mapped to a primary key of a database table.
A generator that uses a database IDENTITY column.
A configuration for the identity generation.
Deprecated.
An identity generator.
Deprecated.
Indicates an IN parameter of stored functions or stored procedures.
Indicates an INOUT parameter for stored functions or stored procedures.
An input parameter.
Indicates an insert operation.
An interface for assembling INSERT queries.
An assembler for insert statements.
A builder for an SQL INSERT statement.
A command that executes INSERT SQL statements.
An interface for INSERT queries.
A command that executes an SQL INSERT statement and retrieves a result set generated from a
RETURNING clause.
Represents a row to be inserted in an INSERT statement.
Represents the settings for an INSERT criteria query.
A JDBC type for
Types.INTEGER and Boolean.A JDBC type for
Types.INTEGER and Integer.A wrapper for the
Integer class.A callback that is invoked from a
ResultSet iteration process.An execution context of
IterationCallback.Thrown to indicate a JDBC related error during database operations.
The logger interface for JDBC related operations in the Doma framework.
An object that is mappable to an SQL type value.
A hint about mapping.
A function that registers output parameters for a callable statement.
An object that converts JDBC data from SQL types to Java types, and vice versa.
A JDBC type provider for a domain type.
Singleton objects of
JdbcType implementation classes.Thrown to indicate that a JDBC related unsupported method is invoked.
A local transaction that keeps a JDBC connection open until the transaction is explicitly
destroyed.
Represents the option about the LIKE operator.
Represents that the implementation can fetch data from database and list them.
A list parameter.
A JDBC type for
Types.TIMESTAMP and LocalDateTime.A wrapper for the
LocalDateTime class.A JDBC type for
Types.DATE and LocalDate.A wrapper for the
LocalDate class.A JDBC type for
Types.TIME and LocalTime.A wrapper for the
LocalTime class.A local transaction.
A context for a local transaction.
A data source for local transactions.
A transaction manager for local transactions.
A JDBC type for
Types.BIGINT and Long.A wrapper for the
Long class.A builder that builds SQL INSERT statements from maps for a batch execution.
A builder that builds an SQL INSERT statement from a map.
A naming convention controller for the keys contained in a
Map<String, Object> object.Defines naming convention rules for the keys contained in a
Map<Object, String> object.Provides support for handling and mapping database result sets to entity properties.
Represents a property mapping for an entity during result set processing.
Represents a combination of an entity type, a property type, and the property path for mapping
between result set columns and properties in an entity.
Defines messages that are displayed to application developers.
A message resource.
Indicates a metamodel class that provides type-safe access to entity properties.
An abstract base class for commands that modify database data (INSERT, UPDATE, DELETE).
A query that modifies data in a database.
An abstract command that executes a SQL statement with a RETURNING clause and retrieves a result
set.
An abstract command that executes database modules such as stored procedures and functions.
A query that calls a database module such as a stored procedure or function.
A dialect for Microsoft SQL Server 2008 and below.
A dialect for Microsoft SQL Server.
Indicates a multi-row insert operation.
Assemble the multi-row insert query interface.
An assembler for multi insert statements.
A processing result for an immutable entities.
A dialect for MySQL.
A naming convention controller.
Defines naming conventions for converting between entity/property names and table/column names.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
QueryDsl instead.A query that creates an NCLOB (National Character Large Object) in the database.
Indicates to create a
NClob instance.A JDBC type for
Types.NCLOB and NClob.A wrapper for the
NClob class.An SQL file repository that does not cache the results of SQL parsing.
Thrown to indicate that the number of fetched column is expected less than or equal to 1, but
actually it is greater than or equal to 2.
Thrown to indicate that the number of fetched rows is expected less than or equal to 1, but
actually it is greater than or equal to 2.
Thrown to indicate that the number of fetched rows is expected more than 0, but actually it is 0.
A JDBC type for
Types.NVARCHAR and String.An entity listener that does nothing.
A wrapper for the
Number class.A visitor for the
NumberWrapper interface.An object provider.
A JDBC type for
Types.OTHER and Object.A wrapper for the
Object class.Thrown to indicate that optimistic locking is failed.
A dialect for Oracle Database 11g and below.
A formatter that converts a
Date object to a date literal.A formatter that converts a
LocalDate object to a date literal.A formatter that converts a
LocalDateTime object to a timestamp literal.A formatter that converts a
LocalTime object to a time literal.A formatter that converts a
Time object to a time literal.A formatter that converts a
Timestamp object to a timestamp literal.A formatter that converts a
Date object to a date literal.A dialect for Oracle Database.
Indicates that the annotated field holds original states of an entity that were fetched from the
database.
Thrown to indicate that the access to the filed that is annotated with
OriginalStates is
failed.An accessor that is access to the field that is annotated with
OriginalStates.Exception thrown when a field annotated with
OriginalStates is not found in an entity.Indicates an OUT parameter for stored functions or stored procedures.
An output parameter.
An iterator that extends an existing
Iterator with padding behavior.Indicates a parameter name for DAO methods.
A JDBC type for
Types.OTHER.A context for post-processing an entity after a delete operation.
A dialect for PostgreSQL.
A context for post-processing an entity after an insert operation.
A context for post-processing an entity after an update operation.
A context for pre-processing an entity before a delete operation.
A context for pre-processing an entity before an insert operation.
A prepared SQL.
A context for pre-processing an entity before an update operation.
A wrapper for the
boolean class.A wrapper for the
byte class.A wrapper for the
double class.A wrapper for the
float class.A wrapper for the
int class.A wrapper for the
long class.A wrapper for the
short class.Indicates a stored procedure call.
A command that executes a stored procedure.
An interface for database stored procedure queries.
Represents a property of an entity class that can be mapped to a database column.
Represents a path to a property within an object graph, composed of one or more segments.
Represents a single segment within a property path that defines how to access a field.
A default property path segment implementation for regular field access.
A property path segment implementation for optional field access.
The base interface for all query types.
A query DSL entry point.
A factory interface for creating
Query implementation objects.An interface representing an operand in a database query.
A parameter operand that contains both a property type and an input parameter.
A property operand that references an entity property.
A visitor interface for
QueryOperand implementations.Represents a pair of query operands.
A reference to a value.
A controller for the transaction whose attribute may be REQUIRES_NEW.
A callback that is executed in a REQUIRES_NEW transaction.
Deprecated.
A processing result for an immutable entity.
A result list parameter.
Thrown to indicate that all properties in an entity are not mapped to columns in a result set.
A result parameter.
Indicates a parameter that receives a result set fetched by stored functions or stored
procedures.
An interface for handling JDBC ResultSet objects and converting them into application-specific
result types.
A functional interface that consumes row index information from a ResultSet.
Indicates that specific properties of an entity should be included or excluded in the context of
a
Dao operation.An interface that represents properties to be returned from database operations.
A class that resolves property names to entity property types for returning clauses.
Thrown to indicate that a save point already exists.
Thrown to indicate that a save point is not found.
Indicates a scope for database operations.
Indicates a database script execution.
A context that corresponds to an SQL block in a script file.
A command to execute SQL scripts.
A SQL statement in a script.
Thrown to indicate that the one of SQL statements in a script file throws an exception.
An interface for loading SQL script files.
Thrown to indicate that a script file is not found.
A query that executes SQL scripts.
Indicates a select operation.
A builder for an SQL SELECT statement.
A command that executes SELECT SQL queries and processes the result sets.
Defines the kinds of pessimistic locking.
The options for an SQL SELECT statement.
An accessor for
SelectOptions.A query for selecting data from a database.
Represents the settings for a SELECT criteria query.
Defines strategies for handling an object that is mapped to a result set.
Indicates an identifier generator that uses a sequence.
A generator that uses a database SEQUENCE.
Represents a set operand.
Represents a set operator.
Represents the settings for a criteria query.
A JDBC type for
Types.SMALLINT and Short.A wrapper for the
Short class.Represents a simplified configuration interface that extends the base
Config interface.A builder interface for creating a
SimpleConfig instance with custom configuration
settings.A simple data source that creates
Connection by using DriverManager.getConnection(String, Properties).A single result parameter.
Represents an executable SQL statement with its parameters and metadata.
Indicates a SQL template for database operations.
A query that performs batch delete operations using SQL statements.
A query that performs batch insert operations using SQL statements.
An abstract base class for SQL-based batch modification queries.
A query that performs batch update operations using SQL statements.
A context for SQL builder settings.
A query that executes a SQL DELETE statement.
Thrown to indicate that the SQL execution is failed.
Defines the causes that skip the SQL execution.
Represents a SQL file that contains SQL statements for database operations.
A query that performs batch delete operations using an external SQL file.
A context for post-delete entity lifecycle callbacks.
A context for pre-delete entity lifecycle callbacks.
A query that performs batch insert operations using an external SQL file.
A context for post-insert entity lifecycle callbacks.
A context for pre-insert entity lifecycle callbacks.
An abstract base class for SQL file-based batch modification queries.
A query that performs batch update operations using an external SQL file.
A context for post-update entity lifecycle callbacks.
A context for pre-update entity lifecycle callbacks.
A query that deletes data from a database using an external SQL file.
A context for post-delete entity lifecycle callbacks.
A context for pre-delete entity lifecycle callbacks.
A query that inserts data into a database using an external SQL file.
A context for post-insert entity lifecycle callbacks.
A context for pre-insert entity lifecycle callbacks.
An abstract base class for SQL file-based data modification queries.
Thrown to indicate that the SQL file is not found.
A repository interface for managing and retrieving
SqlFile instances.A query that executes a SQL script file.
A query that selects data from a database using an external SQL file.
A query that updates data in a database using an external SQL file.
A context for post-update entity lifecycle callbacks.
A context for pre-update entity lifecycle callbacks.
A query that executes a SQL INSERT statement.
A dialect for SQLite.
Defines the types of SQL operations supported by the Doma framework.
The formatter that converts the value to the SQL log format.
A function that converts the
Wrapper values to the SQL log formats.A visitor that converts the
Wrapper values to the SQL log formats.Defines the output formats for SQL logs.
An abstract base class for SQL-based data modification queries.
Represents a node in the parsed SQL statement tree structure.
A visitor interface for traversing and processing
SqlNode objects in the SQL statement
tree.Represents a parameter used in SQL statements.
A visitor interface for processing different types of SQL parameters.
Indicates that the annotated method provides custom processing of SQL statements built from SQL
templates.
A command to process SQL with a custom handler.
A query that processes SQL files.
A query that executes a SQL SELECT statement.
High-performance SQL tokenizer for Doma's two-way SQL processing.
High-performance SQL token character classification utility.
A query that executes a SQL UPDATE statement.
A query that creates a SQLXML object in the database.
Indicates a method that creates a
SQLXML instance for handling XML data in the database.A JDBC type for
Types.SQLXML and SQLXML.A wrapper for the
SQLXML class.A standard implementation of
Dialect.A standard implementation of
ExpressionFunctions.A standard implementation of
ScriptBlockContext.Represents the SQL statement built by the Criteria API.
Represents a statistic of SQL execution.
A manager for statistics.
Represents that the implementation can fetch data from database as a stream and map it to
something.
Provides a mechanism for reducing a stream of entities into a single result.
A JDBC type for
Types.VARCHAR and String.A wrapper for the
String class.Used to suppress specific warning messages during Doma's processing.
Indicates a database table.
Indicates an identifier generator that uses a table.
A generator that uses a database TABLE.
Indicates a field that represents the tenant identifier in a multi-tenant application.
Represents a property in an entity class that is used for multi-tenancy support.
A handler for the column that is duplicated in a result set.
Represents a supplier of results that may throw an exception.
A JDBC type for
Types.TIMESTAMP and Timestamp.A wrapper for the
Timestamp class.A JDBC type for
Types.TIME and Time.A wrapper for the
Time class.Thrown to indicate that a transaction is already begun.
Defines transaction propagation behaviors.
Defines transaction isolation levels.
A transaction manager.
Thrown to indicate that a transaction is not yet begun.
Indicates that the annotated field is not mapped to a database column.
A tuple class that holds two elements of potentially different types.
A tuple class that holds three elements of potentially different types.
A tuple class that holds four elements of potentially different types.
A tuple class that holds five elements of potentially different types.
A tuple class that holds six elements of potentially different types.
Represents a DELETE statement starting point.
Represents an INSERT statement starting point.
Represents a SELECT statement starting point.
Represents a SELECT statement terminal.
Represents an UPDATE statement starting point.
Thrown to indicate that an unique constraint violation occurs.
Thrown to indicate that there is the column that is unknown to an entity.
A handler for columns in a result set that are not mapped to any property in an entity.
Indicates an update operation.
An interface for assembling UPDATE queries.
An assembler for update statements.
A builder for an SQL UPDATE statement.
A command that executes UPDATE SQL statements.
An interface for UPDATE queries.
A command that executes an SQL UPDATE statement and retrieves a result set generated from a
RETURNING clause.
Represents the settings for an UPDATE criteria query.
An interface for assembling upsert queries.
The UpsertAssemblerContext class represents the context for executing an upsert operation in a
database.
Support class for assembling UPSERT SQL statements.
Enum representing different ways to format column names in SQL statements.
Default implementation of UpsertAliasConstants that provides standard alias names.
Enum representing different ways to format table names in SQL statements.
Interface defining constants for table aliases used in UPSERT statements.
Represents a user-defined comparison criteria declaration.
Represents a user-defined expression.
Declaration of UserDefinedExpression
A JDBC type for
Types.TIMESTAMP and Date.A wrapper for the
Date class.A logger that delegates to
Logger.Indicates a version property that is used for optimistic locking.
Represents a property in an entity class that is used for optimistic locking.
A visitor implementation that increments a version value in a number wrapper.
A visitor implementation that sets a version value in a number wrapper.
The where declaration.
A query DSL entry point.
A wrapper for a basic type.
A visitor for the
Wrapper interface.
SqlTokenizerinstead.