Support for MySQL storage (#5411)

* Adding Mysql support - initial commit

* Fix for NPE when state.handle is null

* Bump maven version in mvn-wrapper.properties to 3.9.8

* Fixing code related to MySQL support after IT failures

* spotless:apply

* adding 101 upgrade

* Fixing `groups` keyword escape by backquotes

* applying spotless fixes

Author: Yoni-Weisberg

.mvn/wrapper/maven-wrapper.properties

@@ -1,2 +1,2 @@
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.2/apache-maven-3.8.2-bin.zip
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.8/apache-maven-3.9.8-bin.zip
 wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar

app/pom.xml

@@ -151,6 +151,10 @@
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-jdbc-postgresql</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-jdbc-mysql</artifactId>
+    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-jdbc-h2</artifactId>
@@ -310,6 +314,11 @@
       <artifactId>mssqlserver</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.testcontainers</groupId>
+      <artifactId>mysql</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.awaitility</groupId>
       <artifactId>awaitility</artifactId>

app/src/main/java/io/apicurio/registry/storage/impl/sql/AbstractSqlRegistryStorage.java

@@ -943,13 +943,8 @@ public ArtifactSearchResultsDto searchArtifacts(Set<SearchFilter> filters, Order
         return handles.withHandleNoException(handle -> {
             List<SqlStatementVariableBinder> binders = new LinkedList<>();
 
-            StringBuilder selectTemplate = new StringBuilder();
             StringBuilder where = new StringBuilder();
             StringBuilder orderByQuery = new StringBuilder();
-            StringBuilder limitOffset = new StringBuilder();
-
-            // Formulate the SELECT clause for the artifacts query
-            selectTemplate.append("SELECT {{selectColumns}} FROM artifacts a ");
 
             // Formulate the WHERE clause for both queries
             String op;
@@ -1081,19 +1076,13 @@ public ArtifactSearchResultsDto searchArtifacts(Set<SearchFilter> filters, Order
             }
             orderByQuery.append(" ").append(orderDirection.name());
 
-            // Add limit and offset to artifact query
-            if ("mssql".equals(sqlStatements.dbType())) {
-                limitOffset.append(" OFFSET ? ROWS FETCH NEXT ? ROWS ONLY");
-            } else {
-                limitOffset.append(" LIMIT ? OFFSET ?");
-            }
-
             // Query for the artifacts
-            String artifactsQuerySql = new StringBuilder(selectTemplate).append(where).append(orderByQuery)
-                    .append(limitOffset).toString().replace("{{selectColumns}}", "a.*");
+            String artifactsQuerySql = sqlStatements.selectTableTemplate("a.*", "artifacts", "a",
+                    where.toString(), orderByQuery.toString());
             Query artifactsQuery = handle.createQuery(artifactsQuerySql);
-            String countQuerySql = new StringBuilder(selectTemplate).append(where).toString()
-                    .replace("{{selectColumns}}", "count(a.artifactId)");
+
+            String countQuerySql = sqlStatements.selectCountTableTemplate("a.artifactId", "artifacts", "a",
+                    where.toString());
             Query countQuery = handle.createQuery(countQuerySql);
 
             // Bind all query parameters
@@ -2803,13 +2792,8 @@ public GroupSearchResultsDto searchGroups(Set<SearchFilter> filters, OrderBy ord
             List<SqlStatementVariableBinder> binders = new LinkedList<>();
             String op;
 
-            StringBuilder selectTemplate = new StringBuilder();
             StringBuilder where = new StringBuilder();
             StringBuilder orderByQuery = new StringBuilder();
-            StringBuilder limitOffset = new StringBuilder();
-
-            // Formulate the SELECT clause for the artifacts query
-            selectTemplate.append("SELECT {{selectColumns}} FROM groups g ");
 
             // Formulate the WHERE clause for both queries
             where.append(" WHERE (1 = 1)");
@@ -2872,20 +2856,13 @@ public GroupSearchResultsDto searchGroups(Set<SearchFilter> filters, OrderBy ord
             }
             orderByQuery.append(" ").append(orderDirection.name());
 
-            // Add limit and offset to query
-            if ("mssql".equals(sqlStatements.dbType())) {
-                limitOffset.append(" OFFSET ? ROWS FETCH NEXT ? ROWS ONLY");
-            } else {
-                limitOffset.append(" LIMIT ? OFFSET ?");
-            }
-
             // Query for the group
-            String groupsQuerySql = new StringBuilder(selectTemplate).append(where).append(orderByQuery)
-                    .append(limitOffset).toString().replace("{{selectColumns}}", "*");
+            String groupsQuerySql = sqlStatements.selectTableTemplate("*", "groups", "g", where.toString(),
+                    orderByQuery.toString());
             Query groupsQuery = handle.createQuery(groupsQuerySql);
             // Query for the total row count
-            String countQuerySql = new StringBuilder(selectTemplate).append(where).toString()
-                    .replace("{{selectColumns}}", "count(g.groupId)");
+            String countQuerySql = sqlStatements.selectCountTableTemplate("g.groupId", "groups", "g",
+                    where.toString());
             Query countQuery = handle.createQuery(countQuerySql);
 
             // Bind all query parameters
@@ -3254,6 +3231,10 @@ private long nextCommentIdRaw(Handle handle) {
     private long nextSequenceValueRaw(Handle handle, String sequenceName) {
         if (isH2()) {
             return sequenceCounters.get(sequenceName).incrementAndGet();
+        } else if (isMysql()) {
+            handle.createUpdate(sqlStatements.getNextSequenceValue()).bind(0, sequenceName).execute();
+            return handle.createQuery(sqlStatements.selectCurrentSequenceValue()).bind(0, sequenceName)
+                    .mapTo(Long.class).one();
         } else {
             return handle.createQuery(sqlStatements.getNextSequenceValue()).bind(0, sequenceName)
                     .mapTo(Long.class).one(); // TODO Handle non-existing sequence (see resetSequence)
@@ -3389,13 +3370,8 @@ public BranchSearchResultsDto getBranches(GA ga, int offset, int limit) {
         return handles.withHandleNoException(handle -> {
             List<SqlStatementVariableBinder> binders = new LinkedList<>();
 
-            StringBuilder selectTemplate = new StringBuilder();
             StringBuilder where = new StringBuilder();
             StringBuilder orderByQuery = new StringBuilder();
-            StringBuilder limitOffset = new StringBuilder();
-
-            // Formulate the SELECT clause for the artifacts query
-            selectTemplate.append("SELECT {{selectColumns}} FROM branches b ");
 
             // Formulate the WHERE clause for both queries
             where.append(" WHERE b.groupId = ? AND b.artifactId = ?");
@@ -3409,20 +3385,13 @@ public BranchSearchResultsDto getBranches(GA ga, int offset, int limit) {
             // Add order by to artifact query
             orderByQuery.append(" ORDER BY b.branchId ASC");
 
-            // Add limit and offset to query
-            if ("mssql".equals(sqlStatements.dbType())) {
-                limitOffset.append(" OFFSET ? ROWS FETCH NEXT ? ROWS ONLY");
-            } else {
-                limitOffset.append(" LIMIT ? OFFSET ?");
-            }
-
-            // Query for the branc
-            String branchesQuerySql = new StringBuilder(selectTemplate).append(where).append(orderByQuery)
-                    .append(limitOffset).toString().replace("{{selectColumns}}", "*");
+            // Query for the artifacts
+            String branchesQuerySql = sqlStatements.selectTableTemplate("*", "branches", "b",
+                    where.toString(), orderByQuery.toString());
             Query branchesQuery = handle.createQuery(branchesQuerySql);
-            // Query for the total row count
-            String countQuerySql = new StringBuilder(selectTemplate).append(where).toString()
-                    .replace("{{selectColumns}}", "count(b.branchId)");
+
+            String countQuerySql = sqlStatements.selectCountTableTemplate("b.branchId", "branches", "b",
+                    where.toString());
             Query countQuery = handle.createQuery(countQuerySql);
 
             // Bind all query parameters
@@ -3646,7 +3615,7 @@ private void createOrUpdateBranchRaw(Handle handle, GAV gav, BranchId branchId,
 
     /**
      * Removes a version from the given branch.
-     * 
+     *
      * @param handle
      * @param gav
      * @param branchId
@@ -3791,6 +3760,10 @@ private boolean isH2() {
         return sqlStatements.dbType().equals("h2");
     }
 
+    private boolean isMysql() {
+        return sqlStatements.dbType().equals("mysql");
+    }
+
     /*
      * Ensures that only a reasonable number/size of labels for each item in the list are returned. This is to
      * guard against an unexpectedly enormous response size to a REST API search operation.

app/src/main/java/io/apicurio/registry/storage/impl/sql/CommonSqlStatements.java

@@ -138,7 +138,7 @@ public String insertVersion(boolean firstVersion) {
         } else {
             // NOTE: Duplicated value of versionOrder is prevented by UQ_versions_2 constraint.
             query = "INSERT INTO versions (globalId, groupId, artifactId, version, versionOrder, state, name, description, owner, createdOn, modifiedBy, modifiedOn, labels, contentId)"
-                    + " VALUES (?, ?, ?, ?, (SELECT MAX(versionOrder) + 1 FROM versions WHERE groupId = ? AND artifactId = ?), ?, ?, ?, ?, ?, ?, ?, ?, ?)";
+                    + " VALUES (?, ?, ?, ?, (SELECT maxVer FROM (SELECT MAX(versionOrder) + 1 AS maxVer FROM versions WHERE groupId = ? AND artifactId = ?) temp), ?, ?, ?, ?, ?, ?, ?, ?, ?)";
         }
         return query;
     }
@@ -581,7 +581,7 @@ public String selectArtifactCountById() {
      */
     @Override
     public String selectGroupCountById() {
-        return "SELECT COUNT(g.groupId) FROM groups g WHERE g.groupId = ?";
+        return "SELECT COUNT(g.groupId) FROM " + groupsTable() + " g WHERE g.groupId = ?";
     }
 
     /**
@@ -669,47 +669,49 @@ public String insertContentReference() {
      */
     @Override
     public String insertGroup() {
-        return "INSERT INTO groups (groupId, description, artifactsType, owner, createdOn, modifiedBy, modifiedOn, labels) VALUES (?, ?, ?, ?, ?, ?, ?, ?)";
+        return "INSERT INTO " + groupsTable()
+                + " (groupId, description, artifactsType, owner, createdOn, modifiedBy, modifiedOn, labels) VALUES (?, ?, ?, ?, ?, ?, ?, ?)";
     }
 
     /**
      * @see io.apicurio.registry.storage.impl.sql.SqlStatements#updateGroup()
      */
     @Override
     public String updateGroup() {
-        return "UPDATE groups SET description = ? , modifiedBy = ? , modifiedOn = ? , labels = ? WHERE groupId = ?";
+        return "UPDATE " + groupsTable()
+                + " SET description = ? , modifiedBy = ? , modifiedOn = ? , labels = ? WHERE groupId = ?";
     }
 
     /**
      * @see io.apicurio.registry.storage.impl.sql.SqlStatements#deleteGroup()
      */
     @Override
     public String deleteGroup() {
-        return "DELETE FROM groups WHERE groupId = ?";
+        return "DELETE FROM " + groupsTable() + " WHERE groupId = ?";
     }
 
     /**
      * @see SqlStatements#deleteAllGroups()
      */
     @Override
     public String deleteAllGroups() {
-        return "DELETE FROM groups ";
+        return "DELETE FROM " + groupsTable() + " ";
     }
 
     /**
      * @see io.apicurio.registry.storage.impl.sql.SqlStatements#selectGroups()
      */
     @Override
     public String selectGroups() {
-        return "SELECT g.* FROM groups g ORDER BY g.groupId ASC LIMIT ?";
+        return "SELECT g.* FROM " + groupsTable() + " g ORDER BY g.groupId ASC LIMIT ?";
     }
 
     /**
      * @see io.apicurio.registry.storage.impl.sql.SqlStatements#selectGroupByGroupId()
      */
     @Override
     public String selectGroupByGroupId() {
-        return "SELECT g.* FROM groups g WHERE g.groupId = ?";
+        return "SELECT g.* FROM " + groupsTable() + " g WHERE g.groupId = ?";
     }
 
     @Override
@@ -767,7 +769,7 @@ public String exportGlobalRules() {
      */
     @Override
     public String exportGroups() {
-        return "SELECT * FROM groups g ";
+        return "SELECT * FROM " + groupsTable() + " g ";
     }
 
     @Override
@@ -818,7 +820,8 @@ public String importGlobalRule() {
      */
     @Override
     public String importGroup() {
-        return "INSERT INTO groups (groupId, description, artifactsType, owner, createdOn, modifiedBy, modifiedOn, labels) "
+        return "INSERT INTO " + groupsTable()
+                + " (groupId, description, artifactsType, owner, createdOn, modifiedBy, modifiedOn, labels) "
                 + "VALUES (?, ?, ?, ?, ?, ?, ?, ?)";
     }
 
@@ -1210,4 +1213,21 @@ public String createOutboxEvent() {
     public String deleteOutboxEvent() {
         return "DELETE FROM outbox WHERE id = ?";
     }
+
+    @Override
+    public String selectCountTableTemplate(String countBy, String tableName, String alias,
+            String whereClause) {
+        return "SELECT COUNT(%s) FROM %s %s %s".formatted(countBy, tableName, alias, whereClause);
+    }
+
+    @Override
+    public String selectTableTemplate(String columns, String tableName, String alias, String whereClause,
+            String orderBy) {
+        return "SELECT %s FROM %s %s %s %s LIMIT ? OFFSET ?".formatted(columns, tableName, alias, whereClause,
+                orderBy);
+    }
+
+    protected String groupsTable() {
+        return "groups";
+    }
 }

app/src/main/java/io/apicurio/registry/storage/impl/sql/MySQLSqlStatements.java

@@ -0,0 +1,98 @@
+package io.apicurio.registry.storage.impl.sql;
+
+/**
+ * MySQL implementation of the sql statements interface. Provides sql statements that are specific to MySQL,
+ * where applicable.
+ */
+public class MySQLSqlStatements extends CommonSqlStatements {
+
+    /**
+     * Constructor.
+     */
+    public MySQLSqlStatements() {
+    }
+
+    /**
+     * @see io.apicurio.registry.storage.impl.sql.SqlStatements#dbType()
+     */
+    @Override
+    public String dbType() {
+        return "mysql";
+    }
+
+    /**
+     * @see io.apicurio.registry.storage.impl.sql.SqlStatements#isPrimaryKeyViolation(java.lang.Exception)
+     */
+    @Override
+    public boolean isPrimaryKeyViolation(Exception error) {
+        return error.getMessage().contains("Duplicate entry");
+    }
+
+    /**
+     * @see io.apicurio.registry.storage.impl.sql.SqlStatements#isForeignKeyViolation(java.lang.Exception)
+     */
+    @Override
+    public boolean isForeignKeyViolation(Exception error) {
+        return error.getMessage().contains("foreign key constraint fails");
+    }
+
+    /**
+     * @see io.apicurio.registry.storage.impl.sql.SqlStatements#isDatabaseInitialized()
+     */
+    @Override
+    public String isDatabaseInitialized() {
+        return "SELECT count(*) AS count FROM information_schema.tables WHERE table_name = 'artifacts'";
+    }
+
+    /**
+     * @see io.apicurio.registry.storage.impl.sql.SqlStatements#getNextSequenceValue()
+     */
+    @Override
+    public String getNextSequenceValue() {
+        return "INSERT INTO sequences (seqName, seqValue) VALUES (?, 1) ON DUPLICATE KEY UPDATE seqValue = seqValue + 1";
+    }
+
+    /**
+     * @see io.apicurio.registry.storage.impl.sql.SqlStatements#resetSequenceValue()
+     */
+    @Override
+    public String resetSequenceValue() {
+        return "INSERT INTO sequences (seqName, seqValue) VALUES (?, ?) ON DUPLICATE KEY UPDATE seqValue = ?";
+    }
+
+    @Override
+    public String upsertBranch() {
+        return """
+                INSERT INTO branches (groupId, artifactId, branchId, description, systemDefined, owner, createdOn, modifiedBy, modifiedOn)
+                VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)
+                ON DUPLICATE KEY UPDATE groupId=VALUES(groupId)
+                """;
+    }
+
+    @Override
+    public String selectCountTableTemplate(String countBy, String tableName, String alias,
+            String whereClause) {
+        return super.selectCountTableTemplate(countBy, "`" + tableName + "`", alias, whereClause);
+    }
+
+    @Override
+    public String selectTableTemplate(String columns, String tableName, String alias, String whereClause,
+            String orderBy) {
+        return super.selectTableTemplate(columns, "`" + tableName + "`", alias, whereClause, orderBy);
+    }
+
+    @Override
+    public String groupsTable() {
+        return "`groups`";
+    }
+
+    @Override
+    public String createDataSnapshot() {
+        throw new IllegalStateException("Snapshot creation is not supported for MySQL storage");
+    }
+
+    @Override
+    public String restoreFromSnapshot() {
+        throw new IllegalStateException("Restoring from snapshot is not supported for MySQL storage");
+    }
+}