Support MySQL 8

Author: nakamura-to

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        driver: [h2, mysql, postgresql, sqlserver, oracle]
+        driver: [h2, mysql, mysql8, postgresql, sqlserver, oracle]
     timeout-minutes: 15
 
     steps:

build.gradle.kts

@@ -312,6 +312,10 @@ configure(integrationTestProjects) {
             prepare("mysql")
         }
 
+        val mysql8 by registering(Test::class) {
+            prepare("mysql8")
+        }
+
         val oracle by registering(Test::class) {
             prepare("oracle")
         }

doma-core/src/main/java/org/seasar/doma/internal/jdbc/dialect/MysqlForUpdateTransformer.java

@@ -1,15 +1,29 @@
 package org.seasar.doma.internal.jdbc.dialect;
 
+import java.util.Objects;
 import org.seasar.doma.internal.jdbc.sql.node.ForUpdateClauseNode;
+import org.seasar.doma.internal.jdbc.sql.node.FragmentNode;
 import org.seasar.doma.internal.jdbc.sql.node.SelectStatementNode;
 import org.seasar.doma.jdbc.SelectForUpdateType;
 import org.seasar.doma.jdbc.SqlNode;
+import org.seasar.doma.jdbc.dialect.MysqlDialect;
 
 public class MysqlForUpdateTransformer extends StandardForUpdateTransformer {
 
+  private final MysqlDialect.MySqlVersion version;
+
   public MysqlForUpdateTransformer(
       SelectForUpdateType forUpdateType, int waitSeconds, String... aliases) {
+    this(forUpdateType, waitSeconds, aliases, MysqlDialect.DEFAULT_VERSION);
+  }
+
+  public MysqlForUpdateTransformer(
+      SelectForUpdateType forUpdateType,
+      int waitSeconds,
+      String[] aliases,
+      MysqlDialect.MySqlVersion version) {
     super(forUpdateType, waitSeconds, aliases);
+    this.version = Objects.requireNonNull(version);
   }
 
   @Override
@@ -19,17 +33,39 @@ public SqlNode visitSelectStatementNode(SelectStatementNode node, Void p) {
     }
     processed = true;
 
-    ForUpdateClauseNode forUpdate = new ForUpdateClauseNode("for update");
-
     SelectStatementNode result = new SelectStatementNode();
     result.setSelectClauseNode(node.getSelectClauseNode());
     result.setFromClauseNode(node.getFromClauseNode());
     result.setWhereClauseNode(node.getWhereClauseNode());
     result.setGroupByClauseNode(node.getGroupByClauseNode());
     result.setHavingClauseNode(node.getHavingClauseNode());
     result.setOrderByClauseNode(node.getOrderByClauseNode());
-    result.setForUpdateClauseNode(forUpdate);
+    result.setForUpdateClauseNode(createForUpdateClauseNode());
     result.setOptionClauseNode(node.getOptionClauseNode());
     return result;
   }
+
+  protected ForUpdateClauseNode createForUpdateClauseNode() {
+    ForUpdateClauseNode forUpdate = new ForUpdateClauseNode("for update");
+    switch (version) {
+      case V5:
+        break;
+      case V8:
+        StringBuilder buf = new StringBuilder(100);
+        if (aliases.length > 0) {
+          buf.append(" of ");
+          for (String alias : aliases) {
+            buf.append(alias);
+            buf.append(", ");
+          }
+          buf.setLength(buf.length() - 2);
+        }
+        if (forUpdateType == SelectForUpdateType.NOWAIT) {
+          buf.append(" nowait ");
+        }
+        forUpdate.appendNode(new FragmentNode(buf.toString()));
+        break;
+    }
+    return forUpdate;
+  }
 }

doma-core/src/main/java/org/seasar/doma/jdbc/dialect/MysqlDialect.java

@@ -4,6 +4,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.Objects;
 import java.util.Set;
 import org.seasar.doma.DomaNullPointerException;
 import org.seasar.doma.expr.ExpressionFunctions;
