English | 简体中文

All Types

NameSummary
org.ktorm.expression.AggregateExpression

Aggregate expression.

org.ktorm.expression.AggregateType

The enum of aggregate functions in a AggregateExpression.

org.ktorm.dsl.AliasRemover

Expression visitor interceptor for removing table aliases, used by Ktorm internally.

org.ktorm.logging.AndroidLoggerAdapter

Adapter Logger implementation integrating android.util.Log with Ktorm.

org.ktorm.expression.ArgumentExpression

Argument expression, wraps an argument passed to the executed SQL.

org.ktorm.dsl.AssignmentsBuilder

Base class of DSL builders, provide basic functions used to build assignments for insert or update DSL.

org.ktorm.schema.BaseTable

Base class of Ktorm's table objects, represents relational tables in the database.

org.ktorm.dsl.BatchInsertStatementBuilder

DSL builder for batch insert statements.

org.ktorm.dsl.BatchUpdateStatementBuilder

DSL builder for batch update statements.

org.ktorm.expression.BetweenExpression

Between expression, check if a scalar expression is in the given range.

org.ktorm.expression.BinaryExpression

Binary expression.

org.ktorm.expression.BinaryExpressionType

Enum for binary expressions.

org.ktorm.schema.BlobSqlType

SqlType implementation represents blob SQL type.

kotlin.Boolean (extensions in package org.ktorm.dsl)
org.ktorm.schema.BooleanSqlType

SqlType implementation represents boolean SQL type.

org.ktorm.support.mysql.BulkInsertExpression

Bulk insert expression, represents a bulk insert statement in MySQL.

org.ktorm.support.postgresql.BulkInsertExpression

Bulk insert expression, represents a bulk insert statement in PostgreSQL.

org.ktorm.support.sqlite.BulkInsertExpression

Bulk insert expression, represents a bulk insert statement in SQLite.

org.ktorm.support.mysql.BulkInsertOrUpdateOnDuplicateKeyClauseBuilder

DSL builder for bulk insert or update on duplicate key clause.

org.ktorm.support.mysql.BulkInsertOrUpdateStatementBuilder

DSL builder for bulk insert or update statements.

org.ktorm.support.postgresql.BulkInsertOrUpdateStatementBuilder

DSL builder for bulk insert or update statements.

org.ktorm.support.sqlite.BulkInsertOrUpdateStatementBuilder

DSL builder for bulk insert or update statements.

org.ktorm.support.mysql.BulkInsertStatementBuilder

DSL builder for bulk insert statements.

org.ktorm.support.postgresql.BulkInsertStatementBuilder

DSL builder for bulk insert statements.

org.ktorm.support.sqlite.BulkInsertStatementBuilder

DSL builder for bulk insert statements.

org.ktorm.schema.BytesSqlType

SqlType implementation represents bytes SQL type.

org.ktorm.database.CachedRowSet

Special implementation of ResultSet, used to hold the query results for Ktorm.

org.ktorm.dsl.CaseWhen

Helper class used to build case-when SQL DSL. See CaseWhenExpression.

org.ktorm.expression.CaseWhenExpression

Case-when expression, represents a SQL case-when clause.

org.ktorm.expression.CastingExpression

Wrap a SQL expression, changing its return type, translated to SQl cast(expr as type).

org.ktorm.schema.Column

Represents database columns.

org.ktorm.expression.ColumnAssignmentExpression

Column assignment expression, represents a column assignment for insert or update statements.

org.ktorm.schema.ColumnBinding

Base class of column bindings. A column might be bound to a simple property, nested properties, or a reference to another table.

org.ktorm.schema.ColumnDeclaring

Common interface of Column and ScalarExpression.

org.ktorm.expression.ColumnDeclaringExpression

Column declaring expression, represents the selected columns in a SelectExpression.

org.ktorm.expression.ColumnExpression

Column expression.

org.ktorm.logging.CommonsLoggerAdapter

