setup_option_file: Setup MySQL database connection option file

View source: R/setup.R

setup_option_fileR Documentation

Setup MySQL database connection option file

Description

This function will create a MySQL option file at the given path. To ensure it works, set these environment variables before calling this function:

  • MYSQL_HOST: The host name of the MySQL server.

  • MYSQL_USER: The user name of the MySQL server.

  • MYSQL_PASSWORD: The password of the MySQL server.

Usage

setup_option_file(path = NULL, overwrite = FALSE, quietly = FALSE)

Arguments

path

The path to the option file. Default location is operating system dependent. On Windows, it is ⁠C:/my.cnf⁠. On other systems, it is ⁠~/.my.cnf⁠.

overwrite

Whether to overwrite the existing option file.

quietly

A logical indicates whether message should be suppressed.

Value

NULL (invisible).


psychelzh/tarflow.iquizoo documentation built on July 16, 2025, 6:03 p.m.