@@ -34,35 +35,84 @@ public class MysqlDialect extends StandardDialect {
   /** the quotation mark of the end */
   protected static final char CLOSE_QUOTE = '`';
 
+  public static final MySqlVersion DEFAULT_VERSION = MySqlVersion.V5;
+
+  protected final MySqlVersion version;
+
   public MysqlDialect() {
+    this(DEFAULT_VERSION);
+  }
+
+  public MysqlDialect(MySqlVersion version) {
     this(
         new MysqlJdbcMappingVisitor(),
         new MysqlSqlLogFormattingVisitor(),
-        new MysqlExpressionFunctions());
+        new MysqlExpressionFunctions(),
+        version);
   }
 
   public MysqlDialect(JdbcMappingVisitor jdbcMappingVisitor) {
-    this(jdbcMappingVisitor, new MysqlSqlLogFormattingVisitor(), new MysqlExpressionFunctions());
+    this(jdbcMappingVisitor, DEFAULT_VERSION);
+  }
+
+  public MysqlDialect(JdbcMappingVisitor jdbcMappingVisitor, MySqlVersion version) {
+    this(
+        jdbcMappingVisitor,
+        new MysqlSqlLogFormattingVisitor(),
+        new MysqlExpressionFunctions(),
+        version);
   }
 
   public MysqlDialect(SqlLogFormattingVisitor sqlLogFormattingVisitor) {
-    this(new MysqlJdbcMappingVisitor(), sqlLogFormattingVisitor, new MysqlExpressionFunctions());
+    this(sqlLogFormattingVisitor, DEFAULT_VERSION);
+  }
+
+  public MysqlDialect(SqlLogFormattingVisitor sqlLogFormattingVisitor, MySqlVersion version) {
+    this(
+        new MysqlJdbcMappingVisitor(),
+        sqlLogFormattingVisitor,
+        new MysqlExpressionFunctions(),
+        version);
   }
 
   public MysqlDialect(ExpressionFunctions expressionFunctions) {
-    this(new MysqlJdbcMappingVisitor(), new MysqlSqlLogFormattingVisitor(), expressionFunctions);
+    this(expressionFunctions, DEFAULT_VERSION);
+  }
+
+  public MysqlDialect(ExpressionFunctions expressionFunctions, MySqlVersion version) {
+    this(
+        new MysqlJdbcMappingVisitor(),
+        new MysqlSqlLogFormattingVisitor(),
+        expressionFunctions,
+        version);
   }
 
   public MysqlDialect(
       JdbcMappingVisitor jdbcMappingVisitor, SqlLogFormattingVisitor sqlLogFormattingVisitor) {
-    this(jdbcMappingVisitor, sqlLogFormattingVisitor, new MysqlExpressionFunctions());
+    this(jdbcMappingVisitor, sqlLogFormattingVisitor, DEFAULT_VERSION);
+  }
+
+  public MysqlDialect(
+      JdbcMappingVisitor jdbcMappingVisitor,
+      SqlLogFormattingVisitor sqlLogFormattingVisitor,
+      MySqlVersion version) {
+    this(jdbcMappingVisitor, sqlLogFormattingVisitor, new MysqlExpressionFunctions(), version);
   }
 
   public MysqlDialect(
       JdbcMappingVisitor jdbcMappingVisitor,
       SqlLogFormattingVisitor sqlLogFormattingVisitor,
       ExpressionFunctions expressionFunctions) {
+    this(jdbcMappingVisitor, sqlLogFormattingVisitor, expressionFunctions, DEFAULT_VERSION);
+  }
+
+  public MysqlDialect(
+      JdbcMappingVisitor jdbcMappingVisitor,
+      SqlLogFormattingVisitor sqlLogFormattingVisitor,
+      ExpressionFunctions expressionFunctions,
+      MySqlVersion version) {
     super(jdbcMappingVisitor, sqlLogFormattingVisitor, expressionFunctions);
+    this.version = Objects.requireNonNull(version);
   }
 
   @Override
