Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,32 @@

package org.keycloak.connections.jpa.dialect;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Proxy;
import java.util.List;

import org.hibernate.dialect.OracleDialect;
import org.hibernate.dialect.sql.ast.OracleSqlAstTranslator;
import org.hibernate.dialect.sql.ast.spi.SqlAstTranslationRequest;
import org.hibernate.dialect.sql.ast.spi.SqlAstTranslatorFactory;
import org.hibernate.engine.jdbc.dialect.spi.DialectResolutionInfo;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.sql.ast.SqlAstTranslator;
import org.hibernate.sql.ast.SqlAstTranslatorFactory;
import org.hibernate.sql.ast.spi.StandardSqlAstTranslatorFactory;
import org.hibernate.sql.ast.tree.Statement;
import org.hibernate.sql.ast.tree.insert.ConflictClause;
import org.hibernate.sql.ast.tree.insert.InsertSelectStatement;
import org.hibernate.query.IllegalQueryOperationException;
import org.hibernate.query.spi.QueryOptions;
import org.hibernate.sql.ast.spi.Statement;
import org.hibernate.sql.ast.spi.query.insert.ConflictClause;
import org.hibernate.sql.ast.spi.query.insert.InsertSelectStatement;
import org.hibernate.sql.ast.spi.translation.SqlAstTranslator;
import org.hibernate.sql.exec.spi.JdbcOperation;
import org.hibernate.sql.exec.spi.JdbcOperationQueryMutation;
import org.hibernate.sql.exec.spi.JdbcOperations;
import org.hibernate.sql.exec.spi.JdbcParameterBindings;