Adapter Logger implementation integrating Apache Commons Logging with Ktorm.

org.ktorm.logging.ConsoleLogger

Simple Logger implementation printing logs to the console. While messages at WARN or ERROR levels are printed to System.err, others are printed to System.out.

org.ktorm.support.postgresql.Cube

Represents a box suitable for an indexed search using the cube @> operator. Part of PostgreSQL cube SQL extension. https://www.postgresql.org/docs/9.5/cube.html

org.ktorm.support.postgresql.CubeExpression

Expression class represents PostgreSQL Cube operations.

org.ktorm.support.postgresql.CubeExpressionType

Enum for 'cube' and 'earthdistance' binary operators.

org.ktorm.support.postgresql.CubeSqlType

Represents a Cube by storing 2 n-dimensional points Part of PostgreSQL cube SQL extension. https://www.postgresql.org/docs/9.5/cube.html

org.ktorm.database.Database

The entry class of Ktorm, represents a physical database, used to manage connections and transactions.

org.ktorm.schema.DateSqlType

SqlType implementation represents date SQL type.

org.ktorm.support.sqlserver.DateTimeOffsetSqlType

SqlType implementation represents SQL Server datetimeoffset SQL type.

org.ktorm.schema.DecimalSqlType

SqlType implementation represents decimal SQL type.

org.ktorm.support.mysql.DefaultValueExpression

Default value expression, translated to the default keyword in MySQL, used in insert statements.

org.ktorm.support.postgresql.DefaultValueExpression

Default value expression, translated to the default keyword in PostgreSQL, used in insert statements.

org.ktorm.expression.DeleteExpression

Delete expression, represents the delete statement in SQL.

org.ktorm.database.DialectFeatureNotSupportedException

Thrown to indicate that a feature is not supported by the current dialect.

org.ktorm.schema.DoubleSqlType

SqlType implementation represents double SQL type.

org.ktorm.support.postgresql.Earth

Cube-based earth abstraction, using 3 coordinates representing the x, y, and z distance from the center of the Earth. Part of PostgreSQL earthdistance extension. https://www.postgresql.org/docs/12/earthdistance.html

org.ktorm.support.postgresql.EarthSqlType

Cube-based earth abstraction, using 3 coordinates representing the x, y, and z distance from the center of the Earth. Part of PostgreSQL earthdistance SQL extension.

org.ktorm.entity.Entity

The super interface of all entity classes in Ktorm. This interface injects many useful functions into entities.

org.ktorm.entity.EntityExtensionsApi

Entity extension APIs.

org.ktorm.entity.EntityGrouping

Wraps an EntitySequence with a keySelector function, which can be applied to each record to get its key, or used as the group by clause of the generated SQL.

org.ktorm.entity.EntitySequence

Represents a sequence of entity objects. As the name implies, the style and use pattern of Ktorm's entity sequence APIs are highly similar to kotlin.sequences.Sequence and the extension functions in Kotlin standard lib, as it provides many extension functions with the same names, such as filter, map, reduce, etc.

org.ktorm.schema.EnumSqlType

SqlType implementation that saves enums as strings.

org.ktorm.expression.ExistsExpression

Exists expression, check if the specific query has at least one result.

org.ktorm.schema.FloatSqlType

SqlType implementation represents float SQL type.

org.ktorm.expression.FunctionExpression

Function expression, represents a normal SQL function call.

org.ktorm.support.postgresql.HStore

Represent values of PostgreSQL hstore SQL type.

org.ktorm.support.postgresql.HStoreExpression

Expression class represents PostgreSQL hstore operations.

org.ktorm.support.postgresql.HStoreExpressionType

Enum for hstore operators.

org.ktorm.support.postgresql.HStoreSqlType

SqlType implementation represents PostgreSQL hstore type.

org.ktorm.support.postgresql.ILikeExpression

ILike expression, represents PostgreSQL ilike keyword.

org.ktorm.expression.InListExpression

