Skip to content

fix: add SSL mode support to MySQL/MariaDB connections (#36505) #1534

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

Open
hidekoji wants to merge 5 commits into
base: master
Choose a base branch
from
Open

fix: add SSL mode support to MySQL/MariaDB connections (#36505) #1534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d0a5ce1
fix: add SSL mode support to MySQL/MariaDB connections (#36505)
hidekoji Jul 2, 2026
306b3df
chore: bump version to 15.1.24
hidekoji Jul 2, 2026
0e59d75
Merge branch 'master' into fix/issue-36505
hidekoji Jul 2, 2026
f00e5e8
Update DESCRIPTION
hidekoji Jul 2, 2026
e81b989
bump version to 15.2.2
hidekoji Jul 2, 2026
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
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: exploratory
Type: Package
Title: R package for Exploratory
Version: 15.2.1
Version: 15.2.2
Date: 2026-07-01
Authors@R: c(person("Hideaki", "Hayashi", email = "hideaki@exploratory.io", role = c("aut", "cre")), person("Hide", "Kojima", email = "hide@exploratory.io", role = c("aut")), person("Kan", "Nishida", email = "kan@exploratory.io", role = c("aut")), person("Kei", "Saito", email = "kei@exploratory.io", role = c("aut")), person("Yosuke", "Yasuda", email = "double.y.919.quick@gmail.com", role = c("aut")))
URL: https://github.com/exploratory-io/exploratory_func
Expand Down
47 changes: 24 additions & 23 deletions R/system.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1011,7 +1011,7 @@ getDBConnection <- function(type, host = NULL, port = "", databaseName = "", use
if(Sys.info()["sysname"] == "Linux" && sslCA != ""){
sslCA <- "/etc/ssl/certs/rds-combined-ca-bundle.pem";
}
key <- paste("mysql", host, port, databaseName, username, timezone, sslCA, sep = ":")
key <- paste("mysql", host, port, databaseName, username, timezone, sslCA, sslMode, sep = ":")
conn <- connection_pool[[key]]
if (!is.null(conn)){
tryCatch({
Expand All @@ -1036,26 +1036,27 @@ getDBConnection <- function(type, host = NULL, port = "", databaseName = "", use
# fall through to getting new connection.
})
}
# Map PostgreSQL-style sslMode values to RMariaDB ssl.mode constants.
rmariadb_ssl_mode <- switch(sslMode,
"disable" = "SSL_MODE_DISABLED",
"allow" = "SSL_MODE_PREFERRED",
"prefer" = "SSL_MODE_PREFERRED",
"require" = "SSL_MODE_REQUIRED",
"verify-ca" = "SSL_MODE_VERIFY_CA",
"verify-full"= "SSL_MODE_VERIFY_IDENTITY",
NULL # empty string or unknown -> let RMariaDB use its default
)
# if the connection is null or the connection is invalid, create a new one.
if (is.null(conn) || !DBI::dbIsValid(conn)) {
# To avoid integer64 handling issues in charts, etc., use numeric as the R type to receive bigint data rather than default integer64 by specifying bigint argument.
if (timezone != "") {# if Timezone is set use it for timezone and timezone_out
if (sslCA != "") { # if sslCA is set, pass it as ssl.ca
conn = RMariaDB::dbConnect(RMariaDB::MariaDB(), dbname = databaseName, username = username, timezone = timezone, timezone_out = timezone,
password = password, host = host, port = port, bigint = "numeric", ssl.ca = sslCA)
} else { # if sslCA is not set, do not set it since passing empty string causes Error : Failed to connect: SSL connection error: No such file or directory
conn = RMariaDB::dbConnect(RMariaDB::MariaDB(), dbname = databaseName, username = username, timezone = timezone, timezone_out = timezone,
password = password, host = host, port = port, bigint = "numeric")
}
} else {# if sslCA is set, pass it as ssl.ca
if (sslCA != "") {
conn = RMariaDB::dbConnect(RMariaDB::MariaDB(), dbname = databaseName, username = username,
password = password, host = host, port = port, bigint = "numeric", ssl.ca = sslCA)
} else {# if sslCA is not set, do not set it since passing empty string causes Error : Failed to connect: SSL connection error: No such file or directory
conn = RMariaDB::dbConnect(RMariaDB::MariaDB(), dbname = databaseName, username = username,
password = password, host = host, port = port, bigint = "numeric")
}
}
tz_args <- if (timezone != "") list(timezone = timezone, timezone_out = timezone) else list()
ca_args <- if (sslCA != "") list(ssl.ca = sslCA) else list()
mode_args <- if (!is.null(rmariadb_ssl_mode)) list(ssl.mode = rmariadb_ssl_mode) else list()
conn <- do.call(RMariaDB::dbConnect, c(
list(RMariaDB::MariaDB(), dbname = databaseName, username = username,
password = password, host = host, port = port, bigint = "numeric"),
tz_args, ca_args, mode_args
))
connection_pool[[key]] <- conn
}
} else if (type == "postgres" || type == "redshift" || type == "vertica") {
Expand Down Expand Up @@ -1857,7 +1858,7 @@ clearDBConnection <- function(type, host = NULL, port = NULL, databaseName, user
}
else if (type %in% c("mysql", "aurora")) {
# they use common key "mysql"
key <- paste("mysql", host, port, databaseName, username, timezone, sslCA, sep = ":")
key <- paste("mysql", host, port, databaseName, username, timezone, sslCA, sslMode, sep = ":")
conn <- connection_pool[[key]]
if (!is.null(conn)) {
tryCatch({ # try to close connection and ignore error
Expand Down Expand Up @@ -2010,7 +2011,7 @@ getListOfColumns <- function(type, host, port, databaseName, username, password,
#' @export
executeGenericQuery <- function(type, host, port, databaseName, username, password, query, catalog = "", schema = "", numOfRows = -1, timezone = "", sslCA = "", sslMode = "", role = "", ...){
if (type %in% c("mysql", "aurora")) { # In case of MySQL, just use queryMySQL, since it has workaround to read multibyte column names without getting garbled.
df <- queryMySQL(host, port, databaseName, username, password, numOfRows = numOfRows, query, timezone = timezone, sslCA = sslCA)
df <- queryMySQL(host, port, databaseName, username, password, numOfRows = numOfRows, query, timezone = timezone, sslCA = sslCA, sslMode = sslMode)
df <- readr::type_convert(df)
# It is hackish, but to read multibyte character data correctly, type_convert helps for some reason.
# There is small chance of column getting converted to unwanted type, but for our usage, that is unlikely, and being able to read multibyte outweighs the potential drawback.
Expand Down Expand Up @@ -2048,19 +2049,19 @@ executeGenericQuery <- function(type, host, port, databaseName, username, passwo


#' @export
queryMySQL <- function(host, port, databaseName, username, password, numOfRows = -1, query, timezone = "", sslCA = "", ...){
queryMySQL <- function(host, port, databaseName, username, password, numOfRows = -1, query, timezone = "", sslCA = "", sslMode = "", ...){
if(!requireNamespace("RMariaDB")){stop("package RMariaDB must be installed.")}
if(!requireNamespace("DBI")){stop("package DBI must be installed.")}

conn <- getDBConnection(type = "mysql", host = host, port = port, databaseName = databaseName, username = username, password = password, timezone = timezone, sslCA = sslCA)
conn <- getDBConnection(type = "mysql", host = host, port = port, databaseName = databaseName, username = username, password = password, timezone = timezone, sslCA = sslCA, sslMode = sslMode)
tryCatch({
query <- convertUserInputToUtf8(query)
# set envir = parent.frame() to get variables from users environment, not papckage environment
resultSet <- RMariaDB::dbSendQuery(conn, glue_exploratory(query, .transformer = sql_glue_transformer, .envir = parent.frame()))
df <- RMariaDB::dbFetch(resultSet, n = numOfRows)
}, error = function(err) {
# clear connection in pool so that new connection will be used for the next try
clearDBConnection("mysql", host, port, databaseName, username, timezone = timezone)
clearDBConnection("mysql", host, port, databaseName, username, timezone = timezone, sslCA = sslCA, sslMode = sslMode)
stop(err)
})
RMariaDB::dbClearResult(resultSet)
Expand Down