Merge pull request alibaba#14041 from WangzJi/feature/unified-datasource-dialect

feat: Merge nacos-plugin PostgreSQL & Base Implementation

Author: KomachiSion

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/constants/DatabaseTypeConstant.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 1999-2022 Alibaba Group Holding Ltd.
+ *
+ * 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.alibaba.nacos.plugin.datasource.constants;
+
+/**
+ * DatabaseType Constant.
+ *
+ * @author Long Yu
+ **/
+public class DatabaseTypeConstant {
+
+    public static final String POSTGRESQL = "postgresql";
+
+    public static final String GUASSDB = "gaussdb";
+
+    public static final String MYSQL = "mysql";
+
+    public static final String ORACLE = "oracle";
+
+    public static final String DM = "dm";
+
+    public static final String SQLSERVER = "sqlserver";
+
+    public static final String KINGBASE = "kingbase";
+
+    public static final String YASDB = "yasdb";
+
+    public static final String DERBY = "derby";
+
+}

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/constants/PrimaryKeyConstant.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright 1999-2022 Alibaba Group Holding Ltd.
+ *
+ * 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.alibaba.nacos.plugin.datasource.constants;
+
+/**
+ * PrimaryKeyConstant.
+ *
+ * @author Long Yu
+ */
+public class PrimaryKeyConstant {
+
+    /**
+     * replace lower Statement.RETURN_GENERATED_KEYS into id key.
+     */
+    public static final String[] LOWER_RETURN_PRIMARY_KEYS = new String[]{"id"};
+
+    /**
+     * upper replace Statement.RETURN_GENERATED_KEYS into id key.
+     * using dameng database.
+     */
+    public static final String[] UPPER_RETURN_PRIMARY_KEYS = new String[]{"ID"};
+
+}

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/constants/TableConstant.java

