[CONJ-909] adding createDatabaseIfNotExist option for 2.x compatibility

Author: diego Dupin

src/main/java/org/mariadb/jdbc/Configuration.java

@@ -61,6 +61,7 @@ public class Configuration {
  private String timezone = null;
  private Boolean autocommit = null;
  private boolean useMysqlMetadata = false;
+ private boolean createDatabaseIfNotExist = false;
  private TransactionIsolation transactionIsolation = null;
  private int defaultFetchSize = 0;
  private int maxQuerySizeToLog = 1024;
@@ -153,6 +154,7 @@ private Configuration(
  String timezone,
  Boolean autocommit,
  boolean useMysqlMetadata,
+ boolean createDatabaseIfNotExist,
  TransactionIsolation transactionIsolation,
  int defaultFetchSize,
  int maxQuerySizeToLog,
@@ -220,6 +222,7 @@ private Configuration(
  this.timezone = timezone;
  this.autocommit = autocommit;
  this.useMysqlMetadata = useMysqlMetadata;
+ this.createDatabaseIfNotExist = createDatabaseIfNotExist;
  this.transactionIsolation = transactionIsolation;
  this.defaultFetchSize = defaultFetchSize;
  this.maxQuerySizeToLog = maxQuerySizeToLog;
@@ -319,6 +322,7 @@ private Configuration(
  Boolean useBulkStmts,
  Boolean autocommit,
  Boolean useMysqlMetadata,
+ Boolean createDatabaseIfNotExist,
  Boolean includeInnodbStatusInDeadlockExceptions,
  Boolean includeThreadDumpInDeadlockExceptions,
  String servicePrincipalName,
@@ -395,6 +399,7 @@ private Configuration(
  if (useBulkStmts != null) this.useBulkStmts = useBulkStmts;
  if (autocommit != null) this.autocommit = autocommit;
  if (useMysqlMetadata != null) this.useMysqlMetadata = useMysqlMetadata;
+ if (createDatabaseIfNotExist != null) this.createDatabaseIfNotExist = createDatabaseIfNotExist;
  if (includeInnodbStatusInDeadlockExceptions != null)
  this.includeInnodbStatusInDeadlockExceptions = includeInnodbStatusInDeadlockExceptions;
  if (includeThreadDumpInDeadlockExceptions != null)
@@ -687,6 +692,7 @@ public Configuration clone(String username, String password) {
  this.timezone,
  this.autocommit,
  this.useMysqlMetadata,
+ this.createDatabaseIfNotExist,
  this.transactionIsolation,
  this.defaultFetchSize,
  this.maxQuerySizeToLog,
@@ -920,6 +926,10 @@ public boolean useMysqlMetadata() {
  return useMysqlMetadata;
  }
 
+ public boolean createDatabaseIfNotExist() {
+ return createDatabaseIfNotExist;
+ }
+
  public boolean includeInnodbStatusInDeadlockExceptions() {
  return includeInnodbStatusInDeadlockExceptions;
  }
@@ -1198,6 +1208,7 @@ public static final class Builder implements Cloneable {
  private String timezone;
  private Boolean autocommit;
  private Boolean useMysqlMetadata;
+ private Boolean createDatabaseIfNotExist;
  private Integer defaultFetchSize;
  private Integer maxQuerySizeToLog;
  private Integer maxAllowedPacket;
@@ -1632,6 +1643,11 @@ public Builder useMysqlMetadata(Boolean useMysqlMetadata) {
  return this;
  }
 
+ public Builder createDatabaseIfNotExist(Boolean createDatabaseIfNotExist) {
+ this.createDatabaseIfNotExist = createDatabaseIfNotExist;
+ return this;
+ }
+
  public Builder includeInnodbStatusInDeadlockExceptions(
  Boolean includeInnodbStatusInDeadlockExceptions) {
  this.includeInnodbStatusInDeadlockExceptions = includeInnodbStatusInDeadlockExceptions;
@@ -1789,6 +1805,7 @@ public Configuration build() throws SQLException {
  this.useBulkStmts,
  this.autocommit,
  this.useMysqlMetadata,
+ this.createDatabaseIfNotExist,
  this.includeInnodbStatusInDeadlockExceptions,
  this.includeThreadDumpInDeadlockExceptions,
  this.servicePrincipalName,

src/main/java/org/mariadb/jdbc/client/impl/ConnectionHelper.java

@@ -189,7 +189,7 @@ public static long initializeClientCapabilities(
  capabilities |= Capabilities.COMPRESS;
  }
 
- if (configuration.database() != null) {
+ if (configuration.database() != null && !configuration.createDatabaseIfNotExist()) {
  capabilities |= Capabilities.CONNECT_WITH_DB;
  }
  return capabilities;

src/main/java/org/mariadb/jdbc/client/impl/StandardClient.java

@@ -304,6 +304,12 @@ private void postConnectionQueries() throws SQLException {
  commands.add("SET SESSION TRANSACTION READ ONLY");
  }
 
+ if (conf.database() != null && conf.createDatabaseIfNotExist()) {
+ String escapedDb = conf.database().replace("`", "``");
+ commands.add(String.format("CREATE DATABASE IF NOT EXISTS `%s`", escapedDb));
+ commands.add(String.format("USE `%s`", escapedDb));
+ }
+
  try {
  List<Completion> res;
  ClientMessage[] msgs = new ClientMessage[commands.size()];

src/main/resources/driver.properties

@@ -61,4 +61,5 @@ tcpKeepIdle=permit setting socket TCP_KEEPIDLE value. Only valid for java 11+(fo
 tcpKeepCount=permit setting socket TCP_KEEPCOUNT value. Only valid for java 11+(for previous version, this option will have no use). (Integer) Default null
 tcpKeepInterval=permit setting socket TCP_KEEPINTERVAL value. Only valid for java 11+(for previous version, this option will have no use). (Integer) Default null
 useMysqlMetadata=force DatabaseMetadata.getDatabaseProductName() to return "MySQL" (for compatibility reason)
-maxAllowedPacket=permit to driver to avoid sending command with size > to server max_allowed_packet, throwing an error in place of server dropping the connection.
+maxAllowedPacket=permit to driver to avoid sending command with size > to server max_allowed_packet, throwing an error in place of server dropping the connection.
+createDatabaseIfNotExist=the specified database in the url will be created if nonexistent. Default: false

src/test/java/org/mariadb/jdbc/integration/ConnectionTest.java

@@ -1063,4 +1063,32 @@ public void timezone() throws SQLException {
  con.isValid(1);
  }
  }
+
+ @Test
+ public void createDatabaseIfNotExist() throws SQLException {
+ Assumptions.assumeTrue(
+ !"skysql".equals(System.getenv("srv")) && !"skysql-ha".equals(System.getenv("srv")));
+
+ // ensure connecting without DB
+ String connStr =
+ String.format(
+ "jdbc:mariadb://%s:%s/?user=%s&password=%s&restrictedAuth=none&%s&createDatabaseIfNotExist",
+ hostname, port, user, password, defaultOther);
+ try (Connection con = DriverManager.getConnection(connStr)) {
+ con.createStatement().executeQuery("SELECT 1");
+ }
+ sharedConn.createStatement().execute("DROP DATABASE IF EXISTS `bla``f``l`");
+ String nonExistentDatabase = "bla`f`l";
+ connStr =
+ String.format(
+ "jdbc:mariadb://%s:%s/%s?user=%s&password=%s&restrictedAuth=none&%s&createDatabaseIfNotExist",
+ hostname, port, nonExistentDatabase, user, password, defaultOther);
+ try (Connection con = DriverManager.getConnection(connStr)) {
+ ResultSet rs = con.createStatement().executeQuery("select DATABASE()");
+ assertTrue(rs.next());
+ assertEquals(nonExistentDatabase, rs.getString(1));
+ }
+
+ sharedConn.createStatement().execute("DROP DATABASE IF EXISTS `bla``f``l`");
+ }
 }

src/test/java/org/mariadb/jdbc/unit/util/ConfigurationTest.java

@@ -824,10 +824,11 @@ public void builder() throws SQLException {
  .serverSslCert("mycertPath")
  .serverRsaPublicKeyFile("RSAPath")
  .allowPublicKeyRetrieval(true)
+ .createDatabaseIfNotExist(true)
  .maxAllowedPacket(8000)
  .build();
  assertEquals(
- "jdbc:mariadb://host1:3305,address=(host=host2)(port=3307)(type=replica)/db?user=me&password=pwd&timezone=UTC&autocommit=false&transactionIsolation=REPEATABLE_READ&defaultFetchSize=10&maxQuerySizeToLog=100&maxAllowedPacket=8000&geometryDefaultType=default&restrictedAuth=mysql_native_password,client_ed25519&socketFactory=someSocketFactory&connectTimeout=22&pipe=pipeName&localSocket=localSocket&tcpKeepAlive=false&tcpKeepIdle=10&tcpKeepCount=50&tcpKeepInterval=50&tcpAbortiveClose=true&localSocketAddress=localSocketAddress&socketTimeout=1000&useReadAheadInput=false&tlsSocketType=TLStype&sslMode=TRUST&serverSslCert=mycertPath&keyStore=/tmp&keyStorePassword=MyPWD&keyStoreType=JKS&enabledSslCipherSuites=myCipher,cipher2&enabledSslProtocolSuites=TLSv1.2&allowMultiQueries=true&allowLocalInfile=true&useCompression=true&useAffectedRows=true&useBulkStmts=false&cachePrepStmts=false&prepStmtCacheSize=2&useServerPrepStmts=true&credentialType=ENV&sessionVariables=blabla&connectionAttributes=bla=bla&servicePrincipalName=SPN&blankTableNameMeta=true&tinyInt1isBit=false&yearIsDateType=false&dumpQueriesOnException=true&includeInnodbStatusInDeadlockExceptions=true&includeThreadDumpInDeadlockExceptions=true&retriesAllDown=10&galeraAllowedState=A,B&transactionReplay=true&pool=true&poolName=myPool&maxPoolSize=16&minPoolSize=12&maxIdleTime=25000&registerJmxPool=false&poolValidMinDelay=260&useResetConnection=true&serverRsaPublicKeyFile=RSAPath&allowPublicKeyRetrieval=true",
+ "jdbc:mariadb://host1:3305,address=(host=host2)(port=3307)(type=replica)/db?user=me&password=pwd&timezone=UTC&autocommit=false&createDatabaseIfNotExist=true&transactionIsolation=REPEATABLE_READ&defaultFetchSize=10&maxQuerySizeToLog=100&maxAllowedPacket=8000&geometryDefaultType=default&restrictedAuth=mysql_native_password,client_ed25519&socketFactory=someSocketFactory&connectTimeout=22&pipe=pipeName&localSocket=localSocket&tcpKeepAlive=false&tcpKeepIdle=10&tcpKeepCount=50&tcpKeepInterval=50&tcpAbortiveClose=true&localSocketAddress=localSocketAddress&socketTimeout=1000&useReadAheadInput=false&tlsSocketType=TLStype&sslMode=TRUST&serverSslCert=mycertPath&keyStore=/tmp&keyStorePassword=MyPWD&keyStoreType=JKS&enabledSslCipherSuites=myCipher,cipher2&enabledSslProtocolSuites=TLSv1.2&allowMultiQueries=true&allowLocalInfile=true&useCompression=true&useAffectedRows=true&useBulkStmts=false&cachePrepStmts=false&prepStmtCacheSize=2&useServerPrepStmts=true&credentialType=ENV&sessionVariables=blabla&connectionAttributes=bla=bla&servicePrincipalName=SPN&blankTableNameMeta=true&tinyInt1isBit=false&yearIsDateType=false&dumpQueriesOnException=true&includeInnodbStatusInDeadlockExceptions=true&includeThreadDumpInDeadlockExceptions=true&retriesAllDown=10&galeraAllowedState=A,B&transactionReplay=true&pool=true&poolName=myPool&maxPoolSize=16&minPoolSize=12&maxIdleTime=25000&registerJmxPool=false&poolValidMinDelay=260&useResetConnection=true&serverRsaPublicKeyFile=RSAPath&allowPublicKeyRetrieval=true",
  conf.toString());
  }