db_write_conf: Write Configuration

Description Usage Arguments Details Examples

View source: R/RMariaDBHelper.R

Description

Write database configuration settings to a file.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
db_write_conf(
  conf_file = "~/.db_conf.yml",
  username = NULL,
  host = NULL,
  dbname = NULL,
  sslmode = NULL,
  sslca = NULL,
  sslkey = NULL,
  sslcert = NULL
)

Arguments

conf_file

(character) Configuration file to write. (Default: "~/.db_conf.yml")

username

(character) Username. (Default: NULL)

host

(character) Database server hostname. (Default: NULL)

dbname

(character) Database name. (Default: NULL)

sslmode

(character) SSL mode. (Default: NULL)

sslca

(character) CCL CA path. (Default: NULL)

sslkey

(character) SSL key path. (Default: NULL)

sslcert

(character) SSL certificate path. (Default: NULL)

Details

A configuration file will be created with the values provided. For details about the arguments, see the documentation for RMariaDB::dbConnect.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
db_write_conf(conf_file = "~/.db_conf.yml",
              username = "my_username",
              host = "db.server.example.com",
              dbname = "my_dbname",
              sslmode = "REQUIRED",
              sslca = "/etc/db-ssl/ca-cert.pem",
              sslkey = "/etc/db-ssl/client-key-pkcs1.pem",
              sslcert = "/etc/db-ssl/client-cert.pem")
file.edit("~/.db_conf.yml")

## End(Not run)

deohs/RMariaDBHelper documentation built on Dec. 31, 2020, 11:17 p.m.