In-list expression, translated to the in keyword in SQL.

org.ktorm.expression.InsertExpression

Insert expression, represents the insert statement in SQL.

org.ktorm.expression.InsertFromQueryExpression

Insert-from-query expression, eg. insert into tmp(num) select 1 from dual.

org.ktorm.support.mysql.InsertOrUpdateExpression

Insert or update expression, represents an insert statement with an on duplicate key update clause in MySQL.

org.ktorm.support.postgresql.InsertOrUpdateExpression

Insert or update expression, represents an insert statement with an on conflict (key) do update set clause in PostgreSQL.

org.ktorm.support.sqlite.InsertOrUpdateExpression

Insert or update expression, represents an insert statement with an on conflict (key) do update set clause in SQLite.

org.ktorm.support.postgresql.InsertOrUpdateOnConflictClauseBuilder

DSL builder for insert or update on conflict clause.

org.ktorm.support.sqlite.InsertOrUpdateOnConflictClauseBuilder

DSL builder for insert or update on conflict clause.

org.ktorm.support.mysql.InsertOrUpdateStatementBuilder

DSL builder for insert or update statements.

org.ktorm.support.postgresql.InsertOrUpdateStatementBuilder

DSL builder for insert or update statements.

org.ktorm.support.sqlite.InsertOrUpdateStatementBuilder

DSL builder for insert or update statements.

org.ktorm.schema.InstantSqlType

SqlType implementation represents timestamp SQL type.

org.ktorm.schema.IntSqlType

SqlType implementation represents int SQL type.

kotlin.collections.Iterable (extensions in package org.ktorm.dsl)
org.ktorm.database.JdbcTransactionManager

TransactionManager implementation based on JDBC.

org.ktorm.logging.JdkLoggerAdapter

Adapter Logger implementation integrating java.util.logging with Ktorm.

org.ktorm.expression.JoinExpression

Join expression.

org.ktorm.expression.JoinType

The enum of joining types in a JoinExpression.

org.ktorm.jackson.JsonSqlType

SqlType implementation that provides JSON data type support via Jackson framework.

kotlin.reflect.KClass (extensions in package org.ktorm.expression)
org.ktorm.dsl.KtormDsl

Marker annotation for Ktorm DSL builder classes.

org.ktorm.jackson.KtormModule

Jackson Module implementation that supports serializing Ktorm's entity objects in JSON format.

org.ktorm.schema.LocalDateSqlType

SqlType implementation represents date SQL type.

org.ktorm.schema.LocalDateTimeSqlType

SqlType implementation represents datetime SQL type.

org.ktorm.schema.LocalTimeSqlType

SqlType implementation represents time SQL type.

org.ktorm.support.mysql.LockingClause

MySQL locking clause, See https://dev.mysql.com/doc/refman/8.0/en/innodb-locking-reads.html

org.ktorm.support.postgresql.LockingClause

PostgreSQL locking clause. See https://www.postgresql.org/docs/13/sql-select.html#SQL-FOR-UPDATE-SHARE

org.ktorm.support.mysql.LockingMode

MySQL locking mode.

org.ktorm.support.postgresql.LockingMode

PostgreSQL locking mode.

org.ktorm.support.mysql.LockingWait

MySQL wait strategy for locked records.

org.ktorm.support.postgresql.LockingWait

PostgreSQL wait strategy for locked records.

org.ktorm.logging.Logger

A simple logging interface abstracting third-party logging frameworks.

org.ktorm.logging.LogLevel

Enum class defining logging levels in a certain order. While TRACE is the least serious and ERROR is the most serials.

org.ktorm.schema.LongSqlType

SqlType implementation represents long SQL type.

org.ktorm.support.mysql.MatchAgainstExpression

Match against expression, represents an match ... against ... operation in MySQL. See https://dev.mysql.com/doc/refman/5.5/en/insert-on-duplicate.html

org.ktorm.support.mysql.MatchColumns

