Skip to content

Allow to ignore unsupported connection options #250

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
staticlibs merged 1 commit into from
Jun 4, 2025
Merged

Allow to ignore unsupported connection options #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 48 additions & 2 deletions src/main/java/org/duckdb/DuckDBDriver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public class DuckDBDriver implements java.sql.Driver {
public static final String JDBC_STREAM_RESULTS = "jdbc_stream_results";
public static final String JDBC_AUTO_COMMIT = "jdbc_auto_commit";
public static final String JDBC_PIN_DB = "jdbc_pin_db";
public static final String JDBC_IGNORE_UNSUPPORTED_OPTIONS = "jdbc_ignore_unsupported_options";

static final String DUCKDB_URL_PREFIX = "jdbc:duckdb:";
static final String MEMORY_DB = ":memory:";
Expand All @@ -33,6 +34,9 @@ public class DuckDBDriver implements java.sql.Driver {
private static boolean pinnedDbRefsShutdownHookRegistered = false;
private static boolean pinnedDbRefsShutdownHookRun = false;

private static final Set<String> supportedOptions = new LinkedHashSet<>();
private static final ReentrantLock supportedOptionsLock = new ReentrantLock();

static {
try {
DriverManager.registerDriver(new DuckDBDriver());
Expand All @@ -52,13 +56,20 @@ public Connection connect(String url, Properties info) throws SQLException {
props = (Properties) info.clone();
}

// URL options
ParsedProps pp = parsePropsFromUrl(url);
for (Map.Entry<String, String> en : pp.props.entrySet()) {
props.put(en.getKey(), en.getValue());
}

// Ignore unsupported
removeUnsupportedOptions(props);

// Read-only option
String readOnlyStr = removeOption(props, DUCKDB_READONLY_PROPERTY);
boolean readOnly = isStringTruish(readOnlyStr, false);

// Client name option
props.put("duckdb_api", "jdbc");

// Apache Spark passes this option when SELECT on a JDBC DataSource
Expand All @@ -67,6 +78,7 @@ public Connection connect(String url, Properties info) throws SQLException {
// to be established.
props.remove("path");

// DuckLake options
String ducklake = removeOption(props, DUCKLAKE_OPTION);
String ducklakeAlias = removeOption(props, DUCKLAKE_ALIAS_OPTION, DUCKLAKE_OPTION);
final String shortUrl;
Expand All @@ -83,13 +95,13 @@ public Connection connect(String url, Properties info) throws SQLException {
shortUrl = pp.shortUrl;
}

// Pin DB option
String pinDbOptStr = removeOption(props, JDBC_PIN_DB);
boolean pinDBOpt = isStringTruish(pinDbOptStr, false);

// Create connection
DuckDBConnection conn = DuckDBConnection.newConnection(shortUrl, readOnly, props);

pinDB(pinDBOpt, shortUrl, conn);

initDucklake(conn, shortUrl, ducklake, ducklakeAlias);

return conn;
Expand All @@ -116,6 +128,8 @@ public DriverPropertyInfo[] getPropertyInfo(String url, Properties info) throws
list.add(createDriverPropInfo(JDBC_AUTO_COMMIT, "", "Set default auto-commit mode"));
list.add(createDriverPropInfo(JDBC_PIN_DB, "",
"Do not close the DB instance after all connections to it are closed"));
list.add(createDriverPropInfo(JDBC_IGNORE_UNSUPPORTED_OPTIONS, "",
"Silently discard unsupported connection options"));
list.sort((o1, o2) -> o1.name.compareToIgnoreCase(o2.name));
return list.toArray(new DriverPropertyInfo[0]);
}
Expand Down Expand Up @@ -251,6 +265,38 @@ private static DriverPropertyInfo createDriverPropInfo(String name, String value
return dpi;
}

private static void removeUnsupportedOptions(Properties props) throws SQLException {
String ignoreStr = removeOption(props, JDBC_IGNORE_UNSUPPORTED_OPTIONS);
boolean ignore = isStringTruish(ignoreStr, false);
if (!ignore) {
return;
}
supportedOptionsLock.lock();
try {
if (supportedOptions.isEmpty()) {
Driver driver = DriverManager.getDriver(DUCKDB_URL_PREFIX);
Properties dpiProps = new Properties();
dpiProps.put("threads", 1);
DriverPropertyInfo[] dpis = driver.getPropertyInfo(DUCKDB_URL_PREFIX, dpiProps);
for (DriverPropertyInfo dpi : dpis) {
supportedOptions.add(dpi.name);
}
}
List<String> unsupportedNames = new ArrayList<>();
for (Object nameObj : props.keySet()) {
String name = String.valueOf(nameObj);
if (!supportedOptions.contains(name)) {
unsupportedNames.add(name);
}
}
for (String name : unsupportedNames) {
props.remove(name);
}
} finally {
supportedOptionsLock.unlock();
}
}

private static class ParsedProps {
final String shortUrl;
final LinkedHashMap<String, String> props;
Expand Down
9 changes: 9 additions & 0 deletions src/test/java/org/duckdb/TestDuckDBJDBC.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
import static org.duckdb.DuckDBDriver.DUCKDB_USER_AGENT_PROPERTY;
import static org.duckdb.DuckDBDriver.JDBC_STREAM_RESULTS;
import static org.duckdb.DuckDBTimestamp.localDateTimeFromTimestamp;
import static org.duckdb.test.Assertions.*;
import static org.duckdb.test.Runner.runTests;
Expand Down Expand Up @@ -3656,6 +3657,14 @@ public static void test_driver_property_info() throws Exception {
assertTrue(dpis.length > 0);
}

public static void test_ignore_unsupported_options() throws Exception {
assertThrows(() -> { DriverManager.getConnection("jdbc:duckdb:;foo=bar;"); }, SQLException.class);
Properties config = new Properties();
config.put("boo", "bar");
config.put(JDBC_STREAM_RESULTS, true);
DriverManager.getConnection("jdbc:duckdb:;foo=bar;jdbc_ignore_unsupported_options=yes;", config).close();
}

public static void main(String[] args) throws Exception {
String arg1 = args.length > 0 ? args[0] : "";
final int statusCode;
Expand Down