Complete the materialized view log implementation of ob mysql in db-browser

Author: zijiacj

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBMViewLogPurgeParameter.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2023 OceanBase.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.oceanbase.tools.dbbrowser.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * @description:
+ * @author: zijia.cj
+ * @date: 2025/7/14 10:22
+ * @since: 4.4.0
+ */
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class DBMViewLogPurgeParameter {
+
+    private String schemaName;
+
+    private String mViewLogName;
+
+}

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBMViewLogPurgeSchedule.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2023 OceanBase.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.oceanbase.tools.dbbrowser.model;
+
+import java.util.Date;
+
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+/**
+ * @description:
+ * @author: zijia.cj
+ * @date: 2025/7/14 15:00
+ * @since: 4.4.0
+ */
+@Data
+@AllArgsConstructor
+@NoArgsConstructor
+public class DBMViewLogPurgeSchedule {
+
+    private StartStrategy startStrategy;
+
+    private Date startWith;
+
+    private Long interval;
+
+    private TimeUnit unit;
+
+    private Date startDate;
+
+    private String nextExpression;
+
+    public enum TimeUnit {
+        SECOND,
+        MINUTE,
+        HOUR,
+        DAY,
+        // just for ob mysql
+        WEEK,
+        MONTH,
+        YEAR;
+    }
+
+    public enum StartStrategy {
+        START_NOW,
+        START_AT;
+    }
+}

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/model/DBMaterializedViewLog.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2023 OceanBase.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.oceanbase.tools.dbbrowser.model;
+
+import java.util.Date;
+
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * @description:
+ * @author: zijia.cj
+ * @date: 2025/7/14 10:24
+ * @since: 4.4.0
+ */
+@Setter
+@Getter
+public class DBMaterializedViewLog implements DBObject {
+
+    private String mViewLogName;
+
+    private String baseTableName;
+    /**
+     * The materialized view log and the base table belong to the same schema. if null, use
+     * defaultSchemaName in current connection.
+     */
+    private String schemaName;
+    /**
+     * The parallelism degree of purging expired data in the materialized view log.
+     */
+    private Long purgeParallelismDegree;
+    /**
+     * The configuration for automatic cleaning, if null, indicates that it is not enabled
+     */
+    private DBMViewLogPurgeSchedule purgeSchedule;
+
+    private Date lastPurgeDate;
+
+    private Boolean includeNewValues;
+
+    @Override
+    public String name() {
+        return this.mViewLogName;
+    }
+
+    @Override
+    public DBObjectType type() {
+        return DBObjectType.MATERIALIZED_VIEW_LOG;
+    }
+}

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/schema/DBSchemaAccessor.java

@@ -21,10 +21,12 @@
 import com.oceanbase.tools.dbbrowser.model.DBColumnGroupElement;
 import com.oceanbase.tools.dbbrowser.model.DBDatabase;
 import com.oceanbase.tools.dbbrowser.model.DBFunction;
+import com.oceanbase.tools.dbbrowser.model.DBMViewLogPurgeParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecord;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecordParam;
 import com.oceanbase.tools.dbbrowser.model.DBMaterializedView;
+import com.oceanbase.tools.dbbrowser.model.DBMaterializedViewLog;
 import com.oceanbase.tools.dbbrowser.model.DBObjectIdentity;
 import com.oceanbase.tools.dbbrowser.model.DBPLObjectIdentity;
 import com.oceanbase.tools.dbbrowser.model.DBPackage;
