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
56
57
58
59
60
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/01-DBIObject.R
\docType{class}
\name{DBIObject-class}
\alias{DBIObject-class}
\title{DBIObject class}
\description{
Base class for all other DBI classes (e.g., drivers, connections). This
is a virtual Class: No objects may be created from it.
}
\details{
More generally, the DBI defines a very small set of classes and generics that
allows users and applications access DBMS with a common interface. The
virtual classes are \code{DBIDriver} that individual drivers extend,
\code{DBIConnection} that represent instances of DBMS connections, and
\code{DBIResult} that represent the result of a DBMS statement. These three
classes extend the basic class of \code{DBIObject}, which serves as the root
or parent of the class hierarchy.
}
\section{Implementation notes}{
An implementation MUST provide methods for the following generics:
\itemize{
\item \code{\link[=dbGetInfo]{dbGetInfo()}}.
}
It MAY also provide methods for:
\itemize{
\item \code{\link[=summary]{summary()}}. Print a concise description of the
object. The default method invokes \code{dbGetInfo(dbObj)} and prints
the name-value pairs one per line. Individual implementations may
tailor this appropriately.
}
}
\examples{
\dontshow{if (requireNamespace("RSQLite", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
drv <- RSQLite::SQLite()
con <- dbConnect(drv)
rs <- dbSendQuery(con, "SELECT 1")
is(drv, "DBIObject") ## True
is(con, "DBIObject") ## True
is(rs, "DBIObject")
dbClearResult(rs)
dbDisconnect(con)
\dontshow{\}) # examplesIf}
}
\seealso{
Other DBI classes:
\code{\link{DBIConnection-class}},
\code{\link{DBIConnector-class}},
\code{\link{DBIDriver-class}},
\code{\link{DBIResult-class}},
\code{\link{DBIResultArrow-class}}
}
\concept{DBI classes}
|
