HHH-15328 Add support for CTE WITH clause

Author: beikov

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CUBRIDSqlAstTranslator.java

@@ -37,16 +37,6 @@ public void visitOffsetFetchClause(QueryPart queryPart) {
 		renderCombinedLimitClause( queryPart );
 	}
 
-	@Override
-	protected void renderSearchClause(CteStatement cte) {
-		// CUBRID does not support this, but it's just a hint anyway
-	}
-
-	@Override
-	protected void renderCycleClause(CteStatement cte) {
-		// CUBRID does not support this, but it can be emulated
-	}
-
 	@Override
 	protected void renderComparison(Expression lhs, ComparisonOperator operator, Expression rhs) {
 		renderComparisonEmulateIntersect( lhs, operator, rhs );

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CacheSqlAstTranslator.java

@@ -80,16 +80,6 @@ public void visitOffsetFetchClause(QueryPart queryPart) {
 		}
 	}
 
-	@Override
-	protected void renderSearchClause(CteStatement cte) {
-		// Cache does not support this, but it's just a hint anyway
-	}
-
-	@Override
-	protected void renderCycleClause(CteStatement cte) {
-		// Cache does not support this, but it can be emulated
-	}
-
 	@Override
 	protected void renderComparison(Expression lhs, ComparisonOperator operator, Expression rhs) {
 		renderComparisonEmulateIntersect( lhs, operator, rhs );

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CockroachLegacyDialect.java

@@ -348,6 +348,11 @@ public boolean supportsNonQueryWithCTE() {
 		return true;
 	}
 
+	@Override
+	public boolean supportsRecursiveCTE() {
+		return getVersion().isSameOrAfter( 20, 1 );
+	}
+
 	@Override
 	public String getNoColumnsInsertString() {
 		return "default values";

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/CockroachLegacySqlAstTranslator.java

@@ -9,6 +9,7 @@
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.sql.ast.spi.AbstractSqlAstTranslator;
 import org.hibernate.sql.ast.tree.Statement;
+import org.hibernate.sql.ast.tree.cte.CteMaterialization;
 import org.hibernate.sql.ast.tree.cte.CteStatement;
 import org.hibernate.sql.ast.tree.expression.Expression;
 import org.hibernate.sql.ast.tree.expression.Literal;
@@ -52,6 +53,26 @@ public void visitBooleanExpressionPredicate(BooleanExpressionPredicate booleanEx
 		}
 	}
 
+	@Override
+	protected void renderMaterializationHint(CteMaterialization materialization) {
+		if ( getDialect().getVersion().isSameOrAfter( 20, 2 ) ) {
+			if ( materialization == CteMaterialization.NOT_MATERIALIZED ) {
+				appendSql( "not " );
+			}
+			appendSql( "materialized " );
+		}
+	}
+
+	@Override
+	protected boolean supportsRowConstructor() {
+		return true;
+	}
+
+	@Override
+	protected boolean supportsArrayConstructor() {
+		return true;
+	}
+
 	@Override
 	protected String getForShare(int timeoutMillis) {
 		return " for share";
@@ -111,16 +132,6 @@ public void visitOffsetFetchClause(QueryPart queryPart) {
 		}
 	}
 
-	@Override
-	protected void renderSearchClause(CteStatement cte) {
-		// Cockroach does not support this, but it's just a hint anyway
-	}
-
-	@Override
-	protected void renderCycleClause(CteStatement cte) {
-		// Cockroach does not support this, but it can be emulated
-	}
-
 	@Override
 	protected void renderPartitionItem(Expression expression) {
 		if ( expression instanceof Literal ) {

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacyDialect.java

@@ -532,6 +532,11 @@ public boolean supportsLockTimeouts() {
 		return false;
 	}
 
+	@Override
+	public boolean requiresCastForConcatenatingNonStrings() {
+		return true;
+	}
+
 	@Override
 	public String getSelectClauseNullString(int sqlType, TypeConfiguration typeConfiguration) {
 		return selectNullString(sqlType);
@@ -754,6 +759,12 @@ public boolean supportsNonQueryWithCTE() {
 		return true;
 	}
 
+	@Override
+	public boolean supportsRecursiveCTE() {
+		// Supported at last since 9.7
+		return getDB2Version().isSameOrAfter( 9, 7 );
+	}
+
 	@Override
 	public boolean supportsOffsetInSubquery() {
 		return true;

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacySqlAstTranslator.java

@@ -9,6 +9,7 @@
 import java.util.List;
 import java.util.function.Consumer;
 
+import org.hibernate.LockMode;
 import org.hibernate.dialect.DatabaseVersion;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.query.sqm.ComparisonOperator;
@@ -26,6 +27,9 @@
 import org.hibernate.sql.ast.tree.expression.Literal;
 import org.hibernate.sql.ast.tree.expression.SqlTuple;
 import org.hibernate.sql.ast.tree.expression.Summarization;
+import org.hibernate.sql.ast.tree.from.TableGroup;
+import org.hibernate.sql.ast.tree.from.TableGroupJoin;
+import org.hibernate.sql.ast.tree.from.TableReferenceJoin;
 import org.hibernate.sql.ast.tree.insert.InsertStatement;
 import org.hibernate.sql.ast.tree.predicate.BooleanExpressionPredicate;
 import org.hibernate.sql.ast.tree.select.QueryGroup;
@@ -45,6 +49,70 @@ public DB2LegacySqlAstTranslator(SessionFactoryImplementor sessionFactory, State
 		super( sessionFactory, statement );
 	}
 
+	@Override
+	protected boolean needsRecursiveKeywordInWithClause() {
+		return false;
+	}
+
+	@Override
+	protected boolean supportsWithClauseInSubquery() {
+		return false;
+	}
+
+	@Override
+	protected void renderTableReferenceJoins(TableGroup tableGroup) {
+		// When we are in a recursive CTE, we can't render joins on DB2...
+		// See https://modern-sql.com/feature/with-recursive/db2/error-345-state-42836
+		if ( isInRecursiveQueryPart() ) {
+			final List<TableReferenceJoin> joins = tableGroup.getTableReferenceJoins();
+			if ( joins == null || joins.isEmpty() ) {
+				return;
+			}
+
+			for ( TableReferenceJoin tableJoin : joins ) {
+				switch ( tableJoin.getJoinType() ) {
+					case CROSS:
+					case INNER:
+						break;
+					default:
+						throw new UnsupportedOperationException( "Can't emulate '" + tableJoin.getJoinType().getText() + "join' in a DB2 recursive query part" );
+				}
+				appendSql( COMA_SEPARATOR_CHAR );
+
+				renderNamedTableReference( tableJoin.getJoinedTableReference(), LockMode.NONE );
+
+				if ( tableJoin.getPredicate() != null && !tableJoin.getPredicate().isEmpty() ) {
+					addAdditionalWherePredicate( tableJoin.getPredicate() );
+				}
+			}
+		}
+		else {
+			super.renderTableReferenceJoins( tableGroup );
+		}
+	}
+
+	@Override
+	protected void renderTableGroupJoin(TableGroupJoin tableGroupJoin, List<TableGroupJoin> tableGroupJoinCollector) {
+		if ( isInRecursiveQueryPart() ) {
+			switch ( tableGroupJoin.getJoinType() ) {
+				case CROSS:
+				case INNER:
+					break;
+				default:
+					throw new UnsupportedOperationException( "Can't emulate '" + tableGroupJoin.getJoinType().getText() + "join' in a DB2 recursive query part" );
+			}
+			appendSql( COMA_SEPARATOR_CHAR );
+
+			renderTableGroup( tableGroupJoin.getJoinedGroup(), null, tableGroupJoinCollector );
+			if ( tableGroupJoin.getPredicate() != null && !tableGroupJoin.getPredicate().isEmpty() ) {
+				addAdditionalWherePredicate( tableGroupJoin.getPredicate() );
+			}
+		}
+		else {
+			super.renderTableGroupJoin( tableGroupJoin, tableGroupJoinCollector );
+		}
+	}
+
 	@Override
 	protected void renderExpressionAsClauseItem(Expression expression) {
 		expression.accept( this );

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2iLegacyDialect.java

@@ -123,6 +123,11 @@ public boolean supportsLateral() {
 		return getVersion().isSameOrAfter( 7, 1 );
 	}
 
+	@Override
+	public boolean supportsRecursiveCTE() {
+		return getVersion().isSameOrAfter( 7, 1 );
+	}
+
 	@Override
 	public SqlAstTranslatorFactory getSqlAstTranslatorFactory() {
 		return new StandardSqlAstTranslatorFactory() {

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2zLegacyDialect.java

@@ -125,6 +125,11 @@ public boolean supportsLateral() {
 		return true;
 	}
 
+	@Override
+	public boolean supportsRecursiveCTE() {
+		return getVersion().isSameOrAfter( 11 );
+	}
+
 	@Override
 	public String timestampaddPattern(TemporalUnit unit, TemporalType temporalType, IntervalType intervalType) {
 		StringBuilder pattern = new StringBuilder();

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DerbyLegacyDialect.java

@@ -603,6 +603,11 @@ public boolean supportsOrderByInSubquery() {
 		return getVersion().isSameOrAfter( 10, 5 );
 	}
 
+	@Override
+	public boolean requiresCastForConcatenatingNonStrings() {
+		return true;
+	}
+
 	@Override
 	public void contributeTypes(TypeContributions typeContributions, ServiceRegistry serviceRegistry) {
 		super.contributeTypes( typeContributions, serviceRegistry );

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DerbyLegacySqlAstTranslator.java

@@ -41,6 +41,11 @@ public DerbyLegacySqlAstTranslator(SessionFactoryImplementor sessionFactory, Sta
 		super( sessionFactory, statement );
 	}
 
+	@Override
+	protected boolean supportsWithClause() {
+		return false;
+	}
+
 	@Override
 	protected void renderExpressionAsClauseItem(Expression expression) {
 		expression.accept( this );
@@ -125,24 +130,6 @@ protected String getForUpdateWithClause() {
 		return " with rs";
 	}
 
-	@Override
-	public void visitCteContainer(CteContainer cteContainer) {
-		if ( cteContainer.isWithRecursive() ) {
-			throw new IllegalArgumentException( "Recursive CTEs can't be emulated" );
-		}
-		super.visitCteContainer( cteContainer );
-	}
-
-	@Override
-	protected void renderSearchClause(CteStatement cte) {
-		// Derby does not support this, but it's just a hint anyway
-	}
-
-	@Override
-	protected void renderCycleClause(CteStatement cte) {
-		// Derby does not support this, but it can be emulated
-	}
-
 	@Override
 	public void visitOffsetFetchClause(QueryPart queryPart) {
 		// Derby only supports the OFFSET and FETCH clause with ROWS

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/FirebirdSqlAstTranslator.java

@@ -136,16 +136,6 @@ public void visitOffsetFetchClause(QueryPart queryPart) {
 		}
 	}
 
-	@Override
-	protected void renderSearchClause(CteStatement cte) {
-		// Firebird does not support this, but it's just a hint anyway
-	}
-
-	@Override
-	protected void renderCycleClause(CteStatement cte) {
-		// Firebird does not support this, but it can be emulated
-	}
-
 	@Override
 	protected boolean supportsSimpleQueryGrouping() {
 		// Firebird is quite strict i.e. it requires `select .. union all select * from (select ...)`

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/H2LegacyDialect.java

@@ -658,6 +658,11 @@ public boolean supportsWindowFunctions() {
 		return getVersion().isSameOrAfter( 1, 4, 200 );
 	}
 
+	@Override
+	public boolean supportsRecursiveCTE() {
+		return getVersion().isSameOrAfter( 1, 4, 196 );
+	}
+
 	@Override
 	public boolean supportsFetchClause(FetchClauseType type) {
 		return getVersion().isSameOrAfter( 1, 4, 198 );

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/H2LegacySqlAstTranslator.java

@@ -17,6 +17,7 @@
 import org.hibernate.sql.ast.spi.AbstractSqlAstTranslator;
 import org.hibernate.sql.ast.spi.SqlSelection;
 import org.hibernate.sql.ast.tree.Statement;
+import org.hibernate.sql.ast.tree.cte.CteContainer;
 import org.hibernate.sql.ast.tree.cte.CteStatement;
 import org.hibernate.sql.ast.tree.expression.BinaryArithmeticExpression;
 import org.hibernate.sql.ast.tree.expression.Expression;
@@ -46,6 +47,41 @@ public H2LegacySqlAstTranslator(SessionFactoryImplementor sessionFactory, Statem
 		super( sessionFactory, statement );
 	}
 
+	@Override
+	public void visitCteContainer(CteContainer cteContainer) {
+		// H2 has various bugs in different versions that make it impossible to use CTEs with parameters reliably
+		withParameterRenderingMode(
+				SqlAstNodeRenderingMode.INLINE_PARAMETERS,
+				() -> super.visitCteContainer( cteContainer )
+		);
+	}
+
+	@Override
+	protected boolean needsCteInlining() {
+		// CTEs in H2 are just so buggy, that we can't reliably use them
+		return true;
+	}
+
+	@Override
+	protected boolean supportsWithClauseInSubquery() {
+		return false;
+	}
+
+	@Override
+	protected boolean supportsRowConstructor() {
+		return getDialect().getVersion().isSameOrAfter( 2 );
+	}
+
+	@Override
+	protected boolean supportsArrayConstructor() {
+		return getDialect().getVersion().isSameOrAfter( 2 );
+	}
+
+	@Override
+	protected String getArrayContainsFunction() {
+		return "array_contains";
+	}
+
 	@Override
 	protected void renderExpressionAsClauseItem(Expression expression) {
 		expression.accept( this );
@@ -84,16 +120,6 @@ public void visitOffsetFetchClause(QueryPart queryPart) {
 		}
 	}
 
-	@Override
-	protected void renderSearchClause(CteStatement cte) {
-		// H2 does not support this, but it's just a hint anyway
-	}
-
-	@Override
-	protected void renderCycleClause(CteStatement cte) {
-		// H2 does not support this, but it can be emulated
-	}
-
 	@Override
 	protected void renderSelectTupleComparison(
 			List<SqlSelection> lhsExpressions,

hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/InformixSqlAstTranslator.java

@@ -86,16 +86,6 @@ public void visitOffsetFetchClause(QueryPart queryPart) {
 		}
 	}
 
-	@Override
-	protected void renderSearchClause(CteStatement cte) {
-		// Informix does not support this, but it's just a hint anyway
-	}
-
-	@Override
-	protected void renderCycleClause(CteStatement cte) {
-		// Informix does not support this, but it can be emulated
-	}
-
 	@Override
 	protected void renderComparison(Expression lhs, ComparisonOperator operator, Expression rhs) {
 		renderComparisonEmulateIntersect( lhs, operator, rhs );