Returning

Definition

The returning methods allows you to add the RETURNING clause to the query.

Available methods

1. returning(KColumnAllowedToReturning... kColumnsAllowedToReturning)

• kColumnsAllowedToReturning: are all the expresions that will be added to the RETURNING clause.
  Among the possible values are: KTableColumn, KColumn, Columns with alias, KRaw, Case conditional expression.

Method hierarchy

The returning method can be used right after the following methods or objects:

• set, where

and the subsequent methods that can be called are:

• execute

Example

Java code:

k
.update(APP_USER)
.set(APP_USER.FIRST_NAME, coalesce(APP_USER.FIRST_NAME, val("No name")))
.returning(
    APP_USER.ID,
    concat(APP_USER.FIRST_NAME, val(" "), APP_USER.LAST_NAME).as("fullName"),
    coalesce(APP_USER.LAST_NAME, APP_USER.FIRST_NAME),
    raw("au.role_id"),
    caseConditional()
        .when(APP_USER.CREATED_AT.gt(LocalDateTime.now().minusDays(7))).then(APP_USER.EMAIL)
        .elseResult(val("No email available"))
        .end()
        .as("email")
)
.execute(AppUser.class);

SQL generated:

UPDATE app_user au
SET first_name = COALESCE(au.first_name, ?1)
RETURNING
    au.id,
    CONCAT(au.first_name || ?2 || au.last_name) AS "fullName",
    COALESCE(au.last_name, au.first_name),
    au.role_id,
    CASE WHEN au.created_at > ?3 THEN au.email ELSE ?4 END AS "email"

Parameters:

• ?1: "No name"
• ?2: " "
• ?3: 2023-01-23 17:19:22.313
• ?4: "No email available"