@@ -91,7 +141,14 @@ public boolean supportsIdentity() {
 
   @Override
   public boolean supportsSelectForUpdate(SelectForUpdateType type, boolean withTargets) {
-    return type == SelectForUpdateType.NORMAL && !withTargets;
+    switch (version) {
+      case V5:
+        return type == SelectForUpdateType.NORMAL && !withTargets;
+      case V8:
+        return type == SelectForUpdateType.NORMAL || type == SelectForUpdateType.NOWAIT;
+      default:
+        throw new IllegalStateException(version.toString());
+    }
   }
 
   @Override
@@ -101,8 +158,15 @@ public boolean supportsAliasInDeleteClause() {
 
   @Override
   protected SqlNode toCountCalculatingSqlNode(SqlNode sqlNode) {
-    MysqlCountCalculatingTransformer transformer = new MysqlCountCalculatingTransformer();
-    return transformer.transform(sqlNode);
+    switch (version) {
+      case V5:
+        MysqlCountCalculatingTransformer transformer = new MysqlCountCalculatingTransformer();
+        return transformer.transform(sqlNode);
+      case V8:
+        return super.toCountCalculatingSqlNode(sqlNode);
+      default:
+        throw new IllegalStateException(version.toString());
+    }
   }
 
   @Override
@@ -121,8 +185,15 @@ protected SqlNode toForUpdateSqlNode(
 
   @Override
   protected SqlNode toCountGettingSqlNode(SqlNode sqlNode) {
-    MysqlCountGettingTransformer transformer = new MysqlCountGettingTransformer();
-    return transformer.transform(sqlNode);
+    switch (version) {
+      case V5:
+        MysqlCountGettingTransformer transformer = new MysqlCountGettingTransformer();
+        return transformer.transform(sqlNode);
+      case V8:
+        return super.toCountGettingSqlNode(sqlNode);
+      default:
+        throw new IllegalStateException(version.toString());
+    }
   }
 
   @Override
@@ -179,6 +250,7 @@ protected MysqlScriptBlockContext() {
   }
 
   public static class MysqlCriteriaBuilder extends StandardCriteriaBuilder {
+
     @Override
     public void offsetAndFetch(PreparedSqlBuilder buf, int offset, int limit) {
       buf.appendSql(" limit ");
@@ -196,4 +268,9 @@ public void offsetAndFetch(PreparedSqlBuilder buf, int offset, int limit) {
   public UpsertAssembler getUpsertAssembler(UpsertAssemblerContext context) {
     return new MysqlUpsertAssembler(context);
   }
+
+  public enum MySqlVersion {
+    V5,
+    V8
+  }
 }

doma-core/src/test/java/org/seasar/doma/internal/jdbc/dialect/MysqlForUpdateTransformerTest.java

@@ -11,6 +11,7 @@
 import org.seasar.doma.jdbc.SelectForUpdateType;
 import org.seasar.doma.jdbc.SqlKind;
 import org.seasar.doma.jdbc.SqlNode;
+import org.seasar.doma.jdbc.dialect.MysqlDialect;
 
 public class MysqlForUpdateTransformerTest {
 
@@ -26,4 +27,32 @@ public void testForUpdateNormal() {
     PreparedSql sql = sqlBuilder.build(sqlNode, Function.identity());
     assertEquals(expected, sql.getRawSql());
   }
+
+  @Test
+  public void testForUpdateNowait_v8() {
+    String expected = "select * from emp order by emp.id for update nowait";
+    MysqlForUpdateTransformer transformer =
+        new MysqlForUpdateTransformer(
+            SelectForUpdateType.NOWAIT, 0, new String[] {}, MysqlDialect.MySqlVersion.V8);
+    SqlParser parser = new SqlParser("select * from emp order by emp.id");
+    SqlNode sqlNode = transformer.transform(parser.parse());
+    NodePreparedSqlBuilder sqlBuilder =
+        new NodePreparedSqlBuilder(new MockConfig(), SqlKind.SELECT, "dummyPath");
+    PreparedSql sql = sqlBuilder.build(sqlNode, Function.identity());
+    assertEquals(expected, sql.getRawSql());
+  }
+
+  @Test
+  public void testForUpdateNowait_alias_v8() {
+    String expected = "select * from emp order by emp.id for update of emp nowait";
+    MysqlForUpdateTransformer transformer =
+        new MysqlForUpdateTransformer(
+            SelectForUpdateType.NOWAIT, 0, new String[] {"emp"}, MysqlDialect.MySqlVersion.V8);
+    SqlParser parser = new SqlParser("select * from emp order by emp.id");
+    SqlNode sqlNode = transformer.transform(parser.parse());
+    NodePreparedSqlBuilder sqlBuilder =
+        new NodePreparedSqlBuilder(new MockConfig(), SqlKind.SELECT, "dummyPath");
+    PreparedSql sql = sqlBuilder.build(sqlNode, Function.identity());
+    assertEquals(expected, sql.getRawSql());
+  }
 }

gradle.properties

@@ -17,6 +17,7 @@ testUseModule=false
 driver=h2
 h2.url=jdbc:h2:mem:test;DB_CLOSE_DELAY=-1
 mysql.url=jdbc:tc:mysql:5.7:///test?TC_DAEMON=true&allowMultiQueries=true
+mysql8.url=jdbc:tc:mysql:8.0.36:///test?TC_MY_CNF=mysql_conf_override&TC_DAEMON=true&allowMultiQueries=true
 oracle.url=jdbc:tc:oracle:thin:@test?TC_DAEMON=true
 postgresql.url=jdbc:tc:postgresql:10.16:///test?TC_DAEMON=true
 sqlserver.url=jdbc:tc:sqlserver:2019-CU12-ubuntu-20.04:///test?TC_DAEMON=true

integration-test-common/src/main/java/org/seasar/doma/it/Dbms.java

@@ -9,6 +9,8 @@ public enum Dbms {
 
   MYSQL,
 
+  MYSQL8,
+
   POSTGRESQL,
 
   SQLSERVER,

integration-test-common/src/main/java/org/seasar/doma/it/IntegrationTestEnvironment.java

@@ -69,6 +69,8 @@ private static Dbms determineDbms(String driver) {
         return Dbms.H2;
       case "mysql":
         return Dbms.MYSQL;
+      case "mysql8":
+        return Dbms.MYSQL8;
       case "oracle":
         return Dbms.ORACLE;
       case "postgresql":
@@ -90,6 +92,8 @@ private static Dialect createDialect(Dbms dbms) {
         return new SqliteDialect();
       case MYSQL:
         return new MysqlDialect();
+      case MYSQL8:
+        return new MysqlDialect(MysqlDialect.MySqlVersion.V8);
       case POSTGRESQL:
         return new PostgresDialect();
       case SQLSERVER:

integration-test-java-additional/src/test/resources/mysql_conf_override/my.cnf

@@ -0,0 +1,2 @@
+[mysqld]
+log_bin_trust_function_creators=ON

integration-test-java/src/test/java/org/seasar/doma/it/auto/AutoBatchInsertTest.java

@@ -209,7 +209,7 @@ public void testId_Identity_ignoreGeneratedKeys(Config config) throws Exception
   }
 
   @Test
-  @Run(unless = {Dbms.MYSQL, Dbms.SQLSERVER, Dbms.SQLITE})
+  @Run(unless = {Dbms.MYSQL, Dbms.MYSQL8, Dbms.SQLSERVER, Dbms.SQLITE})
   public void testId_sequence(Config config) throws Exception {
     SequenceStrategyDao dao = new SequenceStrategyDaoImpl(config);
     for (int i = 0; i < 110; i++) {