[DBTOOLS-1778] Added interface IJdbcConnector

Author: baslo2

CHANGELOG.md

@@ -9,13 +9,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-- Added URL validation.
+- Added connection string validation.
+- Added a common interface for JDBC connections.
 
 ### Changed
 
 - Improved parser rules for ClickHouse.
 - Improved migration script generation for tables and indexes with options in MS SQL.
 - Added the IS JSON parser rule for PostgreSQL.
+- Improved validation of arrays obtained from metadata queries.
 
 ### Fixed
 

CHANGELOG.ru.md

@@ -9,13 +9,15 @@
 
 ### Добавлено
 
-- Добавлена валидация URL.
+- Добавлена валидация строки подключения.
+- Добавлен общий интерфейс для JDBC-подключений.
 
 ### Изменено
 
 - Улучшены правила парсера для ClickHouse.
 - Улучшена генерация скрипта миграции для таблиц и индексов с опциями в MS SQL.
 - Добавлено правило парсера IS JSON для PostgreSQL.
+- Улучшена проверка массивов, получаемых из запросов метаданных.
 
 ### Исправлено
 

src/main/java/org/pgcodekeeper/core/DatabaseType.java

@@ -29,26 +29,20 @@
  */
 public enum DatabaseType {
 
-    PG("PostgreSQL", "5432"),
-    MS("MS SQL", "1433"),
-    CH("ClickHouse", "8123");
+    PG("PostgreSQL"),
+    MS("MS SQL"),
+    CH("ClickHouse");
 
     private final String dbTypeName;
-    private final String defaultPort;
 
-    DatabaseType(String dbTypeName, String defaultPort) {
+    DatabaseType(String dbTypeName) {
         this.dbTypeName = dbTypeName;
-        this.defaultPort = defaultPort;
     }
 
     public final String getDbTypeName() {
         return dbTypeName;
     }
 
-    public String getDefaultPort() {
-        return defaultPort;
-    }
-
     /**
      * Enums valuesOf method version with custom exception.
      *

src/main/java/org/pgcodekeeper/core/Utils.java

@@ -15,7 +15,7 @@
  *******************************************************************************/
 package org.pgcodekeeper.core;
 
-import org.pgcodekeeper.core.database.base.jdbc.AbstractJdbcConnector;
+import org.pgcodekeeper.core.database.base.jdbc.IJdbcConnector;
 import org.pgcodekeeper.core.database.ch.jdbc.ChJdbcConnector;
 import org.pgcodekeeper.core.database.ms.jdbc.MsJdbcConnector;
 import org.pgcodekeeper.core.database.pg.jdbc.PgJdbcConnector;
@@ -194,7 +194,7 @@ public static UnaryOperator<String> getQuoter(DatabaseType dbType) {
      * @param url full jdbc connection string
      * @return JdbcConnector for the given database type.
      */
-    public static AbstractJdbcConnector getJdbcConnectorByType(DatabaseType dbType, String url) {
+    public static IJdbcConnector getJdbcConnectorByType(DatabaseType dbType, String url) {
         return switch (dbType) {
             case PG -> new PgJdbcConnector(url);
             case MS -> new MsJdbcConnector(url);

src/main/java/org/pgcodekeeper/core/database/base/IDatabaseProvider.java

@@ -16,7 +16,7 @@
 package org.pgcodekeeper.core.database.base;
 
 import org.antlr.v4.runtime.*;
-import org.pgcodekeeper.core.database.base.jdbc.AbstractJdbcConnector;
+import org.pgcodekeeper.core.database.base.jdbc.IJdbcConnector;
 
 /**
  * Interface for DBMS
@@ -28,11 +28,6 @@ public interface IDatabaseProvider {
      */
     String getDatabaseType();
 
-    /**
-     * @return default port for DBMS
-     */
-    String getDefaultPort();
-
     /**
      * @param stream - char stream
      * @return antlr lexer object for DBMS
@@ -62,5 +57,5 @@ public interface IDatabaseProvider {
      * @param url full jdbc url
      * @return jdbc connector for DBMS
      */
-    AbstractJdbcConnector getJdbcConnector(String url);
+    IJdbcConnector getJdbcConnector(String url);
 }

src/main/java/org/pgcodekeeper/core/database/base/jdbc/AbstractJdbcConnector.java

@@ -28,15 +28,18 @@
  * Abstract base class for JDBC database connectors.
  * Provides common functionality for establishing database connections.
  */
-public abstract class AbstractJdbcConnector {
+public abstract class AbstractJdbcConnector implements IJdbcConnector {
+
+    private final String url;
 
     /**
-     * Creates a new database connection using the parameters specified in the constructor.
-     * The caller is responsible for closing the connection.
-     *
-     * @return new database connection
-     * @throws IOException if the driver is not found or a database access error occurs
+     * @param url jdbc connection string
      */
+    protected AbstractJdbcConnector(String url) {
+        this.url = url;
+    }
+
+    @Override
     public Connection getConnection() throws IOException {
         try {
             loadDriver();
@@ -55,10 +58,10 @@ protected void loadDriver() throws ClassNotFoundException {
         Class.forName(getDriverName());
     }
 
-    /**
-     * @return full connection string
-     */
-    protected abstract String getUrl();
+    @Override
+    public String getUrl() {
+        return url;
+    }
 
     /**
      * @return connection properties
@@ -75,16 +78,17 @@ protected Properties makeProperties() {
     protected abstract String getDriverName();
 
     /**
-     * Returns batch delimiter. If the value is null, each statement will be executed separately in autocommit mode.
-     *
-     * @return batch delimiter
+     * @return default port
      */
-    public String getBatchDelimiter() {
-        return null;
-    }
-
-    protected abstract String getDefaultPort();
+    protected abstract int getDefaultPort();
 
+    /**
+     * Validates connection string
+     *
+     * @param url connection string
+     * @param allowedPrefixes allowed prefixes
+     * @throws IllegalArgumentException if the string does not start with the allowed prefixes
+     */
     protected void validateUrl(String url, String... allowedPrefixes) {
         for (var prefix : allowedPrefixes) {
             if (url.startsWith(prefix)) {

src/main/java/org/pgcodekeeper/core/database/base/jdbc/IJdbcConnector.java

@@ -0,0 +1,43 @@
+/*******************************************************************************
+ * Copyright 2017-2025 TAXTELECOM, LLC
+ *
+ * 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 org.pgcodekeeper.core.database.base.jdbc;
+
+import java.io.IOException;
+import java.sql.Connection;
+
+public interface IJdbcConnector {
+
+    /**
+     * Creates a new database connection using the parameters specified in the constructor.
+     * The caller is responsible for closing the connection.
+     *
+     * @return new database connection
+     * @throws IOException if the driver is not found or a database access error occurs
+     */
+    Connection getConnection() throws IOException;
+
+    /**
+     * Returns batch delimiter. If the value is null, each statement will be executed separately in autocommit mode.
+     *
+     * @return batch delimiter
+     */
+    String getBatchDelimiter();
+
+    /**
+     * @return connection string
+     */
+    String getUrl();
+}

src/main/java/org/pgcodekeeper/core/database/ch/ChDatabaseProvider.java

@@ -18,7 +18,7 @@
 import org.antlr.v4.runtime.*;
 import org.pgcodekeeper.core.Consts;
 import org.pgcodekeeper.core.database.base.IDatabaseProvider;
-import org.pgcodekeeper.core.database.base.jdbc.AbstractJdbcConnector;
+import org.pgcodekeeper.core.database.base.jdbc.IJdbcConnector;
 import org.pgcodekeeper.core.database.ch.jdbc.ChJdbcConnector;
 import org.pgcodekeeper.core.parsers.antlr.ch.CustomChSQLAntlrErrorStrategy;
 import org.pgcodekeeper.core.parsers.antlr.ch.generated.CHLexer;
@@ -31,11 +31,6 @@ public String getDatabaseType() {
         return "ClickHouse";
     }
 
-    @Override
-    public String getDefaultPort() {
-        return "8123";
-    }
-
     @Override
     public Lexer getLexer(CharStream stream) {
         return new CHLexer(stream);
@@ -58,7 +53,7 @@ public boolean isSystemSchema(String schema) {
     }
 
     @Override
-    public AbstractJdbcConnector getJdbcConnector(String url) {
+    public IJdbcConnector getJdbcConnector(String url) {
         return new ChJdbcConnector(url);
     }
 }

src/main/java/org/pgcodekeeper/core/database/ch/jdbc/ChJdbcConnector.java

@@ -24,19 +24,21 @@ public class ChJdbcConnector extends AbstractJdbcConnector {
 
     private static final String DRIVER_NAME = "com.clickhouse.jdbc.ClickHouseDriver";
 
-    protected static final String URL_START_CH = "jdbc:clickhouse:";
+    private static final String URL_START_CH = "jdbc:clickhouse:";
     private static final String URL_START_CH_SHORT = "jdbc:ch:";
 
-    private final String url;
+    private static final int DEFAULT_PORT = 8123;
 
+    /**
+     * @param url full jdbc connection string
+     */
     public ChJdbcConnector(String url) {
+        super(url);
         validateUrl(url, URL_START_CH, URL_START_CH_SHORT);
-        this.url = url;
     }
 
-    @Override
-    protected String getUrl() {
-        return url;
+    public ChJdbcConnector(String host, int port, String dbName) {
+        super(URL_START_CH + "//" + host + ':' + (port > 0 ? port : DEFAULT_PORT) + (dbName == null ? "" : "/" + dbName));
     }
 
     @Override
@@ -45,7 +47,12 @@ protected String getDriverName() {
     }
 
     @Override
-    protected String getDefaultPort() {
-        return "8123";
+    protected int getDefaultPort() {
+        return DEFAULT_PORT;
+    }
+
+    @Override
+    public String getBatchDelimiter() {
+        return null;
     }
 }

src/main/java/org/pgcodekeeper/core/database/ms/MsDatabaseProvider.java

@@ -18,7 +18,7 @@
 import org.antlr.v4.runtime.*;
 import org.pgcodekeeper.core.Consts;
 import org.pgcodekeeper.core.database.base.IDatabaseProvider;
-import org.pgcodekeeper.core.database.base.jdbc.AbstractJdbcConnector;
+import org.pgcodekeeper.core.database.base.jdbc.IJdbcConnector;
 import org.pgcodekeeper.core.database.ms.jdbc.MsJdbcConnector;
 import org.pgcodekeeper.core.parsers.antlr.ms.CustomTSQLAntlrErrorStrategy;
 import org.pgcodekeeper.core.parsers.antlr.ms.generated.TSQLLexer;
@@ -31,11 +31,6 @@ public String getDatabaseType() {
         return "MS SQL";
     }
 
-    @Override
-    public String getDefaultPort() {
-        return "1433";
-    }
-
     @Override
     public Lexer getLexer(CharStream stream) {
         return new TSQLLexer(stream);
@@ -57,7 +52,7 @@ public boolean isSystemSchema(String schema) {
     }
 
     @Override
-    public AbstractJdbcConnector getJdbcConnector(String url) {
+    public IJdbcConnector getJdbcConnector(String url) {
         return new MsJdbcConnector(url);
     }
 }