CONCPP-146 Adding initSql option for queries to be run at connection

time. This can be single query or a ';' separated list of queries.

The testcase hase been added.

Author: lawrinn

README

@@ -165,7 +165,7 @@ prepStmtCacheSqlLimit    This is the maximum length of a (SQL query length + sch
 connectionAttributes     If performance_schema is enabled, permits to send server
                          some client information in a key:value pair format
                          (example: connectionAttributes=key1:value1,key2,value2)      string
-log`                     The logging level. Setting it to non-zero effectively turns
+log                      The logging level. Setting it to non-zero effectively turns
                          on the logging. The levels are 1- error, 2- warning, 3- info,
                          4 - debug, 5-trace                                           uint
 logname                  Name of the file to write the log in. If the name is set,
@@ -174,6 +174,8 @@ logname                  Name of the file to write the log in. If the name is se
                          default name and location for the log file. The name is
                          mariadbccpp.log, the location is %TMP% or %USERPROFILE% or
                          current dir on Windows, or $HOME or /tmp on other systems.   string
+initSql     One query or a semicolon separated list of queried to be executed at the
+            connection time.                                                          string
 
 
 Properties is map of strings, and is another way to pass optional parameters.

README.md

@@ -112,6 +112,7 @@ The list of supported options:
 | **`connectionAttributes`** |If performance_schema is enabled, permits to send server some client information in a key:value pair format (example: connectionAttributes=key1:value1,key2,value2) This information can be retrieved on server within tables performance_schema.session_connect_attrs and performance_schema.session_account_connect_attrs. This allows an identification of client/application on server|*string* |||
 | **`log`**|The logging level. Setting it to non-zero effectively turns on the logging. The levels are 1- error, 2- warning, 3- info, 4 - debug, 5-trace|*uint*|0||
 | **`logname`** |Name of the file to write the log in. If the name is set, and the log level is not, the level will be set to 'error'. The option does not have default value, but the logger has default name and location for the log file. The name is mariadbccpp.log, the location is %TMP% or %USERPROFILE% or current dir on Windows, or $HOME or /tmp on other systems.|*string*|||
+| **`initSql`** |One query or a semicolon separated list of queried to be executed at the connection time.|*string*|||
 
 
 Properties is map of strings, and is another way to pass optional parameters.

src/options/DefaultOptions.cpp

@@ -1,5 +1,5 @@
 /************************************************************************************
-   Copyright (C) 2020, 2023 MariaDB Corporation AB
+   Copyright (C) 2020, 2025 MariaDB Corporation plc
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
@@ -403,8 +403,7 @@ namespace sql
         "tlsCRLPath", {"tlsCRLPath",
         "0.9.2",
         "A path to a directory that contains one or more PEM files that should each contain one revoked X509 certificate.\n"
-        "The directory specified by this option needs to be run through the openssl rehash command.\n"
-        " ",
+        "The directory specified by this option needs to be run through the openssl rehash command.",
         false,
         ""}
       },
@@ -714,6 +713,13 @@ namespace sql
         "Default authentication client-side plugin to use",
         false,
         ""}
+      },
+      {
+        "initSql", {"initSql",
+        "1.1.7",
+        "SQL command(s) to run at connection time",
+        false,
+        ""}
       }
     };
 

src/options/Options.cpp

@@ -140,7 +140,8 @@ namespace mariadb
     OPTIONS_FIELD(useResetConnection),
     OPTIONS_FIELD(useReadAheadInput),
     OPTIONS_FIELD(serverRsaPublicKeyFile),
-    OPTIONS_FIELD(tlsPeerFP)
+    OPTIONS_FIELD(tlsPeerFP),
+    OPTIONS_FIELD(initSql)
   };
 
 
@@ -525,6 +526,9 @@ namespace mariadb
     if (!(tlsPeerFPList.compare(opt->tlsPeerFPList) == 0)) {
       return false;
     }
+    if (!(initSql.compare(opt->initSql) == 0)) {
+      return false;
+    }
     return minPoolSize == opt->minPoolSize;
   }
 
@@ -618,9 +622,11 @@ namespace mariadb
     result= 31 *result + (autocommit ? 1 : 0);
     result= 31 *result + (!credentialType.empty() ? credentialType.hashCode() : 0);
 
-    result= 31 *result + (!nonMappedOptions.empty() ? hashProps(nonMappedOptions) : 0);
+    result= 31*result + (!nonMappedOptions.empty() ? hashProps(nonMappedOptions) : 0);
+
+    result= 31*result + (!tlsPeerFPList.empty() ? tlsPeerFPList.hashCode() : 0);
+    result= 31*result + (!initSql.empty() ? initSql.hashCode() : 0);
 
-    result= 31 *result + (!tlsPeerFPList.empty() ? tlsPeerFPList.hashCode() : 0);
     return result;
   }
 

src/options/Options.h

@@ -1,5 +1,5 @@
 /************************************************************************************
-   Copyright (C) 2020,2024 MariaDB Corporation plc
+   Copyright (C) 2020,2025 MariaDB Corporation plc
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
@@ -138,6 +138,7 @@ struct Options
   bool      useReadAheadInput= true;
   SQLString serverRsaPublicKeyFile;
   SQLString tlsPeerFP;
+  SQLString initSql;
 
   SQLString toString() const;
   bool      equals(Options* obj);

src/protocol/capi/ConnectProtocol.cpp

@@ -455,6 +455,13 @@ namespace capi
     mysql_optionsv(connection.get(), MYSQL_REPORT_DATA_TRUNCATION, &uintOptionSelected);
     mysql_optionsv(connection.get(), MYSQL_OPT_LOCAL_INFILE, (options->allowLocalInfile ? &uintOptionSelected : &uintOptionNotSelected));
 
+    if (!options.get()->initSql.empty()) {
+      static const SQLString initSqlDelim(";");
+      auto Query= split(options.get()->initSql, initSqlDelim);
+      for (auto& sql : *Query) {
+        mysql_optionsv(connection.get(), MYSQL_INIT_COMMAND, sql.c_str());
+      }
+    }
     if (mysql_real_connect(connection.get(), NULL, NULL, NULL, NULL, 0, NULL, CLIENT_MULTI_STATEMENTS) == nullptr)
     {
       throw SQLException(mysql_error(connection.get()), mysql_sqlstate(connection.get()), mysql_errno(connection.get()));

test/unit/classes/connection.cpp

@@ -3523,6 +3523,25 @@ void connection::concpp112_connection_attributes()
   con.reset();
 }
 
+
+void connection::concpp146_initSQL()
+{
+  sql::Properties p{{"user", user}, {"password", passwd}};
+  con.reset(driver->connect(addOptions2url("initSql=SET @myVar='YourVar'"), p));
+  stmt.reset(con->createStatement());
+  res.reset(stmt->executeQuery("SELECT @myVar"));
+  ASSERT(res->next());
+  ASSERT_EQUALS("YourVar", res->getString(1));
+
+  con.reset(driver->connect(addOptions2url("&initSql=SET @myVar='YourVar';SET @myVar2='YourVar2'"), p));
+  stmt.reset(con->createStatement());
+  res.reset(stmt->executeQuery("SELECT @myVar, @myVar2"));
+  ASSERT(res->next());
+  ASSERT_EQUALS("YourVar", res->getString(1));
+  ASSERT_EQUALS("YourVar2", res->getString(2));
+}
+
+
 void connection::setUp()
 {
   super::setUp();

test/unit/classes/connectiontest.h

@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
- *               2020, 2022 MariaDB Corporation AB
+ *               2020, 2025 MariaDB Corporation plc
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -96,6 +96,7 @@ class connection : public unit_fixture
     TEST_CASE(concpp4_sequentialfailover);
     TEST_CASE(concpp105_conn_concurrency);
     TEST_CASE(concpp112_connection_attributes);
+    TEST_CASE(concpp146_initSQL);
   }
 
   /**
@@ -297,6 +298,9 @@ class connection : public unit_fixture
   /* Setting of connection attributes for perfschema */
   void concpp112_connection_attributes();
 
+  /* Test of initSql option */
+  void concpp146_initSQL();
+
   void setUp();
 };