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
43
44
45
46
47
48
49
50
51
52
53
54
55
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/DBIConnector.R
\docType{class}
\name{DBIConnector-class}
\alias{DBIConnector-class}
\title{DBIConnector class}
\description{
Wraps objects of the \linkS4class{DBIDriver} class to include connection options.
The purpose of this class is to store both the driver
and the connection options.
A database connection can be established
with a call to \code{\link[=dbConnect]{dbConnect()}}, passing only that object
without additional arguments.
}
\details{
To prevent leakage of passwords and other credentials,
this class supports delayed evaluation.
All arguments can optionally be a function (callable without arguments).
In such a case, the function is evaluated transparently when connecting in
\code{\link[=dbGetConnectArgs]{dbGetConnectArgs()}}.
}
\examples{
\dontshow{if (requireNamespace("RSQLite", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
# Create a connector:
cnr <- new("DBIConnector",
.drv = RSQLite::SQLite(),
.conn_args = list(dbname = ":memory:")
)
cnr
# Establish a connection through this connector:
con <- dbConnect(cnr)
con
# Access the database through this connection:
dbGetQuery(con, "SELECT 1 AS a")
dbDisconnect(con)
\dontshow{\}) # examplesIf}
}
\seealso{
Other DBI classes:
\code{\link{DBIConnection-class}},
\code{\link{DBIDriver-class}},
\code{\link{DBIObject-class}},
\code{\link{DBIResult-class}},
\code{\link{DBIResultArrow-class}}
Other DBIConnector generics:
\code{\link{dbConnect}()},
\code{\link{dbDataType}()},
\code{\link{dbGetConnectArgs}()},
\code{\link{dbIsReadOnly}()}
}
\concept{DBI classes}
\concept{DBIConnector generics}
|