@@ -168,6 +170,21 @@ default List<String> showExternalTables(String schemaName) {
      */
     List<DBTableIndex> listMViewIndexes(String schemaName, String mViewName);
 
+    /**
+     * List all materialized view logs as DBObjectIdentity in the specified schema
+     */
+    List<DBObjectIdentity> listMViewLogs(String schemaName);
+
+    /**
+     * Purge expired data in the materialized view log
+     */
+    Boolean purgeMViewLog(DBMViewLogPurgeParameter parameter);
+
+    /**
+     * Get materialized view log details
+     */
+    DBMaterializedViewLog getMViewLog(String schemaName, String mViewLogName);
+
     /**
      * List all variables
      */

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/schema/doris/DorisSchemaAccessor.java

@@ -57,10 +57,12 @@
 import com.oceanbase.tools.dbbrowser.model.DBFunction;
 import com.oceanbase.tools.dbbrowser.model.DBIndexAlgorithm;
 import com.oceanbase.tools.dbbrowser.model.DBIndexType;
+import com.oceanbase.tools.dbbrowser.model.DBMViewLogPurgeParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecord;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecordParam;
 import com.oceanbase.tools.dbbrowser.model.DBMaterializedView;
+import com.oceanbase.tools.dbbrowser.model.DBMaterializedViewLog;
 import com.oceanbase.tools.dbbrowser.model.DBObjectIdentity;
 import com.oceanbase.tools.dbbrowser.model.DBObjectType;
 import com.oceanbase.tools.dbbrowser.model.DBPLObjectIdentity;
@@ -119,6 +121,21 @@ public DorisSchemaAccessor(@NonNull JdbcOperations jdbcOperations) {
         this.sqlMapper = DBSchemaAccessorSqlMappers.get(StatementsFiles.MYSQL_5_7_x);
     }
 
+    @Override
+    public List<DBObjectIdentity> listMViewLogs(String schemaName) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
+    @Override
+    public Boolean purgeMViewLog(DBMViewLogPurgeParameter parameter) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
+    @Override
+    public DBMaterializedViewLog getMViewLog(String schemaName, String mViewLogName) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
     @Override
     public List<String> showDatabases() {
         MySQLSqlBuilder sb = new MySQLSqlBuilder();

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/schema/mysql/MySQLNoLessThan5700SchemaAccessor.java

@@ -58,10 +58,12 @@
 import com.oceanbase.tools.dbbrowser.model.DBFunction;
 import com.oceanbase.tools.dbbrowser.model.DBIndexAlgorithm;
 import com.oceanbase.tools.dbbrowser.model.DBIndexType;
+import com.oceanbase.tools.dbbrowser.model.DBMViewLogPurgeParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecord;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecordParam;
 import com.oceanbase.tools.dbbrowser.model.DBMaterializedView;
+import com.oceanbase.tools.dbbrowser.model.DBMaterializedViewLog;
 import com.oceanbase.tools.dbbrowser.model.DBObjectIdentity;
 import com.oceanbase.tools.dbbrowser.model.DBObjectType;
 import com.oceanbase.tools.dbbrowser.model.DBPLObjectIdentity;
@@ -386,6 +388,21 @@ public List<DBTableIndex> listMViewIndexes(String schemaName, String mViewName)
         throw new UnsupportedOperationException("not support yet");
     }
 
+    @Override
+    public List<DBObjectIdentity> listMViewLogs(String schemaName) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
+    @Override
+    public Boolean purgeMViewLog(DBMViewLogPurgeParameter parameter) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
+    @Override
+    public DBMaterializedViewLog getMViewLog(String schemaName, String mViewLogName) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
     @Override
     public List<DBVariable> showVariables() {
         String sql = "show variables";

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/schema/mysql/OBMySQLBetween2277And3XSchemaAccessor.java

@@ -55,7 +55,7 @@
  * @Description: []
  */
 @Slf4j
-public class OBMySQLBetween2277And3XSchemaAccessor extends OBMySQLSchemaAccessor {
+public class OBMySQLBetween2277And3XSchemaAccessor extends OBMySQLBetween400And432SchemaAccessor {
 
     /**
      * 以下对象名为 mysql schema 下的视图，但 table_type='BASE_TYPE'

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/schema/mysql/OBMySQLBetween432And4352SchemaAccessor.java

@@ -20,10 +20,12 @@
 
 import org.springframework.jdbc.core.JdbcOperations;
 
+import com.oceanbase.tools.dbbrowser.model.DBMViewLogPurgeParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecord;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecordParam;
 import com.oceanbase.tools.dbbrowser.model.DBMaterializedView;
+import com.oceanbase.tools.dbbrowser.model.DBMaterializedViewLog;
 import com.oceanbase.tools.dbbrowser.model.DBObjectIdentity;
 import com.oceanbase.tools.dbbrowser.model.DBTableColumn;
 import com.oceanbase.tools.dbbrowser.model.DBTableConstraint;
@@ -41,6 +43,21 @@ public OBMySQLBetween432And4352SchemaAccessor(JdbcOperations jdbcOperations) {
         super(jdbcOperations);
     }
 
+    @Override
+    public List<DBObjectIdentity> listMViewLogs(String schemaName) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
+    @Override
+    public Boolean purgeMViewLog(DBMViewLogPurgeParameter parameter) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
+    @Override
+    public DBMaterializedViewLog getMViewLog(String schemaName, String mViewLogName) {
+        throw new UnsupportedOperationException("not support yet");
+    }
+
     @Override
     public List<DBObjectIdentity> listMViews(String schemaName) {
         throw new UnsupportedOperationException("not support yet");

libs/db-browser/src/main/java/com/oceanbase/tools/dbbrowser/schema/mysql/OBMySQLSchemaAccessor.java

@@ -23,6 +23,7 @@
 import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
+import java.util.regex.Pattern;
 import java.util.stream.Collectors;
 
 import org.apache.commons.collections4.CollectionUtils;
@@ -32,10 +33,13 @@
 import com.oceanbase.tools.dbbrowser.model.DBColumnGroupElement;
 import com.oceanbase.tools.dbbrowser.model.DBDatabase;
 import com.oceanbase.tools.dbbrowser.model.DBIndexAlgorithm;
+import com.oceanbase.tools.dbbrowser.model.DBMViewLogPurgeParameter;
+import com.oceanbase.tools.dbbrowser.model.DBMViewLogPurgeSchedule;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshParameter;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecord;
 import com.oceanbase.tools.dbbrowser.model.DBMViewRefreshRecordParam;
 import com.oceanbase.tools.dbbrowser.model.DBMaterializedView;
+import com.oceanbase.tools.dbbrowser.model.DBMaterializedViewLog;
 import com.oceanbase.tools.dbbrowser.model.DBMaterializedViewRefreshMethod;
 import com.oceanbase.tools.dbbrowser.model.DBObjectIdentity;
 import com.oceanbase.tools.dbbrowser.model.DBObjectType;
@@ -68,6 +72,8 @@
 @Slf4j
 public class OBMySQLSchemaAccessor extends MySQLNoLessThan5700SchemaAccessor {
 
+    private static final String MVIEW_LOG_PREFIX = "mlog$_";
+
     protected static final Set<String> ESCAPE_SCHEMA_SET = new HashSet<>(4);
 
     static {
@@ -82,6 +88,54 @@ public OBMySQLSchemaAccessor(JdbcOperations jdbcOperations) {
         this.sqlMapper = DBSchemaAccessorSqlMappers.get(StatementsFiles.OBMYSQL_432x);
     }
 
+    @Override
+    public List<DBObjectIdentity> listMViewLogs(String schemaName) {
+        MySQLSqlBuilder sb = new MySQLSqlBuilder();
+        sb.append("SELECT LOG_TABLE FROM oceanbase.DBA_MVIEW_LOGS WHERE LOG_OWNER = ")
+                .value(schemaName);
+        return jdbcOperations.query(sb.toString(),
+                (rs, rowNum) -> DBObjectIdentity.of(schemaName, DBObjectType.MATERIALIZED_VIEW_LOG, rs.getString(1)));
+    }
+
+    @Override
+    public Boolean purgeMViewLog(DBMViewLogPurgeParameter parameter) {
+        MySQLSqlBuilder sb = new MySQLSqlBuilder();
+        sb.append("call DBMS_MVIEW.PURGE_LOG('");
+        if (Objects.nonNull(parameter.getSchemaName())) {
+            sb.append(parameter.getSchemaName()).append(".");
+        }
+        sb.append(parameter.getMViewLogName().replaceFirst(Pattern.quote(MVIEW_LOG_PREFIX), "")).append("');");
+        jdbcOperations.execute(sb.toString());
+        return Boolean.TRUE;
+    }
+
+    @Override
+    public DBMaterializedViewLog getMViewLog(String schemaName, String mViewLogName) {
+        MySQLSqlBuilder getOptions = new MySQLSqlBuilder();
+        getOptions.append(
+                "SELECT MASTER,INCLUDE_NEW_VALUES,PURGE_START,PURGE_INTERVAL,LAST_PURGE_DATE,PURGE_DOP FROM OCEANBASE.DBA_MVIEW_LOGS WHERE LOG_OWNER = ")
+                .value(schemaName)
+                .append(" AND LOG_TABLE = ")
+                .value(mViewLogName);
+        DBMaterializedViewLog mViewLog = new DBMaterializedViewLog();
+        mViewLog.setMViewLogName(mViewLogName);
+        mViewLog.setSchemaName(schemaName);
+        jdbcOperations.query(getOptions.toString(), (rs) -> {
+            mViewLog.setBaseTableName(rs.getString("MASTER"));
+            mViewLog.setIncludeNewValues(rs.getBoolean("INCLUDE_NEW_VALUES"));
+            if (rs.getDate("PURGE_START") != null || rs.getDate("PURGE_INTERVAL") != null) {
+                DBMViewLogPurgeSchedule dbmViewLogPurgeSchedule = new DBMViewLogPurgeSchedule();
+                dbmViewLogPurgeSchedule.setStartDate(rs.getDate("PURGE_START"));
+                dbmViewLogPurgeSchedule.setNextExpression(rs.getString("PURGE_INTERVAL"));
+                mViewLog.setPurgeSchedule(dbmViewLogPurgeSchedule);
+            }
+            mViewLog.setLastPurgeDate(rs.getDate("LAST_PURGE_DATE"));
+            mViewLog.setPurgeParallelismDegree(rs.getLong("PURGE_DOP"));
+        });
+        return mViewLog;
+
+    }
+
     @Override
     public List<DBObjectIdentity> listMViews(String schemaName) {
         MySQLSqlBuilder sb = new MySQLSqlBuilder();