File: dbGetConnectArgs.Rd

package info (click to toggle)
dbi 1.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,740 kB
  • sloc: makefile: 2
file content (42 lines) | stat: -rw-r--r-- 1,324 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dbGetConnectArgs.R
\name{dbGetConnectArgs}
\alias{dbGetConnectArgs}
\title{Get connection arguments}
\usage{
dbGetConnectArgs(drv, eval = TRUE, ...)
}
\arguments{
\item{drv}{A object inheriting from \linkS4class{DBIConnector}.}

\item{eval}{Set to \code{FALSE} to return the functions that generate the argument
instead of evaluating them.}

\item{...}{Other arguments passed on to methods. Not otherwise used.}
}
\description{
Returns the arguments stored in a \linkS4class{DBIConnector} object for inspection,
optionally evaluating them.
This function is called by \code{\link[=dbConnect]{dbConnect()}}
and usually does not need to be called directly.

\Sexpr[results=rd,stage=render]{DBI:::methods_as_rd("dbGetConnectArgs")}
}
\examples{
\dontshow{if (requireNamespace("RSQLite", quietly = TRUE)) withAutoprint(\{ # examplesIf}
cnr <- new("DBIConnector",
  .drv = RSQLite::SQLite(),
  .conn_args = list(dbname = ":memory:", password = function() "supersecret")
)
dbGetConnectArgs(cnr)
dbGetConnectArgs(cnr, eval = FALSE)
\dontshow{\}) # examplesIf}
}
\seealso{
Other DBIConnector generics: 
\code{\link{DBIConnector-class}},
\code{\link{dbConnect}()},
\code{\link{dbDataType}()},
\code{\link{dbIsReadOnly}()}
}
\concept{DBIConnector generics}