Skip to content

armgit / dbx

Public Imported from GitHub
0

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

fix(jdbc): include SQL Server builtin schemas with legacy fallback

lxk955018fea60fa81
diff --git a/plugins/jdbc/src/main/java/app/dbx/jdbc/DbxJdbcPlugin.java b/plugins/jdbc/src/main/java/app/dbx/jdbc/DbxJdbcPlugin.java
index 3ce72b4410..4deb4e3d26 100644
--- a/plugins/jdbc/src/main/java/app/dbx/jdbc/DbxJdbcPlugin.java
+++ b/plugins/jdbc/src/main/java/app/dbx/jdbc/DbxJdbcPlugin.java
@@ -108,12 +108,14 @@ public final class DbxJdbcPlugin {
false,
false,
false,
+ false,
null,
StatementMaxRowsMode.READ_LOOP_ONLY
);
private static final JdbcDriverQuirks USE_CATALOG_QUIRKS = DEFAULT_QUIRKS.withUseCatalogFallbackSql(true);
private static final JdbcDriverQuirks HIVE_QUIRKS = USE_CATALOG_QUIRKS.withSchemasAsDatabasesFallback(true);
private static final JdbcDriverQuirks KINGBASE_QUIRKS = DEFAULT_QUIRKS.withIgnoreCatalogForSchemaMetadata(true);
+ private static final JdbcDriverQuirks SQLSERVER_QUIRKS = DEFAULT_QUIRKS.withMergeEmptyCatalogSchemas(true);
private static final JdbcDriverQuirks TAOS_QUIRKS = DEFAULT_QUIRKS
.withPreferExecuteQueryForResultSetSql(true)
.withDatabaseClientInfoProperty("dbname");
@@ -125,6 +127,7 @@ public final class DbxJdbcPlugin {
false,
false,
false,
+ false,
null,
StatementMaxRowsMode.APPLY_STATEMENT_MAX_ROWS
);
@@ -136,6 +139,7 @@ public final class DbxJdbcPlugin {
false,
false,
false,
+ false,
null,
StatementMaxRowsMode.READ_LOOP_ONLY
);
@@ -147,6 +151,7 @@ public final class DbxJdbcPlugin {
false,
false,
false,
+ false,
null,
StatementMaxRowsMode.APPLY_STATEMENT_MAX_ROWS
);
@@ -157,6 +162,8 @@ public final class DbxJdbcPlugin {
new JdbcDriverQuirkRule("jdbc:doris:", USE_CATALOG_QUIRKS),
new JdbcDriverQuirkRule("jdbc:hive2:", HIVE_QUIRKS),
new JdbcDriverQuirkRule("jdbc:kingbase", KINGBASE_QUIRKS),
+ new JdbcDriverQuirkRule("jdbc:sqlserver:", SQLSERVER_QUIRKS),
+ new JdbcDriverQuirkRule("jdbc:jtds:sqlserver:", SQLSERVER_QUIRKS),
new JdbcDriverQuirkRule("jdbc:yasdb:", YASHAN_QUIRKS),
new JdbcDriverQuirkRule("jdbc:iris:", IRIS_QUIRKS),
new JdbcDriverQuirkRule("jdbc:oracle:", ORACLE_QUIRKS),
@@ -197,6 +204,7 @@ public final class DbxJdbcPlugin {
boolean ignoreCatalogForSchemaMetadata,
boolean preferExecuteQueryForResultSetSql,
boolean schemasAsDatabasesFallback,
+ boolean mergeEmptyCatalogSchemas,
String databaseClientInfoProperty,
StatementMaxRowsMode statementMaxRowsMode
) {
@@ -209,6 +217,7 @@ public final class DbxJdbcPlugin {
ignoreCatalogForSchemaMetadata,
preferExecuteQueryForResultSetSql,
schemasAsDatabasesFallback,
+ mergeEmptyCatalogSchemas,
databaseClientInfoProperty,
statementMaxRowsMode
);
@@ -223,6 +232,7 @@ public final class DbxJdbcPlugin {
value,
preferExecuteQueryForResultSetSql,
schemasAsDatabasesFallback,
+ mergeEmptyCatalogSchemas,
databaseClientInfoProperty,
statementMaxRowsMode
);
@@ -237,6 +247,7 @@ public final class DbxJdbcPlugin {
ignoreCatalogForSchemaMetadata,
value,
schemasAsDatabasesFallback,
+ mergeEmptyCatalogSchemas,
databaseClientInfoProperty,
statementMaxRowsMode
);
@@ -251,6 +262,22 @@ public final class DbxJdbcPlugin {
ignoreCatalogForSchemaMetadata,
preferExecuteQueryForResultSetSql,
value,
+ mergeEmptyCatalogSchemas,
+ databaseClientInfoProperty,
+ statementMaxRowsMode
+ );
+ }
+
+ JdbcDriverQuirks withMergeEmptyCatalogSchemas(boolean value) {
+ return new JdbcDriverQuirks(
+ skipExecutionContext,
+ useOracleMetadata,
+ caseInsensitiveSchemaMetadata,
+ useCatalogFallbackSql,
+ ignoreCatalogForSchemaMetadata,
+ preferExecuteQueryForResultSetSql,
+ schemasAsDatabasesFallback,
+ value,
databaseClientInfoProperty,
statementMaxRowsMode
);
@@ -265,6 +292,7 @@ public final class DbxJdbcPlugin {
ignoreCatalogForSchemaMetadata,
preferExecuteQueryForResultSetSql,
schemasAsDatabasesFallback,
+ mergeEmptyCatalogSchemas,
value,
statementMaxRowsMode
);
@@ -744,7 +772,7 @@ public final class DbxJdbcPlugin {
if (connectionState() != DEFAULT_CONNECTION_STATE) logicalDriverKey = driverKey;
String driverClass = optionalText(connection, "jdbc_driver_class");
if (driverKey.equals(registeredDriverKey) && registeredDriver != null) {
- if (driverClass != null) {
+ if (driverClass != null && LegacyJdbcDriverClass.isLegacyAlias(driverClass)) {
LegacyJdbcDriverClass.load(
driverClass,
optionalText(connection, "connection_string"),
@@ -2271,12 +2299,28 @@ public final class DbxJdbcPlugin {
return rule.quirks();
}
}
+ if (isSqlServerConnection(connection)) {
+ return SQLSERVER_QUIRKS;
+ }
if (isKyuubiDriver(connection)) {
return HIVE_QUIRKS;
}
return DEFAULT_QUIRKS;
}
+ private static boolean isSqlServerConnection(JsonNode connection) {
+ String url = optionalText(connection, "connection_string");
+ if (urlMatchesPrefix(url, "jdbc:sqlserver:") || urlMatchesPrefix(url, "jdbc:jtds:sqlserver:")) {
+ return true;
+ }
+ String driverClass = optionalText(connection, "jdbc_driver_class");
+ if (driverClass == null) {
+ return false;
+ }
+ String normalized = driverClass.toLowerCase(Locale.ROOT);
+ return normalized.contains("sqlserver") || normalized.contains("jtds");
+ }
+
private static boolean isKyuubiDriver(JsonNode connection) {
String driverClass = optionalText(connection, "jdbc_driver_class");
if (driverClass != null && driverClass.toLowerCase(Locale.ROOT).contains("kyuubi")) {
@@ -2408,6 +2452,12 @@ public final class DbxJdbcPlugin {
} catch (AbstractMethodError ignored2) {
}
}
+ if (quirks.mergeEmptyCatalogSchemas() && catalog != null && !catalog.isEmpty()) {
+ try (ResultSet rs = meta.getSchemas("", null)) {
+ appendSchemas(result, rs, false);
+ } catch (SQLException | UnsupportedOperationException | AbstractMethodError ignored) {
+ }
+ }
if (result.isEmpty() && catalog != null) {
try (ResultSet rs = meta.getSchemas(null, null)) {
appendSchemas(result, rs, false);
diff --git a/plugins/jdbc/src/main/java/app/dbx/jdbc/LegacyJdbcDriverClass.java b/plugins/jdbc/src/main/java/app/dbx/jdbc/LegacyJdbcDriverClass.java
index 2397fdaaf2..0bf0b1bcbd 100644
--- a/plugins/jdbc/src/main/java/app/dbx/jdbc/LegacyJdbcDriverClass.java
+++ b/plugins/jdbc/src/main/java/app/dbx/jdbc/LegacyJdbcDriverClass.java
@@ -3,6 +3,16 @@ package app.dbx.jdbc;
final class LegacyJdbcDriverClass {
private LegacyJdbcDriverClass() {}
+ static boolean isLegacyAlias(String driverClass) {
+ if (driverClass == null) {
+ return false;
+ }
+ return switch (driverClass) {
+ case "teradata", "db2", "h2_embedded", "h2_embedded_v2" -> true;
+ default -> false;
+ };
+ }
+
static Class<?> load(String driverClass, String jdbcUrl, ClassLoader loader) throws ClassNotFoundException {
try {
return Class.forName(driverClass, true, loader);
diff --git a/plugins/jdbc/src/test/java/app/dbx/jdbc/DbxJdbcPluginTest.java b/plugins/jdbc/src/test/java/app/dbx/jdbc/DbxJdbcPluginTest.java
index 2d43e3a227..2bee556ccc 100644
--- a/plugins/jdbc/src/test/java/app/dbx/jdbc/DbxJdbcPluginTest.java
+++ b/plugins/jdbc/src/test/java/app/dbx/jdbc/DbxJdbcPluginTest.java
@@ -1829,8 +1829,27 @@ final class DbxJdbcPluginTest {
assertEquals(true, DbxJdbcPlugin.driverQuirks(hive).schemasAsDatabasesFallback());
assertEquals(true, DbxJdbcPlugin.driverQuirks(kingbase).ignoreCatalogForSchemaMetadata());
assertEquals(true, DbxJdbcPlugin.driverQuirks(kyuubi).useCatalogFallbackSql());
- assertEquals(true, DbxJdbcPlugin.driverQuirks(kyuubi).schemasAsDatabasesFallback());
assertEquals(true, DbxJdbcPlugin.driverQuirks(taos).preferExecuteQueryForResultSetSql());
+
+ JsonNode sqlserver = MAPPER.readTree("""
+ {
+ "connection_string": "jdbc:sqlserver://127.0.0.1:1433;databaseName=appdb"
+ }
+ """);
+ JsonNode jtds = MAPPER.readTree("""
+ {
+ "connection_string": "jdbc:jtds:sqlserver://127.0.0.1:1433/appdb"
+ }
+ """);
+ JsonNode sqlserverClass = MAPPER.readTree("""
+ {
+ "jdbc_driver_class": "com.microsoft.sqlserver.jdbc.SQLServerDriver"
+ }
+ """);
+ assertEquals(true, DbxJdbcPlugin.driverQuirks(sqlserver).mergeEmptyCatalogSchemas());
+ assertEquals(true, DbxJdbcPlugin.driverQuirks(jtds).mergeEmptyCatalogSchemas());
+ assertEquals(true, DbxJdbcPlugin.driverQuirks(sqlserverClass).mergeEmptyCatalogSchemas());
+ assertEquals(false, DbxJdbcPlugin.driverQuirks(h2).mergeEmptyCatalogSchemas());
}
@Test
@@ -2332,6 +2351,146 @@ final class DbxJdbcPluginTest {
}
}
+ @Test
+ void listSchemasMergesBuiltinSchemasForSqlServerWithCustomSchemas() throws Exception {
+ String url = "jdbc:sqlserver://sqlserver-mock.example.test:1433;databaseName=appdb";
+ Driver driver = new SqlServerSchemaMockDriver(
+ url,
+ List.of("sales", "custom"),
+ List.of("dbo", "guest", "INFORMATION_SCHEMA", "sys")
+ );
+ DriverManager.registerDriver(driver);
+ try {
+ JsonNode response = request("listSchemas", """
+ {
+ "connection": {
+ "connection_string": "%s",
+ "username": "sa",
+ "password": "secret"
+ },
+ "database": "appdb"
+ }
+ """.formatted(url));
+
+ assertFalse(response.has("error"), response.toString());
+ List<String> schemaNames = new ArrayList<>();
+ for (JsonNode item : response.path("result")) {
+ schemaNames.add(item.path("name").asText(item.asText()));
+ }
+ assertTrue(schemaNames.contains("sales"), schemaNames.toString());
+ assertTrue(schemaNames.contains("custom"), schemaNames.toString());
+ assertTrue(schemaNames.contains("dbo"), schemaNames.toString());
+ assertTrue(schemaNames.contains("sys"), schemaNames.toString());
+ } finally {
+ DriverManager.deregisterDriver(driver);
+ request("close", """
+ {
+ "connection": {
+ "connection_string": "%s",
+ "username": "sa",
+ "password": "secret"
+ }
+ }
+ """.formatted(url));
+ }
+ }
+
+ @Test
+ void listSchemasMergesBuiltinSchemasForSqlServerWithoutCustomSchemas() throws Exception {
+ String url = "jdbc:sqlserver://sqlserver-empty-mock.example.test:1433;databaseName=appdb";
+ Driver driver = new SqlServerSchemaMockDriver(
+ url,
+ List.of(),
+ List.of("dbo", "guest", "INFORMATION_SCHEMA", "sys")
+ );
+ DriverManager.registerDriver(driver);
+ try {
+ JsonNode response = request("listSchemas", """
+ {
+ "connection": {
+ "connection_string": "%s",
+ "username": "sa",
+ "password": "secret"
+ },
+ "database": "appdb"
+ }
+ """.formatted(url));
+
+ assertFalse(response.has("error"), response.toString());
+ List<String> schemaNames = new ArrayList<>();
+ for (JsonNode item : response.path("result")) {
+ schemaNames.add(item.path("name").asText(item.asText()));
+ }
+ assertFalse(schemaNames.contains("sales"), schemaNames.toString());
+ assertTrue(schemaNames.contains("dbo"), schemaNames.toString());
+ assertTrue(schemaNames.contains("sys"), schemaNames.toString());
+ } finally {
+ DriverManager.deregisterDriver(driver);
+ request("close", """
+ {
+ "connection": {
+ "connection_string": "%s",
+ "username": "sa",
+ "password": "secret"
+ }
+ }
+ """.formatted(url));
+ }
+ }
+
+ @Test
+ void listSchemasPreservesJtdsFallbackWhenEmptyCatalogOverloadIsUnimplemented() throws Exception {
+ String url = "jdbc:jtds:sqlserver://sqlserver-legacy-mock.example.test:1433/appdb";
+ List<String> calls = new ArrayList<>();
+ DatabaseMetaData metadata = (DatabaseMetaData) Proxy.newProxyInstance(
+ DbxJdbcPluginTest.class.getClassLoader(),
+ new Class<?>[] { DatabaseMetaData.class },
+ (proxy, method, args) -> {
+ if ("getSchemas".equals(method.getName())) {
+ if (args != null && args.length == 2) {
+ calls.add((String) args[0]);
+ throw new AbstractMethodError("getSchemas(String, String) is not implemented");
+ }
+ calls.add("getSchemas()");
+ return rowsResultSet(
+ new String[] { "TABLE_SCHEM" },
+ new Object[][] { { "dbo" }, { "sales" } }
+ );
+ }
+ return defaultValue(method.getReturnType());
+ }
+ );
+ Connection jdbcConnection = (Connection) Proxy.newProxyInstance(
+ DbxJdbcPluginTest.class.getClassLoader(),
+ new Class<?>[] { Connection.class },
+ (proxy, method, args) -> switch (method.getName()) {
+ case "getMetaData" -> metadata;
+ case "getAutoCommit" -> true;
+ case "isClosed" -> false;
+ default -> defaultValue(method.getReturnType());
+ }
+ );
+ Driver driver = testDriver(url, jdbcConnection);
+ String connection = """
+ { "connection_string": "%s" }
+ """.formatted(url);
+ DriverManager.registerDriver(driver);
+ try {
+ JsonNode response = request("listSchemas", """
+ {
+ "connection": %s,
+ "database": "appdb"
+ }
+ """.formatted(connection));
+
+ assertFalse(response.has("error"), response.toString());
+ assertEquals(MAPPER.readTree("[\"dbo\", \"sales\"]"), response.path("result"));
+ assertEquals(List.of("appdb", "getSchemas()", ""), calls);
+ } finally {
+ closeAndDeregister(connection, driver);
+ }
+ }
+
@Test
void connectUsesRegisteredDriverWhenOtherDriversThrowUnsupportedOperationException() throws Exception {
String url = "jdbc:hive2://hive2-connect-test:10000/default";
@@ -5759,6 +5918,122 @@ final class DbxJdbcPluginTest {
}
}
+ private static final class SqlServerSchemaMockDriver implements Driver {
+ private final String url;
+ private final List<String> catalogSchemas;
+ private final List<String> emptyCatalogSchemas;
+
+ private SqlServerSchemaMockDriver(String url, List<String> catalogSchemas, List<String> emptyCatalogSchemas) {
+ this.url = url;
+ this.catalogSchemas = catalogSchemas;
+ this.emptyCatalogSchemas = emptyCatalogSchemas;
+ }
+
+ @Override
+ public Connection connect(String connectUrl, Properties info) throws SQLException {
+ if (!acceptsURL(connectUrl)) {
+ return null;
+ }
+ return (Connection) Proxy.newProxyInstance(
+ DbxJdbcPluginTest.class.getClassLoader(),
+ new Class<?>[] { Connection.class },
+ (proxy, method, args) -> switch (method.getName()) {
+ case "isClosed" -> false;
+ case "isValid" -> true;
+ case "close" -> null;
+ case "getMetaData" -> sqlServerMetaData();
+ case "getCatalog" -> "appdb";
+ case "getSchema" -> "dbo";
+ default -> defaultValue(method.getReturnType());
+ }
+ );
+ }
+
+ private DatabaseMetaData sqlServerMetaData() {
+ return (DatabaseMetaData) Proxy.newProxyInstance(
+ DbxJdbcPluginTest.class.getClassLoader(),
+ new Class<?>[] { DatabaseMetaData.class },
+ (proxy, method, args) -> {
+ if ("getSchemas".equals(method.getName())) {
+ if (args != null && args.length == 2) {
+ String catalog = (String) args[0];
+ if ("appdb".equals(catalog)) {
+ return stringColumnResultSet("TABLE_SCHEM", catalogSchemas);
+ }
+ if ("".equals(catalog)) {
+ return stringColumnResultSet("TABLE_SCHEM", emptyCatalogSchemas);
+ }
+ if (catalog == null) {
+ List<String> all = new ArrayList<>(catalogSchemas);
+ all.addAll(emptyCatalogSchemas);
+ return stringColumnResultSet("TABLE_SCHEM", all);
+ }
+ }
+ }
+ return defaultValue(method.getReturnType());
+ }
+ );
+ }
+
+ private static ResultSet stringColumnResultSet(String columnLabel, List<String> values) {
+ return (ResultSet) Proxy.newProxyInstance(
+ DbxJdbcPluginTest.class.getClassLoader(),
+ new Class<?>[] { ResultSet.class },
+ new java.lang.reflect.InvocationHandler() {
+ private int index = -1;
+
+ @Override
+ public Object invoke(Object proxy, Method method, Object[] args) {
+ return switch (method.getName()) {
+ case "next" -> ++index < values.size();
+ case "getString" -> {
+ if (args != null && args.length > 0 && columnLabel.equals(args[0])) {
+ yield values.get(index);
+ }
+ if (args != null && args.length > 0 && Integer.valueOf(1).equals(args[0])) {
+ yield values.get(index);
+ }
+ yield null;
+ }
+ case "close" -> null;
+ default -> defaultValue(method.getReturnType());
+ };
+ }
+ }
+ );
+ }
+
+ @Override
+ public boolean acceptsURL(String connectUrl) {
+ return url.equals(connectUrl);
+ }
+
+ @Override
+ public DriverPropertyInfo[] getPropertyInfo(String connectUrl, Properties info) {
+ return new DriverPropertyInfo[0];
+ }
+
+ @Override
+ public int getMajorVersion() {
+ return 1;
+ }
+
+ @Override
+ public int getMinorVersion() {
+ return 0;
+ }
+
+ @Override
+ public boolean jdbcCompliant() {
+ return false;
+ }
+
+ @Override
+ public java.util.logging.Logger getParentLogger() {
+ return java.util.logging.Logger.getGlobal();
+ }
+ }
+
public static final class ErrorOnLoad {
private static final Object FAILURE = fail();