InsertQueryBuilder
Defines the public API for building SQL INSERT queries.
// Enlist a new legionnaire, returning the generated ID
val data = legionnaire.toDataMap("id")
dataAccess.insertInto("legionnaires")
.values(data)
.valueExpression("enlisted_at", "NOW()")
.returning("id")
.toField<Int>(data)Functions
Converts this builder to a StepBuilderMethods for lazy execution within a TransactionPlan.
Explicitly defines the columns for the INSERT statement.
Creates and returns a deep copy of this builder. Useful for creating query variants from a shared base without modifying the original.
Defines a SELECT query as the data source for insertion.
Switches the builder to iterative mode, optimal for large datasets.
Configures behavior in case of a key conflict (ON CONFLICT clause).
Configures additional options for this query.
Marks the WITH clause as recursive.
Adds a RETURNING clause. Requires using .toList(), .toSingle(), etc. instead of .execute().
Fetches a single value from the first column of the first row. Always returns Failure if no rows are found, regardless of nullability. Nullability only controls whether a null value in the column is allowed: use toFieldStrict<Int>() to fail on null, or toFieldStrict<Int?>() to allow null values.
Maps results to a list of objects using the provided mapper. This bypasses reflection and is the most efficient way to map results to domain objects.
Maps results to a list of objects of the given type. Requires that column names/aliases in SQL (in snake_case convention) match property names in the target class (in camelCase convention) or have a @MapKey annotation with the stored column name.
Maps the result to a single object of the given type. Works on the same mapping principle as toListOf. Nullability is determined by the KType: use toSingleOf<User>() for non-null or toSingleOf<User?>() for nullable results.
Maps the result to a single object using the provided mapper. Nullability is determined by the KType: use toSingleOf<User>(mapper) for non-null or toSingleOf<User?>(mapper) for nullable results. This bypasses reflection and is the most efficient way to map results to domain objects.
Fetches a single row as Map
Defines a single value, automatically generating a placeholder.
Defines a single value to insert as a SQL expression.
Defines values to insert, automatically generating placeholders in @value format for each value in the list.
Defines values to insert, automatically generating placeholders. This is the preferred, high-level method for inserting data. Values from the map must be passed in the terminal method (e.g., .execute()).
Defines values to insert as SQL expressions or placeholders. This is a low-level method.
Adds a Common Table Expression (CTE) to the query.