getDB.RdGet a connection established to a database and return the information desired in the specific query.
getDB(
sql,
database = "PacFIN",
datasourcename = lifecycle::deprecated(),
username,
password,
asis = FALSE
)A valid SQL statement.
A string providing the name of the database that you wish to
connect to. This string must match the name that is used to configure the
database on your computer exactly. The default is "PacFIN" which will
lead to pulling data from the Pacific Fisheries Information Network.
Deprecated as of version 0.2.9. Please use the
database argument instead.
Most often, this is a string containing your username for the
database of interest. You can use getUserName() if you prefer to not
enter this argument and assume the default search and/or rules for finding
your username will work. This is the default behavior if you leave
username as a missing argument, i.e., username <- getUserName(database = database). Sometimes this search will fail because of legacy rules, which
are unknown to the development team, that were used to create your
username. Please email the maintainer of this package if you need more
functionality here.
Most often, this is a string containing your password for
the database of interest. You can use the function ask_password() if you
would prefer to be prompted for your password. Please do not share this
password with anyone or push code to a repository that has your password
saved in it.
A logical, specifying whether or not to leave columns as is
rather than convert them to factors, as defined in RODBC::sqlGetResults()
and utils::read.table(). This logical is first passed to
RODBC::sqlQuery(), then to RODBC::sqlGetResults(), and finally to
utils::read.table(), where inside of utils::read.table(), if the
logical is a single value, it is repeated for every column present, and
thus, you do not need to know how many columns the resulting data set is.
The default behavior within this package is FALSE, which does NOT leave
the columns as is. In fact, if you set asis = TRUE many functions within
this package will fail because it leads to all columns in the downloaded
data frame being of the character class causing downstream calculations
that assume numerical output to fail because they are characters.
A data frame resulting from querying the database or an
error message because the main call is wrapped in
tryCatch.