Skip to content

HHH-19498 - improve upserts on MySQL and Maria - WIP #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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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,10 @@ public boolean supportsWithClauseInSubquery() {
return false;
}

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

}
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,10 @@ public boolean supportsRowValueConstructorSyntaxInQuantifiedPredicates() {
return false;
}

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

}
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,87 @@
/*
* SPDX-License-Identifier: Apache-2.0
* Copyright Red Hat Inc. and Hibernate Authors
*/
package org.hibernate.dialect.sql.ast;


import org.hibernate.engine.spi.SessionFactoryImplementor;
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.ast.ColumnValueBinding;
import org.hibernate.sql.model.internal.OptionalTableUpdate;

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
protected void renderUpsertStatement(OptionalTableUpdate optionalTableUpdate) {
// INSERT INTO employees (id, name, salary)
// VALUES (1, 'Alice', 50000)
// ON DUPLICATE KEY UPDATE
// name = VALUES(name),
// salary = VALUES(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( ")" );
}

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

}
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,19 @@

import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import org.hibernate.dialect.MariaDBDialect;
import org.hibernate.dialect.MySQLDialect;
import org.hibernate.testing.jdbc.SQLStatementInspector;
import org.hibernate.testing.orm.junit.DomainModel;
import org.hibernate.testing.orm.junit.RequiresDialect;
import org.hibernate.testing.orm.junit.RequiresDialects;
import org.hibernate.testing.orm.junit.SessionFactory;
import org.hibernate.testing.orm.junit.SessionFactoryScope;
import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;

@SessionFactory
@SessionFactory(useCollectingStatementInspector = true)
@DomainModel(annotatedClasses = UpsertTest.Record.class)
public class UpsertTest {
@Test void test(SessionFactoryScope scope) {
Expand All @@ -25,14 +30,45 @@ public class UpsertTest {
assertEquals("hello earth", s.get( Record.class,123L).message);
assertEquals("hello mars", s.get( Record.class,456L).message);
});
scope.inStatelessTransaction(s-> {
s.upsert(new Record(123L,"goodbye earth"));
});
scope.inStatelessTransaction(s-> s.upsert(new Record(123L,"goodbye earth")) );
scope.inStatelessTransaction(s-> {
assertEquals("goodbye earth", s.get( Record.class,123L).message);
assertEquals("hello mars", s.get( Record.class,456L).message);
});
}

@RequiresDialects(
value = {
@RequiresDialect( MySQLDialect.class ),
@RequiresDialect( MariaDBDialect.class )
}
)
@Test void testMySQL(SessionFactoryScope scope) {
SQLStatementInspector statementInspector = scope.getCollectingStatementInspector();
statementInspector.clear();

scope.inStatelessTransaction(s-> {
s.upsert(new Record(123L,"hello earth"));
s.upsert(new Record(456L,"hello mars"));
});
// Verify that only a single query is executed for each upsert, in contrast to the former update+insert
statementInspector.assertExecutedCount( 2 );

scope.inStatelessTransaction(s-> {
assertEquals("hello earth",s.get(Record.class,123L).message);
assertEquals("hello mars",s.get(Record.class,456L).message);
});
statementInspector.clear();

scope.inStatelessTransaction(s-> s.upsert(new Record(123L,"goodbye earth")) );
statementInspector.assertExecutedCount( 1 );

scope.inStatelessTransaction(s-> {
assertEquals("goodbye earth",s.get(Record.class,123L).message);
assertEquals("hello mars",s.get(Record.class,456L).message);
});
}

@Entity
static class Record {
@Id Long id;
Expand Down
Loading