Intermediate class that wraps the search columns of a MatchAgainstExpression.

org.ktorm.schema.MonthDaySqlType

SqlType implementation used to save MonthDay instances, formatting them to strings with pattern MM-dd.

org.ktorm.support.mysql.MySqlAssignmentsBuilder

Base class of MySQL DSL builders, provide basic functions used to build assignments for insert or update DSL.

org.ktorm.support.mysql.MySqlDialect

SqlDialect implementation for MySQL database.

org.ktorm.support.mysql.MySqlExpressionVisitor

Base interface designed to visit or modify MySQL expression trees using visitor pattern.

org.ktorm.support.mysql.MySqlFormatter

SqlFormatter implementation for MySQL, formatting SQL expressions as strings with their execution arguments.

org.ktorm.support.mysql.NaturalJoinExpression

MySQL natural join expression.

org.ktorm.schema.NestedBinding

Bind the column to nested properties, eg. employee.manager.department.id.

org.ktorm.logging.NoOpLogger

Logger implementation that performs no operations.

org.ktorm.support.oracle.OracleDialect

SqlDialect implementation for Oracle database.

org.ktorm.support.oracle.OracleFormatter

SqlFormatter implementation for Oracle, formatting SQL expressions as strings with their execution arguments.

org.ktorm.expression.OrderByExpression

Order-by expression.

org.ktorm.expression.OrderType

The enum of order directions in a OrderByExpression.

org.ktorm.support.postgresql.PostgreSqlAssignmentsBuilder

Base class of PostgreSQL DSL builders, provide basic functions used to build assignments for insert or update DSL.

org.ktorm.support.postgresql.PostgreSqlDialect

SqlDialect implementation for PostgreSQL database.

org.ktorm.support.postgresql.PostgreSqlExpressionVisitor

Base interface designed to visit or modify PostgreSQL expression trees using visitor pattern.

org.ktorm.support.postgresql.PostgreSqlFormatter

SqlFormatter implementation for PostgreSQL, formatting SQL expressions as strings with their execution arguments.

java.sql.PreparedStatement (extensions in package org.ktorm.database)
org.ktorm.dsl.Query

Query is an abstraction of query operations and the core class of Ktorm's query DSL.

org.ktorm.expression.QueryExpression

Base class of query expressions, provide common properties for SelectExpression and UnionExpression.

org.ktorm.dsl.QueryRowSet

Special implementation of ResultSet, used to hold the Query results for Ktorm.

org.ktorm.dsl.QuerySource

Represents a query source, used in the from clause of a query.

org.ktorm.expression.QuerySourceExpression

Query source expression, used in the from clause of a SelectExpression.

org.ktorm.schema.ReferenceBinding

Bind the column to a reference table, equivalent to a foreign key in relational databases. Entity sequence APIs would automatically left-join all references (recursively) by default.

org.ktorm.expression.ScalarExpression

Base class of scalar expressions. An expression is "scalar" if it has a return value (eg. a + 1).

org.ktorm.support.mysql.SearchModifier

Enum class represents search modifiers in MySQL match ... against ... expressions. See https://dev.mysql.com/doc/refman/5.5/en/fulltext-search.html

org.ktorm.expression.SelectExpression

Select expression, represents a select statement of SQL.

org.ktorm.schema.ShortSqlType

SqlType implementation represents smallint SQL type.

org.ktorm.logging.Slf4jLoggerAdapter

Adapter Logger implementation integrating Slf4j with Ktorm.

org.ktorm.database.SpringManagedTransactionManager

TransactionManager implementation that delegates all transactions to the Spring framework.

org.ktorm.database.SqlDialect

Representation of a SQL dialect.

org.ktorm.expression.SqlExpression

Root class of SQL expressions or statements.

org.ktorm.expression.SqlExpressionVisitor

Base interface designed to visit or modify SQL expression trees using visitor pattern.