/**
* Fixes Hibernate's Oracle dialect to correctly handle HQL {@code insert ... on conflict (...) do nothing}, which it
* would otherwise render as a plain INSERT that silently drops the conflict clause.
* Preserves concurrent-insert safety for HQL {@code insert ... on conflict (...) do nothing} on Oracle.
* <p>
* It renders an INSERT with the {@code IGNORE_ROW_ON_DUPKEY_INDEX} hint, so that a duplicate key is skipped and
* counted as 0 rows. Unlike a MERGE, this also holds when a concurrent transaction inserts the same key. The conflict
* columns must match a unique index. {@code do update} clauses are still rendered as MERGE, which fails with a unique
* constraint violation in that case.
* <p>
* See <a href="https://hibernate.atlassian.net/browse/HHH-20826">HHH-20826</a> for the upstream tracker.
*/
public class KeycloakOracleDialect extends OracleDialect {

Expand All @@ -50,42 +54,107 @@ public KeycloakOracleDialect(DialectResolutionInfo info) {
super(info);
}

// Remove this override once Keycloak upgrades to a Hibernate version that fixes HHH-21039.
// https://hibernate.atlassian.net/browse/HHH-21039
@Override
public SqlAstTranslatorFactory getSqlAstTranslatorFactory() {
return new StandardSqlAstTranslatorFactory() {
SqlAstTranslatorFactory delegateFactory = super.getSqlAstTranslatorFactory();
return new SqlAstTranslatorFactory() {
@Override
protected <T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(
SessionFactoryImplementor sessionFactory, Statement statement) {
return new OracleSqlAstTranslator<>(sessionFactory, statement) {
@Override
protected void visitInsertStatementOnly(InsertSelectStatement statement) {
ConflictClause conflictClause = statement.getConflictClause();
if (conflictClause != null && !conflictClause.isDoNothing()
&& !conflictClause.getConstraintColumnNames().isEmpty()) {
visitInsertStatementEmulateMerge(statement);
} else {
super.visitInsertStatementOnly(statement);
@SuppressWarnings("unchecked")
public <S extends Statement, T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(
SqlAstTranslationRequest<S, T> request) {
if (request instanceof SqlAstTranslationRequest.QueryMutation mutation
&& mutation.statement() instanceof InsertSelectStatement insert) {
ConflictClause conflict = insert.getConflictClause();
if (conflict != null && conflict.isDoNothing() && !conflict.getConstraintColumnNames().isEmpty()) {
if (conflict.getConstraintName() != null || conflict.getPredicate() != null) {
throw new IllegalQueryOperationException("Oracle duplicate-index hints require a column-only conflict target");
}
}

@Override
protected void renderInsertCommand(InsertSelectStatement statement) {
ConflictClause conflictClause = statement.getConflictClause();
if (conflictClause != null && conflictClause.isDoNothing()
&& !conflictClause.getConstraintColumnNames().isEmpty()) {
// The hint names the table as it appears in the statement, without a schema
String table = statement.getTargetTable().getTableExpression();
appendSql("insert /*+ IGNORE_ROW_ON_DUPKEY_INDEX(");
appendSql(table.substring(table.lastIndexOf('.') + 1));
appendSql('(');
appendSql(String.join(",", conflictClause.getConstraintColumnNames()));
appendSql(")) */ into ");
} else {
super.renderInsertCommand(statement);
}
// Translate a copy as an ordinary insert; the database hint implements do-nothing.
// Never mutate the original AST, which may be retained by the query plan.
InsertSelectStatement copy = new InsertSelectStatement(insert, insert.getTargetTable(),
insert.getMutationTarget(), insert.getReturningColumns());
copy.addTargetColumnReferences(insert.getTargetColumns());
copy.setValuesList(List.copyOf(insert.getValuesList()));
copy.setSourceSelectStatement(insert.getSourceSelectStatement());
SqlAstTranslationRequest.QueryMutation translatedRequest =
new SqlAstTranslationRequest.QueryMutation(request.sessionFactory(), copy);
String table = unqualifiedTableName(insert.getTargetTable().getTableExpression());
String hint = "IGNORE_ROW_ON_DUPKEY_INDEX(" + table + "("
+ String.join(",", conflict.getConstraintColumnNames()) + "))";
return (SqlAstTranslator<T>) hintedTranslator(mutation,
delegateFactory.buildTranslator(translatedRequest), hint);
}
};
}
return delegateFactory.buildTranslator(request);
}
};
}

private static String unqualifiedTableName(String table) {
// The expression is already SQL-rendered; dots inside quoted identifiers are not qualifiers.
int start = 0;
boolean quoted = false;
for (int i = 0; i < table.length(); i++) {
char character = table.charAt(i);
if (character == '"') {
if (quoted && i + 1 < table.length() && table.charAt(i + 1) == '"') {
i++;
} else {
quoted = !quoted;
}
} else if (character == '.' && !quoted) {
start = i + 1;
}
}
return table.substring(start);
}

@SuppressWarnings("unchecked")
private SqlAstTranslator<JdbcOperationQueryMutation> hintedTranslator(SqlAstTranslationRequest.QueryMutation request,
SqlAstTranslator<JdbcOperationQueryMutation> delegate, String hint) {
// Delegate the complete public translator/walker contract, including future visitor methods.
return (SqlAstTranslator<JdbcOperationQueryMutation>) Proxy.newProxyInstance(
SqlAstTranslator.class.getClassLoader(), new Class<?>[] { SqlAstTranslator.class }, (proxy, method, args) -> {
if (method.getDeclaringClass() == Object.class) {
return switch (method.getName()) {
case "equals" -> proxy == args[0];
case "hashCode" -> System.identityHashCode(proxy);
case "toString" -> "OracleConflictTranslator[" + delegate + "]";
default -> throw new IllegalStateException("Unexpected Object method: " + method);
};
}
if (method.getName().equals("getSqlAst")) {
return request.statement();
}
if (method.getName().equals("translate")) {
JdbcOperationQueryMutation operation = delegate.translate((JdbcParameterBindings) args[0], (QueryOptions) args[1]);
return applyHint(request, operation, hint);
}
try {
return method.invoke(delegate, args);
} catch (InvocationTargetException e) {
throw e.getCause();
}
});
}

JdbcOperationQueryMutation applyHint(SqlAstTranslationRequest.QueryMutation request,
JdbcOperationQueryMutation operation, String hint) {
String sql;
try {
sql = getQueryHintString(operation.getSqlString(), hint);
} catch (IllegalArgumentException e) {
throw new IllegalQueryOperationException("Cannot apply Oracle duplicate-index hint to this insert shape",
operation.getSqlString(), e);
}
return JdbcOperations.queryMutation(request)
.command(sql)
.parameterBinders(operation.getParameterBinders())
.affectedQuerySpaces(operation.getAffectedTableNames())
.appliedParameterBindings(operation.getAppliedParameters())
.build();
}
}
Loading
Loading