dbGetConnectArgs: Get connection arguments

In DBI: R Database Interface

Get connection arguments

Description

Returns the arguments stored in a DBIConnector object for inspection, optionally evaluating them. This function is called by dbConnect() and usually does not need to be called directly.

\Sexpr[results=rd,stage=render]{DBI:::methods_as_rd("dbGetConnectArgs")}

Usage

dbGetConnectArgs(drv, eval = TRUE, ...)

Arguments

drv	A object inheriting from DBIConnector.
eval	Set to FALSE to return the functions that generate the argument instead of evaluating them.
...	Other arguments passed on to methods. Not otherwise used.

See Also

Other DBIConnector generics: DBIConnector-class, dbConnect(), dbDataType(), dbIsReadOnly()

Examples

cnr <- new("DBIConnector",
  .drv = RSQLite::SQLite(),
  .conn_args = list(dbname = ":memory:", password = function() "supersecret")
)
dbGetConnectArgs(cnr)
dbGetConnectArgs(cnr, eval = FALSE)

DBI documentation built on June 22, 2024, 9:41 a.m.