dbConnection: dbConnection class

Description Details Methods Public fields Active bindings Methods Examples

Description

connect to database using either DBI or pool

Details

dbConnection class

connect using DBI or pool

Methods

connect

connect to database

close

close connection to database

dbSendQuery

send query (statement) to connection

dbGetQuery

send query to connection

Public fields

DBIconn

- connection using DBI (NULL if not connected)

poolconn

- connection using pool (NULL is not connected)

conn()

- connection using whichever connection is available

Active bindings

conn()

- connection using whichever connection is available

Methods

Public methods


Method connect()

Usage
dbConnection$connect(drv, ..., usepool = TRUE)

Method close()

Usage
dbConnection$close()

Method is_open()

Usage
dbConnection$is_open()

Method finalize()

Usage
dbConnection$finalize()

Method conn()

Usage
dbConnection$conn(value)

Method dbSendQuery()

Usage
dbConnection$dbSendQuery(query, data_for_sql)

Method dbSendGlueQuery()

Usage
dbConnection$dbSendGlueQuery(query, ...)

Method dbGetQuery()

Usage
dbConnection$dbGetQuery(query)

Method open_log_db()

Usage
dbConnection$open_log_db(filename, tag)

Method write_log_db()

Usage
dbConnection$write_log_db(query = "", data = "")

Method duration_log_db()

Usage
dbConnection$duration_log_db(log_detail)

Method close_log_db()

Usage
dbConnection$close_log_db()

Method clone()

The objects of this class are cloneable with this method.

Usage
dbConnection$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
dbConnection$new() # creates new object

dbConnection$connect(
  drv = RSQLite::SQLite(),
  dbname = "mydatabase.sqlite",
  usepool = FALSE
)
# sets $DBIconn or $poolcon to connection
# both set to NULL if fail/warn
# by default 'usepool' is TRUE and attempts
# to use 'pool' package (if available)
# if 'usepool' is FALSE, then do not use
# the 'pool' package, so use 'DBI' instead

dbConnection$close() # closes all connections

query <- "UPDATE Users SET Name = ? WHERE id = ?"
data_for_sql <- list(c("John"), id)
dbConnection$dbSendQuery(query, data_for_sql)
# send parametized 'SQL query'
# with 'data_for_sql'

DavidPatShuiFong/dbConnection documentation built on July 10, 2020, 2:40 p.m.