@@ -43,4 +43,6 @@ public class TableConstant {
     public static final String TENANT_INFO = "tenant_info";
 
     public static final String MIGRATE_CONFIG = "migrate_config";
+    
+    public static final String CONFIG_INFO_AGGR = "config_info_aggr";
 }

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/dialect/AbstractDatabaseDialect.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 1999-2022 Alibaba Group Holding Ltd.
+ *
+ * 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.alibaba.nacos.plugin.datasource.dialect;
+
+import com.alibaba.nacos.plugin.datasource.constants.PrimaryKeyConstant;
+
+/**
+ * Abstract DatabaseDialect.
+ * Default limit for mysql,postgresql
+ * @author Long Yu
+ */
+public abstract class AbstractDatabaseDialect implements DatabaseDialect {
+    
+    @Override
+    public int getPagePrevNum(int page, int pageSize) {
+        return (page - 1) * pageSize;
+    }
+    
+    @Override
+    public int getPageLastNum(int page, int pageSize) {
+        return pageSize;
+    }
+    
+    @Override
+    public String getLimitTopSqlWithMark(String sql) {
+        return sql + " LIMIT ? ";
+    }
+
+    @Override
+    public String getLimitPageSqlWithMark(String sql) {
+        return sql + " LIMIT ?,? ";
+    }
+
+    @Override
+    public String getLimitPageSql(String sql, int pageNo, int pageSize) {
+        return sql + "  LIMIT " + getPagePrevNum(pageNo, pageSize) + " , " + pageSize;
+    }
+    
+    @Override
+    public String getLimitPageSqlWithOffset(String sql, int startOffset, int pageSize) {
+        return sql + "  LIMIT " + startOffset + " , " + pageSize;
+    }
+    
+    @Override
+    public String[] getReturnPrimaryKeys() {
+        return PrimaryKeyConstant.LOWER_RETURN_PRIMARY_KEYS;
+    }
+
+}

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/dialect/DatabaseDialect.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright 1999-2022 Alibaba Group Holding Ltd.
+ *
+ * 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.alibaba.nacos.plugin.datasource.dialect;
+
+/**
+ * DatabaseDialect interface.
+ * @author Long Yu
+ */
+public interface DatabaseDialect {
+
+    /**
+     * get database type.
+     * @return return database type name
+     */
+    public String getType();
+
+    /**
+     * get frist index page param.
+     * @param page current pageNo
+     * @param pageSize current pageSize
+     * @return offset val or maxRange
+     */
+    public int getPagePrevNum(int page, int pageSize);
+
+    /**
+     * get second index page param.
+     * @param page current pageNo
+     * @param pageSize current pageSize
+     * @return limit val or minRange
+     */
+    public int getPageLastNum(int page, int pageSize);
+
+    /**
+     * get page limit top data sql,contain  placeholder.
+     * @param sql orign sql
+     * @return append limit sql
+     */
+    public String getLimitTopSqlWithMark(String sql);
+
+    /**
+     * get page limit page data sql,contain  placeholder.
+     * @param sql orign sql
+     * @return append limit sql
+     */
+    public String getLimitPageSqlWithMark(String sql);
+
+    /**
+     * get page limit page data sql,using number.
+     * @param sql orign sql
+     * @param pageNo current pageNo
+     * @param pageSize current pageSize
+     * @return contain page number param sql
+     */
+    public String getLimitPageSql(String sql, int pageNo, int pageSize);
+    
+    /**
+     * get page limit page data sql,using offset.
+     * @param sql orign sql
+     * @param startOffset current offset row
+     * @param pageSize current pageSize
+     * @return contain page number param sql
+     */
+    public String getLimitPageSqlWithOffset(String sql, int startOffset, int pageSize);
+
+    /**
+     * get database return primary keys.
+     * @return
+     */
+    public String[] getReturnPrimaryKeys();
+
+    /**
+     * Get the function corresponding to the dialect according to the function name
+     * @author Mr.Muzhi
+     * @since 2025/1/7 16:30
+     * @param functionName functionName
+     * @return function
+     */
+    String getFunction(String functionName);
+}

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/dialect/DefaultDatabaseDialect.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 1999-2022 Alibaba Group Holding Ltd.
+ *
+ * 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.alibaba.nacos.plugin.datasource.dialect;
+
+import com.alibaba.nacos.plugin.datasource.constants.DatabaseTypeConstant;
+import com.alibaba.nacos.plugin.datasource.enums.mysql.TrustedMysqlFunctionEnum;
+
+/**
+ * defauLT database dialect.
+ * @author Long Yu
+ */
+public class DefaultDatabaseDialect extends AbstractDatabaseDialect {
+
+    @Override
+    public String getType() {
+        return DatabaseTypeConstant.MYSQL;
+    }
+
+    @Override
+    public String getFunction(String functionName) {
+        return TrustedMysqlFunctionEnum.getFunctionByName(functionName);
+    }
+
+}

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/dialect/DerbyDatabaseDialect.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 1999-2022 Alibaba Group Holding Ltd.
+ *
+ * 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.alibaba.nacos.plugin.datasource.dialect;
+
+import com.alibaba.nacos.plugin.datasource.constants.DatabaseTypeConstant;
+import com.alibaba.nacos.plugin.datasource.enums.derby.TrustedDerbyFunctionEnum;
+
+/**
+ * Derby database dialect.
+ *
+ * @author xiweng.yy
+ */
+public class DerbyDatabaseDialect extends AbstractDatabaseDialect {
+
+    @Override
+    public String getType() {
+        return DatabaseTypeConstant.DERBY;
+    }
+
+    @Override
+    public String getLimitTopSqlWithMark(String sql) {
+        return sql + " OFFSET 0 ROWS FETCH NEXT ? ROWS ONLY";
+    }
+
+    @Override
+    public String getLimitPageSqlWithMark(String sql) {
+        return sql + " OFFSET ? ROWS FETCH NEXT ? ROWS ONLY";
+    }
+
+    @Override
+    public String getLimitPageSql(String sql, int pageNo, int pageSize) {
+        return sql + " OFFSET " + getPagePrevNum(pageNo, pageSize) + " ROWS FETCH NEXT " + pageSize + " ROWS ONLY";
+    }
+
+    @Override
+    public String getLimitPageSqlWithOffset(String sql, int startOffset, int pageSize) {
+        return sql + " OFFSET " + startOffset + " ROWS FETCH NEXT " + pageSize + " ROWS ONLY";
+    }
+
+    @Override
+    public String getFunction(String functionName) {
+        return TrustedDerbyFunctionEnum.getFunctionByName(functionName);
+    }
+}

plugin/datasource/src/main/java/com/alibaba/nacos/plugin/datasource/dialect/MysqlDatabaseDialect.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 1999-2022 Alibaba Group Holding Ltd.
+ *
+ * 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.alibaba.nacos.plugin.datasource.dialect;
+
+import com.alibaba.nacos.plugin.datasource.constants.DatabaseTypeConstant;
+import com.alibaba.nacos.plugin.datasource.enums.mysql.TrustedMysqlFunctionEnum;
+
+/**
+ * MySQL database dialect.
+ *
+ * @author xiweng.yy
+ */
+public class MysqlDatabaseDialect extends AbstractDatabaseDialect {
+
+    @Override
+    public String getType() {
+        return DatabaseTypeConstant.MYSQL;
+    }
+
+    @Override
+    public String getFunction(String functionName) {
+        return TrustedMysqlFunctionEnum.getFunctionByName(functionName);
+    }
+}