Class SqlQueryBuilder.DefaultReturningSelectionVisitor

java.lang.Object

io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder.SqlSelectionVisitor

io.micronaut.data.model.query.builder.sql.SqlQueryBuilder.SqlSelectionVisitor

io.micronaut.data.model.query.builder.sql.SqlQueryBuilder.DefaultReturningSelectionVisitor

All Implemented Interfaces:

ExpressionVisitor, SelectionVisitor, AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor

Enclosing class:

SqlQueryBuilder

@Internal
protected final class SqlQueryBuilder.DefaultReturningSelectionVisitor
extends SqlQueryBuilder.SqlSelectionVisitor
implements AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor

Default implementation of AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor used by SqlQueryBuilder to render the projection for SQL RETURNING clauses (INSERT/UPDATE/DELETE).

In addition to emitting the selection into the SQL buffer, this visitor collects:

• Unescaped column names in declaration order via getUnescapedColumns()
• Result column data types via getResultColumnTypes()

The collected metadata is used by dialects such as Oracle that require RETURNING ... INTO OUT parameters instead of a result set.

This type is not thread-safe and is intended for per-query use only. It is an internal implementation detail and not part of the public API.

Since:

1.0.0

Author:

graemerocher, Denis Stepanov

See Also:

• SqlQueryBuilder.createReturningSelectionVisitor(AnnotationMetadata, QueryState, boolean)
• AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor

Field Summary

Fields inherited from class AbstractSqlLikeQueryBuilder.SqlSelectionVisitor

annotationMetadata, columnAlias, distinct, entity, query, queryState, tableAlias

Method Summary

Modifier and Type	Method	Description
protected void	appendPropertyProjection(AbstractSqlLikeQueryBuilder.QueryPropertyPath propertyPath)	Append the property projection.
List<DataType>	getResultColumnTypes()	Returns the data types for the columns produced by the RETURNING clause.
List<String>	getUnescapedColumns()	Returns the list of physical column names as they appear in the SQL, without dialect-specific quoting applied.
void	selectAllColumns(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, PersistentEntity entity, @Nullable String alias)	Selects all columns for the given entity and alias.

Methods inherited from class SqlQueryBuilder.SqlSelectionVisitor

appendRowCount, appendRowCountDistinct, selectAllColumnsAndJoined, selectAllColumnsFromJoinPaths

Methods inherited from class AbstractSqlLikeQueryBuilder.SqlSelectionVisitor

appendAssociationProjection, appendCompoundAssociationProjection, appendCompoundProjection, appendCompoundPropertyProjection, appendProperty, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ExpressionVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit

Methods inherited from interface SelectionVisitor

visit, visit, visit, visit

Method Details

getUnescapedColumns

public List<String> getUnescapedColumns()

Description copied from interface: AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor

Returns the list of physical column names as they appear in the SQL, without dialect-specific quoting applied.

Specified by:

getUnescapedColumns in interface AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor

Returns:

unescaped column names in the order they are rendered

getResultColumnTypes

public List<DataType> getResultColumnTypes()

Description copied from interface: AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor

Returns the data types for the columns produced by the RETURNING clause. The order must match AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor.getUnescapedColumns().

Specified by:

getResultColumnTypes in interface AbstractSqlLikeQueryBuilder.ReturningSelectionVisitor

Returns:

result column data types

selectAllColumns

public void selectAllColumns(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 PersistentEntity entity,
 @Nullable String alias)

Description copied from class: SqlQueryBuilder.SqlSelectionVisitor

Selects all columns for the given entity and alias.

Overrides:

selectAllColumns in class SqlQueryBuilder.SqlSelectionVisitor

Parameters:

annotationMetadata - The annotation metadata

entity - The entity

alias - The alias

appendPropertyProjection

protected void appendPropertyProjection(AbstractSqlLikeQueryBuilder.QueryPropertyPath propertyPath)

Description copied from class: AbstractSqlLikeQueryBuilder.SqlSelectionVisitor

Append the property projection.

Overrides:

appendPropertyProjection in class AbstractSqlLikeQueryBuilder.SqlSelectionVisitor

Parameters:

propertyPath - The property