Skip to content

HHH-19498 - improve upserts on MySQL and Maria #10275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
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 @@ -35,13 +35,16 @@
import org.hibernate.exception.spi.SQLExceptionConversionDelegate;
import org.hibernate.exception.spi.TemplatedViolatedConstraintNameExtractor;
import org.hibernate.exception.spi.ViolatedConstraintNameExtractor;
import org.hibernate.persister.entity.mutation.EntityMutationTarget;
import org.hibernate.query.sqm.CastType;
import org.hibernate.service.ServiceRegistry;
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.exec.spi.JdbcOperation;
import org.hibernate.sql.model.MutationOperation;
import org.hibernate.sql.model.internal.OptionalTableUpdate;
import org.hibernate.tool.schema.extract.internal.SequenceInformationExtractorMariaDBDatabaseImpl;
import org.hibernate.tool.schema.extract.spi.SequenceInformationExtractor;
import org.hibernate.type.SqlTypes;
Expand Down Expand Up @@ -421,4 +424,13 @@ public boolean supportsWithClauseInSubquery() {
return false;
}

@Override
public MutationOperation createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory) {
if ( optionalTableUpdate.getNumberOfOptimisticLockBindings() == 0 ) {
final MariaDBSqlAstTranslator<?> translator = new MariaDBSqlAstTranslator<>( factory, optionalTableUpdate, MariaDBDialect.this );
return translator.createMergeOperation( optionalTableUpdate );
}
return super.createOptionalTableUpdateOperation( mutationTarget, optionalTableUpdate, factory );
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
/*
* SPDX-License-Identifier: Apache-2.0
* Copyright Red Hat Inc. and Hibernate Authors
*/
package org.hibernate.dialect;


import org.hibernate.StaleStateException;
import org.hibernate.engine.jdbc.mutation.JdbcValueBindings;
import org.hibernate.engine.spi.SharedSessionContractImplementor;
import org.hibernate.jdbc.Expectation;
import org.hibernate.persister.entity.mutation.EntityMutationTarget;
import org.hibernate.persister.entity.mutation.EntityTableMapping;
import org.hibernate.sql.model.ValuesAnalysis;
import org.hibernate.sql.model.internal.OptionalTableUpdate;
import org.hibernate.sql.model.jdbc.DeleteOrUpsertOperation;
import org.hibernate.sql.model.jdbc.UpsertOperation;

import java.sql.PreparedStatement;


/**
* @author Jan Schatteman
*/
public class MySQLDeleteOrUpsertOperation extends DeleteOrUpsertOperation {

private Expectation customExpectation;

public MySQLDeleteOrUpsertOperation(EntityMutationTarget mutationTarget, EntityTableMapping tableMapping, UpsertOperation upsertOperation, OptionalTableUpdate optionalTableUpdate) {
super( mutationTarget, tableMapping, upsertOperation, optionalTableUpdate );
}

@Override
public void performMutation(JdbcValueBindings jdbcValueBindings, ValuesAnalysis valuesAnalysis, SharedSessionContractImplementor session) {
customExpectation = new MySQLRowCountExpectation();
super.performMutation( jdbcValueBindings, valuesAnalysis, session );
}

@Override
protected Expectation getExpectation() {
return customExpectation;
}

private class MySQLRowCountExpectation implements Expectation {

Check notice

Code scanning / CodeQL

Inner class could be static Note

MySQLRowCountExpectation should be made static, since the enclosing instance is not used.
@Override
public final void verifyOutcome(int rowCount, PreparedStatement statement, int batchPosition, String sql) {
if ( rowCount > 2 ) {
throw new StaleStateException(
"Unexpected row count"
+ " (the expected row count for an ON DUPLICATE KEY UPDATE statement should be either 0, 1 or 2 )"
+ " [" + sql + "]"
);
}
}
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
import org.hibernate.mapping.CheckConstraint;
import org.hibernate.metamodel.mapping.EntityMappingType;
import org.hibernate.metamodel.spi.RuntimeModelCreationContext;
import org.hibernate.persister.entity.mutation.EntityMutationTarget;
import org.hibernate.query.common.TemporalUnit;
import org.hibernate.query.sqm.CastType;
import org.hibernate.query.sqm.IntervalType;
Expand All @@ -63,6 +64,8 @@
import org.hibernate.sql.ast.spi.StandardSqlAstTranslatorFactory;
import org.hibernate.sql.ast.tree.Statement;
import org.hibernate.sql.exec.spi.JdbcOperation;
import org.hibernate.sql.model.MutationOperation;
import org.hibernate.sql.model.internal.OptionalTableUpdate;
import org.hibernate.type.BasicTypeRegistry;
import org.hibernate.type.NullType;
import org.hibernate.type.SqlTypes;
Expand Down Expand Up @@ -1668,4 +1671,13 @@ public boolean supportsRowValueConstructorSyntaxInQuantifiedPredicates() {
return false;
}

@Override
public MutationOperation createOptionalTableUpdateOperation(EntityMutationTarget mutationTarget, OptionalTableUpdate optionalTableUpdate, SessionFactoryImplementor factory) {
if ( optionalTableUpdate.getNumberOfOptimisticLockBindings() == 0 ) {
final MySQLSqlAstTranslator<?> translator = new MySQLSqlAstTranslator<>( factory, optionalTableUpdate, MySQLDialect.this );
return translator.createMergeOperation( optionalTableUpdate );
}
return super.createOptionalTableUpdateOperation( mutationTarget, optionalTableUpdate, factory );
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
import org.hibernate.metamodel.mapping.JdbcMappingContainer;
import org.hibernate.query.sqm.ComparisonOperator;
import org.hibernate.sql.ast.Clause;
import org.hibernate.sql.ast.spi.AbstractSqlAstTranslator;
import org.hibernate.sql.ast.tree.Statement;
import org.hibernate.sql.ast.tree.delete.DeleteStatement;
import org.hibernate.sql.ast.tree.expression.BinaryArithmeticExpression;
Expand Down Expand Up @@ -44,7 +43,7 @@
*
* @author Christian Beikov
*/
public class MariaDBSqlAstTranslator<T extends JdbcOperation> extends AbstractSqlAstTranslator<T> {
public class MariaDBSqlAstTranslator<T extends JdbcOperation> extends SqlAstTranslatorWithOnDuplicateKeyUpdate<T> {

private final MariaDBDialect dialect;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
import org.hibernate.internal.util.collections.Stack;
import org.hibernate.query.sqm.ComparisonOperator;
import org.hibernate.sql.ast.Clause;
import org.hibernate.sql.ast.spi.AbstractSqlAstTranslator;
import org.hibernate.sql.ast.tree.Statement;
import org.hibernate.sql.ast.tree.delete.DeleteStatement;
import org.hibernate.sql.ast.tree.expression.BinaryArithmeticExpression;
Expand Down Expand Up @@ -46,7 +45,7 @@
*
* @author Christian Beikov
*/
public class MySQLSqlAstTranslator<T extends JdbcOperation> extends AbstractSqlAstTranslator<T> {
public class MySQLSqlAstTranslator<T extends JdbcOperation> extends SqlAstTranslatorWithOnDuplicateKeyUpdate<T> {

/**
* On MySQL, 1GB or {@code 2^30 - 1} is the maximum size that a char value can be casted.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
/*
* SPDX-License-Identifier: Apache-2.0
* Copyright Red Hat Inc. and Hibernate Authors
*/
package org.hibernate.dialect.sql.ast;


import org.hibernate.dialect.MySQLDeleteOrUpsertOperation;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.persister.entity.mutation.EntityTableMapping;
import org.hibernate.sql.ast.spi.SqlAstTranslatorWithUpsert;
import org.hibernate.sql.ast.tree.Statement;
import org.hibernate.sql.exec.spi.JdbcOperation;
import org.hibernate.sql.model.MutationOperation;
import org.hibernate.sql.model.ast.ColumnValueBinding;
import org.hibernate.sql.model.internal.OptionalTableUpdate;
import org.hibernate.sql.model.jdbc.UpsertOperation;

import java.util.List;

/**
* @author Jan Schatteman
*/
public class SqlAstTranslatorWithOnDuplicateKeyUpdate<T extends JdbcOperation> extends SqlAstTranslatorWithUpsert<T> {

public SqlAstTranslatorWithOnDuplicateKeyUpdate(SessionFactoryImplementor sessionFactory, Statement statement) {
super( sessionFactory, statement );
}

@Override
public MutationOperation createMergeOperation(OptionalTableUpdate optionalTableUpdate) {
assert optionalTableUpdate.getNumberOfOptimisticLockBindings() == 0;

renderUpsertStatement( optionalTableUpdate );

final UpsertOperation upsertOperation = new UpsertOperation(
optionalTableUpdate.getMutatingTable().getTableMapping(),
optionalTableUpdate.getMutationTarget(),
getSql(),
getParameterBinders()
);

return new MySQLDeleteOrUpsertOperation(
optionalTableUpdate.getMutationTarget(),
(EntityTableMapping) optionalTableUpdate.getMutatingTable().getTableMapping(),
upsertOperation,
optionalTableUpdate
);
}

@Override
protected void renderUpsertStatement(OptionalTableUpdate optionalTableUpdate) {
/*
Template: (for an entity WITHOUT @Version)
INSERT INTO employees (id, name, salary, version)
VALUES (?, ?, ?, ?) AS tr
ON DUPLICATE KEY UPDATE
name = tr.name,
salary = tr.salary,
*/
renderInsertInto( optionalTableUpdate );
appendSql( " " );
renderOnDuplicateKeyUpdate( optionalTableUpdate );
}

protected void renderInsertInto(OptionalTableUpdate optionalTableUpdate) {
appendSql( "insert into " );
appendSql( optionalTableUpdate.getMutatingTable().getTableName() );
appendSql( " (" );

final List<ColumnValueBinding> keyBindings = optionalTableUpdate.getKeyBindings();
for ( ColumnValueBinding keyBinding : keyBindings ) {
appendSql( keyBinding.getColumnReference().getColumnExpression() );
appendSql( ',' );
}

optionalTableUpdate.forEachValueBinding( (columnPosition, columnValueBinding) -> {
appendSql( columnValueBinding.getColumnReference().getColumnExpression() );
if ( columnPosition != optionalTableUpdate.getValueBindings().size() - 1 ) {
appendSql( ',' );
}
} );

appendSql( ") values (" );

for ( ColumnValueBinding keyBinding : keyBindings ) {
keyBinding.getValueExpression().accept( this );
appendSql( ',' );
}

optionalTableUpdate.forEachValueBinding( (columnPosition, columnValueBinding) -> {
if ( columnPosition > 0 ) {
appendSql( ',' );
}
columnValueBinding.getValueExpression().accept( this );
} );
appendSql( ") as " );
renderAlias();
appendSql( " " );
}

protected void renderAlias() {
appendSql( "tr" );
}

protected void renderOnDuplicateKeyUpdate(OptionalTableUpdate optionalTableUpdate) {
appendSql( "on duplicate key update " );
optionalTableUpdate.forEachValueBinding( (columnPosition, columnValueBinding) -> {
final String columnName = columnValueBinding.getColumnReference().getColumnExpression();
if ( columnPosition > 0 ) {
appendSql( ',' );
}
appendSql( columnName );
append( " = " );
renderNonVersionedUpdate( columnValueBinding );
} );
}

private void renderNonVersionedUpdate(ColumnValueBinding columnValueBinding) {
renderAlias();
appendSql( "." );
appendSql( columnValueBinding.getColumnReference().getColumnExpression() );
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public class DeleteOrUpsertOperation implements SelfExecutingUpdateOperation {

private final OptionalTableUpdate optionalTableUpdate;

private final Expectation expectation = new Expectation.RowCount();
private final Expectation expectation = getExpectation();

public DeleteOrUpsertOperation(
EntityMutationTarget mutationTarget,
Expand Down Expand Up @@ -127,7 +127,7 @@ private void performDelete(JdbcValueBindings jdbcValueBindings, SharedSessionCon
.executeUpdate( upsertDeleteStatement, statementDetails.getSqlString() );
MODEL_MUTATION_LOGGER.tracef( "`%s` rows upsert-deleted from `%s`", rowCount, tableMapping.getTableName() );
try {
expectation.verifyOutcome( rowCount, upsertDeleteStatement, -1, statementDetails.getSqlString() );
getExpectation().verifyOutcome( rowCount, upsertDeleteStatement, -1, statementDetails.getSqlString() );
}
catch (SQLException e) {
throw jdbcServices.getSqlExceptionHelper().convert(
Expand Down Expand Up @@ -203,7 +203,7 @@ private void performUpsert(JdbcValueBindings jdbcValueBindings, SharedSessionCon
.executeUpdate( updateStatement, statementDetails.getSqlString() );
MODEL_MUTATION_LOGGER.tracef( "`%s` rows upserted into `%s`", rowCount, tableMapping.getTableName() );
try {
expectation.verifyOutcome( rowCount, updateStatement, -1, statementDetails.getSqlString() );
getExpectation().verifyOutcome( rowCount, updateStatement, -1, statementDetails.getSqlString() );
}
catch (SQLException e) {
throw jdbcServices.getSqlExceptionHelper().convert(
Expand Down Expand Up @@ -231,4 +231,8 @@ public UpsertOperation getUpsertOperation() {
public OptionalTableUpdate getOptionalTableUpdate() {
return optionalTableUpdate;
}

protected Expectation getExpectation() {
return new Expectation.RowCount();
}
}
Loading
Loading