Learn R Programming
tcpl (version 1.2.2)

Configure functions: Functions for configuring the tcpl package

Description

These functions are used to configure the tcpl settings.

Usage

tcplConf(drvr = NULL, user = NULL, pass = NULL, host = NULL, db = NULL)


tcplConfDefault()


tcplConfList(show.pass = FALSE)


tcplConfLoad()


tcplConfReset()


tcplConfSave()

Arguments

drvr
Character of length 1, which database driver to use
user
Character of length 1, the database server username
pass
Character of length 1, the database server password
host
Character of length 1, the database server
db
Character of length 1, the name of the tcpl database
show.pass
Logical, should the password be returned

Details

Currently, the tcpl package only supports the "MySQL" and "SQLite" database drivers.

tcplConf changes options to set the tcpl-specific options, most importantly to configure the connection to the tcpl databases. tcplConf will only change non-null values, and can be used to change a single value if needed.

tcplConfSave modifies the TCPL.config file to reflect the current tcpl settings.

tcplConfList lists the values assigned to the tcpl global options.

tcplConfLoad updates the tcpl settings to reflect the current configuration file.

tcplConfDefault changes the options to reflect the default settings for the example SQLite database, but does not alter the configuration file.

tcplConfReset is used to generate the initial configuration script, and can be used to reset or regenerate the configuration script by the user.