Package com.github.susom.database

Interface Summary

Interface	Description
Config	Entry point for getting configuration parameters.
ConfigFrom	Pull configuration properties from various sources and filter/manipulate them.
Database	Primary class for accessing a relational (SQL) database.
DatabaseMock	Convenience class to intercept calls to Connection and return stubbed results for testing purposes.
DatabaseProvider.Builder	This builder is immutable, so setting various options does not affect the previous instance.
DatabaseProviderVertx.Builder	This builder is immutable, so setting various options does not affect the previous instance.
DbCode	A block of runnable code using a transacted Database.
DbCodeTx	A block of runnable code using a transacted Database.
DbCodeTyped<T>	A block of runnable code using a transacted Database.
DbCodeTypedTx<T>	A block of runnable code using a transacted Database.
Ddl	Interface for executing a chunk of DDL within the database.
Options	Control various optional behavior for the database interactions.
Row	Interface for reading results from a database query.
RowHandler<T>	Type-safe callback to read query results.
Rows	Interface for reading results from a database query.
RowsHandler<T>	Type-safe callback to read query results.
SqlInsert	Interface for configuring (setting parameters) and executing a chunk of SQL.
SqlInsert.Apply
SqlSelect	Interface for configuring (setting parameters) and executing a chunk of SQL.
SqlSelect.Apply
SqlUpdate	Interface for configuring (setting parameters) and executing a chunk of SQL.
SqlUpdate.Apply	Call this between setting rows of parameters for a SQL statement.
Transaction	Allow customization of the transaction behavior.

Class Summary

Class	Description
ConfigFromImpl	Access configuration properties from a variety of standard sources, and provide some basic filtering and mapping of property keys.
ConfigImpl	This class handles all of the type conversions, default values, etc.
DatabaseImpl	Primary class for accessing a relational (SQL) database.
DatabaseProvider	This is a lazy provider for Database instances.
DatabaseProvider.Pool
DatabaseProviderVertx	This is a lazy provider for Database instances.
DdlImpl	This is the key class for configuring (query parameters) and executing a database query.
DebugSql	Convenience class to substitute real values into a database query for debugging, logging, etc.
Metric	This class provides explicit instrumentation functionality.
MixedParameterSql	Convenience class to allow use of (:mylabel) for SQL parameters in addition to positional (?) parameters.
MixedParameterSql.RewriteArg
OptionsDefault	Control various optional behavior for the database interactions.
OptionsOverride	Base class for selectively overriding another Options object.
RowStub	Convenience for specifying hard-coded values for the Rows object.
Schema	Java representation of a database schema with the various things it can contain.
Sql	This class is useful for dynamically generating SQL.
SqlArgs	This class is useful for dynamically generating SQL.
SqlArgs.Builder
SqlInsertImpl	This is the key class for configuring (query parameters) and executing a database query.
SqlSelectImpl	This is the key class for configuring (query parameters) and executing a database query.
SqlUpdateImpl	This is the key class for configuring (query parameters) and executing a database query.
StatementAdaptor	Deal with mapping parameters into prepared statements.
TransactionImpl	Simple bean representing how the database transaction should behave in terms of commit/rollback.
VertxUtil	This is a convenience class to work-around issues with using the SLF4J MDC class.
When	Convenience for conditional SQL generation.

Enum Summary

Enum	Description
Flavor	Enumeration of supported databases with various compatibility settings.
Schema.ColumnType
Sql.ColumnType
SqlArgs.ColumnType

Exception Summary

Exception	Description
ConfigInvalidException	Indicates that a configuration value is present but not in a usable format.
ConfigMissingException	Indicates that a configuration value is required but was not present.
ConstraintViolationException	This exception will be thrown when a condition arises that violates a stated invariant regarding the database.
DatabaseException	Indicates something went wrong accessing the database.
QueryTimedOutException	Thrown when a query is interrupted because a timeout was exceeded or it was explicitly cancelled.
WrongNumberOfRowsException	Thrown when inserting/updating rows and the actual number of rows modified does not match the expected number of rows.