org.ktorm.expression.SqlExpressionVisitorInterceptor

Interceptor that can intercept the visit functions for SqlExpressionVisitor and its sub-interfaces.

org.ktorm.expression.SqlFormatter

Implementation of SqlExpressionVisitor, visiting SQL expression trees using visitor pattern. After a visit completes, the executable SQL string will be generated in the sql property with its execution parameters in parameters.

org.ktorm.support.sqlite.SQLiteAssignmentsBuilder

Base class of SQLite DSL builders, provide basic functions used to build assignments for insert or update DSL.

org.ktorm.support.sqlite.SQLiteDialect

SqlDialect implementation for SQLite database.

org.ktorm.support.sqlite.SQLiteExpressionVisitor

Base interface designed to visit or modify SQLite expression trees using visitor pattern.

org.ktorm.support.sqlite.SQLiteFormatter

SqlFormatter implementation for SQLite, formatting SQL expressions as strings with their execution arguments.

org.ktorm.support.sqlserver.SqlServerDialect

SqlDialect implementation for Microsoft SqlServer database.

org.ktorm.support.sqlserver.SqlServerFormatter

SqlFormatter implementation for SqlServer, formatting SQL expressions as strings with their execution arguments.

org.ktorm.schema.SqlType

Abstraction of SQL data types.

org.ktorm.schema.Table

Base class of Ktorm's table objects. This class extends from BaseTable, additionally providing a binding mechanism with Entity interfaces based on functions such as bindTo, references.

org.ktorm.expression.TableExpression

Table expression.

org.ktorm.support.postgresql.TextArray

Represent values of PostgreSQL text[] SQL type.

org.ktorm.support.postgresql.TextArraySqlType

SqlType implementation represents PostgreSQL text[] type.

org.ktorm.schema.TextSqlType

SqlType implementation represents text SQL type.

org.ktorm.schema.TimeSqlType

SqlType implementation represents time SQL type.

org.ktorm.schema.TimestampSqlType

SqlType implementation represents timestamp SQL type.

org.ktorm.database.Transaction

Representation of a transaction.

org.ktorm.database.TransactionIsolation

Enum class represents transaction isolation levels, wrapping the TRANSACTION_XXX constants defined in the Connection interface.

org.ktorm.database.TransactionManager

Transaction manager abstraction used to manage database connections and transactions.

org.ktorm.schema.TypeReference

Base class used to obtain full generic type information by subclassing.

org.ktorm.expression.UnaryExpression

Unary expression.

org.ktorm.expression.UnaryExpressionType

Enum for unary expressions.

org.ktorm.expression.UnionExpression

Union expression, represents a union statement of SQL.

org.ktorm.expression.UpdateExpression

Update expression, represents the update statement in SQL.

org.ktorm.dsl.UpdateStatementBuilder

DSL builder for update statements.

org.ktorm.schema.UuidSqlType

SqlType implementation represents uuid SQL type.

org.ktorm.schema.VarcharSqlType

SqlType implementation represents varchar SQL type.

org.ktorm.dsl.WhenContinuation

Return type for WHEN function, call its extension function THEN to finish a SQL when clause.

org.ktorm.expression.WindowFrameBoundExpression

Window frame bound expression.

org.ktorm.expression.WindowFrameBoundType

The enum type of window frame bound.

org.ktorm.dsl.WindowFrames

Utility object that creates expressions of window frame bounds.

org.ktorm.expression.WindowFrameUnitType

The enum type of window frame unit.

org.ktorm.expression.WindowFunctionExpression

Window function expression, represents a SQL window function call.

org.ktorm.expression.WindowFunctionType

The enum of window function type.

org.ktorm.expression.WindowSpecificationExpression

Window specification expression.

org.ktorm.schema.YearMonthSqlType

SqlType implementation used to save YearMonth instances, formatting them to strings with pattern yyyy-MM.

org.ktorm.schema.YearSqlType

SqlType implementation used to save Year instances as integers.