db_connect: Initialize Connection

Description Usage Arguments Value Details Examples

View source: R/RMariaDBHelper.R

Description

Initialize a connection to the database and return a DBIConnection.

Usage

1
db_connect(conf_file = "~/.db_conf.yml", ...)

Arguments

conf_file

(character) A file containing database connection parameters. (Default: "~/.db_conf.yml")

...

Additional arguments passed to RMariaDB::MariaDB().

Value

(DBIConnection) A DBIConnection for success; FALSE for failure.

Details

A configuration file will be read and used to connect to the database.

Examples

1
2
3
4
## Not run: 
channel <- db_connect()

## End(Not run)

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