diff --git a/DESCRIPTION b/DESCRIPTION index 9b5a4db1..3ddc1556 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,7 +2,7 @@ Package: DatabaseConnector Type: Package Title: Connecting to Various Database Platforms Version: 6.3.3 -Date: 2025-01-08 +Date: 2025-01-15 Authors@R: c( person("Martijn", "Schuemie", email = "schuemie@ohdsi.org", role = c("aut", "cre")), person("Marc", "Suchard", role = c("aut")), diff --git a/docs/articles/Connecting.html b/docs/articles/Connecting.html index 53dc211d..1d84d6a3 100644 --- a/docs/articles/Connecting.html +++ b/docs/articles/Connecting.html @@ -90,7 +90,7 @@

Connecting to a database

Martijn J. Schuemie

-

2025-01-09

+

2025-01-15

Source: vignettes/Connecting.Rmd @@ -266,7 +266,7 @@

Connecting to a SQLite databaseinsertTable(connection = conn, tableName = "cars", data = cars) -
## Inserting data took 0.0173 secs
+
## Inserting data took 0.017 secs
 querySql(conn, "SELECT COUNT(*) FROM main.cars;")
##   COUNT(*)
diff --git a/docs/articles/DbiAndDbplyr.html b/docs/articles/DbiAndDbplyr.html
index ef69a708..0b9a23c0 100644
--- a/docs/articles/DbiAndDbplyr.html
+++ b/docs/articles/DbiAndDbplyr.html
@@ -91,7 +91,7 @@ 

Using DatabaseConnector through DBI and

Martijn J. Schuemie

-

2025-01-09

+

2025-01-15

Source: vignettes/DbiAndDbplyr.Rmd diff --git a/docs/articles/Querying.html b/docs/articles/Querying.html index 711a2098..eb55fd9f 100644 --- a/docs/articles/Querying.html +++ b/docs/articles/Querying.html @@ -90,7 +90,7 @@

Querying a database

Martijn J. Schuemie

-

2025-01-09

+

2025-01-15

Source: vignettes/Querying.Rmd diff --git a/docs/news/index.html b/docs/news/index.html index 99b70333..6c3729a0 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -71,6 +71,7 @@

Arguments

conn
-

A DBIConnection object, as returned by +

A DBIConnection object, as returned by dbConnect().

diff --git a/docs/reference/dbExistsTable-DatabaseConnectorConnection-character-method.html b/docs/reference/dbExistsTable-DatabaseConnectorConnection-character-method.html index 5c459a9e..5aa7465a 100644 --- a/docs/reference/dbExistsTable-DatabaseConnectorConnection-character-method.html +++ b/docs/reference/dbExistsTable-DatabaseConnectorConnection-character-method.html @@ -81,7 +81,7 @@

Arguments

conn
-

A DBIConnection object, as returned by +

A DBIConnection object, as returned by dbConnect().

diff --git a/docs/reference/dbFetch-DatabaseConnectorDbiResult-method.html b/docs/reference/dbFetch-DatabaseConnectorDbiResult-method.html index a8d92dc9..c58fec3c 100644 --- a/docs/reference/dbFetch-DatabaseConnectorDbiResult-method.html +++ b/docs/reference/dbFetch-DatabaseConnectorDbiResult-method.html @@ -83,7 +83,7 @@

Arguments

res
-

An object inheriting from DBIResult, created by +

An object inheriting from DBIResult, created by dbSendQuery().

diff --git a/docs/reference/dbFetch-DatabaseConnectorJdbcResult-method.html b/docs/reference/dbFetch-DatabaseConnectorJdbcResult-method.html index 011e5b9d..7e1ab3f2 100644 --- a/docs/reference/dbFetch-DatabaseConnectorJdbcResult-method.html +++ b/docs/reference/dbFetch-DatabaseConnectorJdbcResult-method.html @@ -83,7 +83,7 @@

Arguments

res
-

An object inheriting from DBIResult, created by +

An object inheriting from DBIResult, created by dbSendQuery().

diff --git a/docs/reference/dbGetInfo-DatabaseConnectorConnection-method.html b/docs/reference/dbGetInfo-DatabaseConnectorConnection-method.html index 9e411df3..b0c8609b 100644 --- a/docs/reference/dbGetInfo-DatabaseConnectorConnection-method.html +++ b/docs/reference/dbGetInfo-DatabaseConnectorConnection-method.html @@ -69,8 +69,8 @@

Get DBMS metadata

-

Retrieves information on objects of class DBIDriver, -DBIConnection or DBIResult.

+

Retrieves information on objects of class DBIDriver, +DBIConnection or DBIResult.

@@ -83,9 +83,9 @@

Arguments

dbObj
-

An object inheriting from DBIObject, -i.e. DBIDriver, DBIConnection, -or a DBIResult

+

An object inheriting from DBIObject, +i.e. DBIDriver, DBIConnection, +or a DBIResult

...
@@ -94,11 +94,11 @@

Arguments

Value

-

For objects of class DBIDriver, dbGetInfo() +

For objects of class DBIDriver, dbGetInfo() returns a named list that contains at least the following components:

  • driver.version: the package version of the DBI backend,

  • client.version: the version of the DBMS client library.

  • -

For objects of class DBIConnection, dbGetInfo() +

For objects of class DBIConnection, dbGetInfo() returns a named list that contains at least the following components:

  • db.version: version of the database server,

  • dbname: database name,

  • @@ -107,7 +107,7 @@

    Value

  • port: port on the database server. It must not contain a password component. Components that are not applicable should be set to NA.

  • -

For objects of class DBIResult, dbGetInfo() +

For objects of class DBIResult, dbGetInfo() returns a named list that contains at least the following components:

  • statatment: the statement used with dbSendQuery() or dbExecute(), as returned by dbGetStatement(),

  • diff --git a/docs/reference/dbGetInfo-DatabaseConnectorDriver-method.html b/docs/reference/dbGetInfo-DatabaseConnectorDriver-method.html index 5bc11f2f..a05a71fc 100644 --- a/docs/reference/dbGetInfo-DatabaseConnectorDriver-method.html +++ b/docs/reference/dbGetInfo-DatabaseConnectorDriver-method.html @@ -69,8 +69,8 @@

    Get DBMS metadata

-

Retrieves information on objects of class DBIDriver, -DBIConnection or DBIResult.

+

Retrieves information on objects of class DBIDriver, +DBIConnection or DBIResult.

@@ -83,9 +83,9 @@

Arguments

dbObj
-

An object inheriting from DBIObject, -i.e. DBIDriver, DBIConnection, -or a DBIResult

+

An object inheriting from DBIObject, +i.e. DBIDriver, DBIConnection, +or a DBIResult

...
@@ -94,11 +94,11 @@

Arguments

Value

-

For objects of class DBIDriver, dbGetInfo() +

For objects of class DBIDriver, dbGetInfo() returns a named list that contains at least the following components:

  • driver.version: the package version of the DBI backend,

  • client.version: the version of the DBMS client library.

  • -

For objects of class DBIConnection, dbGetInfo() +

For objects of class DBIConnection, dbGetInfo() returns a named list that contains at least the following components:

  • db.version: version of the database server,

  • dbname: database name,

  • @@ -107,7 +107,7 @@

    Value

  • port: port on the database server. It must not contain a password component. Components that are not applicable should be set to NA.

  • -

For objects of class DBIResult, dbGetInfo() +

For objects of class DBIResult, dbGetInfo() returns a named list that contains at least the following components:

  • statatment: the statement used with dbSendQuery() or dbExecute(), as returned by dbGetStatement(),

  • diff --git a/docs/reference/dbGetQuery-DatabaseConnectorConnection-character-method.html b/docs/reference/dbGetQuery-DatabaseConnectorConnection-character-method.html index 89e8da92..2efd2d46 100644 --- a/docs/reference/dbGetQuery-DatabaseConnectorConnection-character-method.html +++ b/docs/reference/dbGetQuery-DatabaseConnectorConnection-character-method.html @@ -95,7 +95,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    diff --git a/docs/reference/dbGetRowCount-DatabaseConnectorDbiResult-method.html b/docs/reference/dbGetRowCount-DatabaseConnectorDbiResult-method.html index 34b13dbc..17e21d7f 100644 --- a/docs/reference/dbGetRowCount-DatabaseConnectorDbiResult-method.html +++ b/docs/reference/dbGetRowCount-DatabaseConnectorDbiResult-method.html @@ -83,7 +83,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbGetRowCount-DatabaseConnectorJdbcResult-method.html b/docs/reference/dbGetRowCount-DatabaseConnectorJdbcResult-method.html index bf5d96cd..e4ebdff0 100644 --- a/docs/reference/dbGetRowCount-DatabaseConnectorJdbcResult-method.html +++ b/docs/reference/dbGetRowCount-DatabaseConnectorJdbcResult-method.html @@ -83,7 +83,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbGetRowsAffected-DatabaseConnectorDbiResult-method.html b/docs/reference/dbGetRowsAffected-DatabaseConnectorDbiResult-method.html index 6a688216..52e4c0e0 100644 --- a/docs/reference/dbGetRowsAffected-DatabaseConnectorDbiResult-method.html +++ b/docs/reference/dbGetRowsAffected-DatabaseConnectorDbiResult-method.html @@ -83,7 +83,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.html b/docs/reference/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.html index 241dfd46..66f806a5 100644 --- a/docs/reference/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.html +++ b/docs/reference/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.html @@ -83,7 +83,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbGetStatement-DatabaseConnectorDbiResult-method.html b/docs/reference/dbGetStatement-DatabaseConnectorDbiResult-method.html index 89e1035c..d10267b1 100644 --- a/docs/reference/dbGetStatement-DatabaseConnectorDbiResult-method.html +++ b/docs/reference/dbGetStatement-DatabaseConnectorDbiResult-method.html @@ -83,7 +83,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbGetStatement-DatabaseConnectorJdbcResult-method.html b/docs/reference/dbGetStatement-DatabaseConnectorJdbcResult-method.html index 5fdab0ee..16ff7759 100644 --- a/docs/reference/dbGetStatement-DatabaseConnectorJdbcResult-method.html +++ b/docs/reference/dbGetStatement-DatabaseConnectorJdbcResult-method.html @@ -83,7 +83,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbHasCompleted-DatabaseConnectorDbiResult-method.html b/docs/reference/dbHasCompleted-DatabaseConnectorDbiResult-method.html index b6a4417b..713a8ddc 100644 --- a/docs/reference/dbHasCompleted-DatabaseConnectorDbiResult-method.html +++ b/docs/reference/dbHasCompleted-DatabaseConnectorDbiResult-method.html @@ -85,7 +85,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbHasCompleted-DatabaseConnectorJdbcResult-method.html b/docs/reference/dbHasCompleted-DatabaseConnectorJdbcResult-method.html index 122ff9b3..7dbd5e9b 100644 --- a/docs/reference/dbHasCompleted-DatabaseConnectorJdbcResult-method.html +++ b/docs/reference/dbHasCompleted-DatabaseConnectorJdbcResult-method.html @@ -85,7 +85,7 @@

    Arguments

    res
    -

    An object inheriting from DBIResult.

    +

    An object inheriting from DBIResult.

    ...
    diff --git a/docs/reference/dbIsValid-DatabaseConnectorDbiConnection-method.html b/docs/reference/dbIsValid-DatabaseConnectorDbiConnection-method.html index a336ac75..7077423b 100644 --- a/docs/reference/dbIsValid-DatabaseConnectorDbiConnection-method.html +++ b/docs/reference/dbIsValid-DatabaseConnectorDbiConnection-method.html @@ -83,9 +83,9 @@

    Arguments

    dbObj
    -

    An object inheriting from DBIObject, -i.e. DBIDriver, DBIConnection, -or a DBIResult

    +

    An object inheriting from DBIObject, +i.e. DBIDriver, DBIConnection, +or a DBIResult

    ...
    @@ -97,14 +97,14 @@

    Value

    dbIsValid() returns a logical scalar, TRUE if the object specified by dbObj is valid, FALSE otherwise. -A DBIConnection object is initially valid, +A DBIConnection object is initially valid, and becomes invalid after disconnecting with dbDisconnect(). For an invalid connection object (e.g., for some drivers if the object is saved to a file and then restored), the method also returns FALSE. -A DBIResult object is valid after a call to dbSendQuery(), +A DBIResult object is valid after a call to dbSendQuery(), and stays valid even after all rows have been fetched; only clearing it with dbClearResult() invalidates it. -A DBIResult object is also valid after a call to dbSendStatement(), +A DBIResult object is also valid after a call to dbSendStatement(), and stays valid after querying the number of rows affected; only clearing it with dbClearResult() invalidates it. If the connection to the database system is dropped (e.g., due to diff --git a/docs/reference/dbIsValid-DatabaseConnectorJdbcConnection-method.html b/docs/reference/dbIsValid-DatabaseConnectorJdbcConnection-method.html index 09d116c2..0c14226d 100644 --- a/docs/reference/dbIsValid-DatabaseConnectorJdbcConnection-method.html +++ b/docs/reference/dbIsValid-DatabaseConnectorJdbcConnection-method.html @@ -83,9 +83,9 @@

    Arguments

    dbObj
    -

    An object inheriting from DBIObject, -i.e. DBIDriver, DBIConnection, -or a DBIResult

    +

    An object inheriting from DBIObject, +i.e. DBIDriver, DBIConnection, +or a DBIResult

    ...
    @@ -97,14 +97,14 @@

    Value

    dbIsValid() returns a logical scalar, TRUE if the object specified by dbObj is valid, FALSE otherwise. -A DBIConnection object is initially valid, +A DBIConnection object is initially valid, and becomes invalid after disconnecting with dbDisconnect(). For an invalid connection object (e.g., for some drivers if the object is saved to a file and then restored), the method also returns FALSE. -A DBIResult object is valid after a call to dbSendQuery(), +A DBIResult object is valid after a call to dbSendQuery(), and stays valid even after all rows have been fetched; only clearing it with dbClearResult() invalidates it. -A DBIResult object is also valid after a call to dbSendStatement(), +A DBIResult object is also valid after a call to dbSendStatement(), and stays valid after querying the number of rows affected; only clearing it with dbClearResult() invalidates it. If the connection to the database system is dropped (e.g., due to diff --git a/docs/reference/dbListFields-DatabaseConnectorConnection-character-method.html b/docs/reference/dbListFields-DatabaseConnectorConnection-character-method.html index 94130baf..2f694cc5 100644 --- a/docs/reference/dbListFields-DatabaseConnectorConnection-character-method.html +++ b/docs/reference/dbListFields-DatabaseConnectorConnection-character-method.html @@ -81,7 +81,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    diff --git a/docs/reference/dbListTables-DatabaseConnectorConnection-method.html b/docs/reference/dbListTables-DatabaseConnectorConnection-method.html index fe9dddad..b0f9ea5f 100644 --- a/docs/reference/dbListTables-DatabaseConnectorConnection-method.html +++ b/docs/reference/dbListTables-DatabaseConnectorConnection-method.html @@ -87,7 +87,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    diff --git a/docs/reference/dbReadTable-DatabaseConnectorConnection-character-method.html b/docs/reference/dbReadTable-DatabaseConnectorConnection-character-method.html index 2a8045d9..b6a9877d 100644 --- a/docs/reference/dbReadTable-DatabaseConnectorConnection-character-method.html +++ b/docs/reference/dbReadTable-DatabaseConnectorConnection-character-method.html @@ -94,7 +94,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    diff --git a/docs/reference/dbRemoveTable-DatabaseConnectorConnection-ANY-method.html b/docs/reference/dbRemoveTable-DatabaseConnectorConnection-ANY-method.html index 5fe0a001..c9a19eb4 100644 --- a/docs/reference/dbRemoveTable-DatabaseConnectorConnection-ANY-method.html +++ b/docs/reference/dbRemoveTable-DatabaseConnectorConnection-ANY-method.html @@ -90,7 +90,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    diff --git a/docs/reference/dbSendQuery-DatabaseConnectorDbiConnection-character-method.html b/docs/reference/dbSendQuery-DatabaseConnectorDbiConnection-character-method.html index bfede6bd..91feba99 100644 --- a/docs/reference/dbSendQuery-DatabaseConnectorDbiConnection-character-method.html +++ b/docs/reference/dbSendQuery-DatabaseConnectorDbiConnection-character-method.html @@ -95,7 +95,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    @@ -114,7 +114,7 @@

    Arguments

    Value

    dbSendQuery() returns -an S4 object that inherits from DBIResult. +an S4 object that inherits from DBIResult. The result set can be used with dbFetch() to extract records. Once you have finished using a result, make sure to clear it with dbClearResult().

    diff --git a/docs/reference/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.html b/docs/reference/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.html index 6571122a..617dfaba 100644 --- a/docs/reference/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.html +++ b/docs/reference/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.html @@ -95,7 +95,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    @@ -114,7 +114,7 @@

    Arguments

    Value

    dbSendQuery() returns -an S4 object that inherits from DBIResult. +an S4 object that inherits from DBIResult. The result set can be used with dbFetch() to extract records. Once you have finished using a result, make sure to clear it with dbClearResult().

    diff --git a/docs/reference/dbSendStatement-DatabaseConnectorConnection-character-method.html b/docs/reference/dbSendStatement-DatabaseConnectorConnection-character-method.html index 544225e5..3e48966a 100644 --- a/docs/reference/dbSendStatement-DatabaseConnectorConnection-character-method.html +++ b/docs/reference/dbSendStatement-DatabaseConnectorConnection-character-method.html @@ -93,7 +93,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    @@ -112,7 +112,7 @@

    Arguments

    Value

    dbSendStatement() returns -an S4 object that inherits from DBIResult. +an S4 object that inherits from DBIResult. The result set can be used with dbGetRowsAffected() to determine the number of rows affected by the query. Once you have finished using a result, make sure to clear it diff --git a/docs/reference/dbWriteTable-DatabaseConnectorConnection-ANY-method.html b/docs/reference/dbWriteTable-DatabaseConnectorConnection-ANY-method.html index ad8fc1a1..baf85be8 100644 --- a/docs/reference/dbWriteTable-DatabaseConnectorConnection-ANY-method.html +++ b/docs/reference/dbWriteTable-DatabaseConnectorConnection-ANY-method.html @@ -94,7 +94,7 @@

    Arguments

    conn
    -

    A DBIConnection object, as returned by +

    A DBIConnection object, as returned by dbConnect().

    diff --git a/docs/reference/extractQueryTimes.html b/docs/reference/extractQueryTimes.html index f8e6ae31..abb41dc0 100644 --- a/docs/reference/extractQueryTimes.html +++ b/docs/reference/extractQueryTimes.html @@ -105,15 +105,15 @@

    Examples

    executeSql(connection, "CREATE TABLE test (x INT);") #> | | | 0% | |======================================================================| 100% -#> Executing SQL took 0.00396 secs +#> Executing SQL took 0.00391 secs querySql(connection, "SELECT * FROM test;") #> [1] X #> <0 rows> (or 0-length row.names) extractQueryTimes(logFile) #> query startTime milliseconds thread -#> 1 CREATE TABLE test (x INT) 2025-01-09 08:21:45 0 Main thread -#> 2 SELECT * FROM test 2025-01-09 08:21:45 0 Main thread +#> 1 CREATE TABLE test (x INT) 2025-01-15 06:59:37 0 Main thread +#> 2 SELECT * FROM test 2025-01-15 06:59:37 0 Main thread ParallelLogger::unregisterLogger("MY_LOGGER") #> [1] TRUE diff --git a/docs/reference/jdbcDrivers.html b/docs/reference/jdbcDrivers.html index e11bc91a..47b75e09 100644 --- a/docs/reference/jdbcDrivers.html +++ b/docs/reference/jdbcDrivers.html @@ -85,7 +85,7 @@

    SQL Server, Oracle, PostgreSQL, PDW, Snowflake, Spark, RedShift, Azure Synap

    Netezza

    Read the instructions -here +here on how to obtain the Netezza JDBC driver.

    diff --git a/extras/DatabaseConnector.pdf b/extras/DatabaseConnector.pdf index cac78dae..1867050a 100644 Binary files a/extras/DatabaseConnector.pdf and b/extras/DatabaseConnector.pdf differ diff --git a/extras/PackageMaintenance.R b/extras/PackageMaintenance.R index 05bf96d2..7e915cf1 100644 --- a/extras/PackageMaintenance.R +++ b/extras/PackageMaintenance.R @@ -29,8 +29,19 @@ OhdsiRTools::checkUsagePackage("DatabaseConnector") OhdsiRTools::updateCopyrightYearFolder() devtools::spell_check() - # Create manual ---------------------------------------------------------------- +# Remove Sexpr that breaks pkgdown +# Fix links broken by roxygen (when inheriting from DBI) +fixRdFile <- function(fileName) { + page <- SqlRender::readSql(fileName) + page <- gsub("\\\\Sexpr[^\n]*\n", "", page) + page <- gsub("\\linkS4class\\{(DBI[a-zA-Z]*)\\}", "\\link[DBI:\\1-class]{\\1}", page) + SqlRender::writeSql(page, fileName) +} +for (file in list.files("man", ".*.Rd")) { + fixRdFile(file.path("man", file)) +} + unlink("extras/DatabaseConnector.pdf") system("R CMD Rd2pdf ./ --output=extras/DatabaseConnector.pdf") @@ -53,16 +64,6 @@ rmarkdown::render("vignettes/DbiAndDbplyr.Rmd", toc = TRUE, number_sections = TRUE)) -# May need to delete Sexpr expressions from description sections to avoid purr error: -fixRdFile <- function(fileName) { - page <- SqlRender::readSql(fileName) - page <- gsub("\\\\Sexpr[^\n]*\n", "", page) - page <- gsub("\\linkS4class\\{DBI([^:])", "\\linkS4class{DBI:DBI\\1", page) - SqlRender::writeSql(page, fileName) -} -for (file in list.files("man", ".*.Rd")) { - fixRdFile(file.path("man", file)) -} pkgdown::build_site() OhdsiRTools::fixHadesLogo() diff --git a/inst/doc/Connecting.pdf b/inst/doc/Connecting.pdf index 0d98c01e..e69022bf 100644 Binary files a/inst/doc/Connecting.pdf and b/inst/doc/Connecting.pdf differ diff --git a/inst/doc/DbiAndDbplyr.pdf b/inst/doc/DbiAndDbplyr.pdf index 0f52e5fe..60670d2f 100644 Binary files a/inst/doc/DbiAndDbplyr.pdf and b/inst/doc/DbiAndDbplyr.pdf differ diff --git a/inst/doc/Querying.pdf b/inst/doc/Querying.pdf index f1aa7b7d..16ce5d93 100644 Binary files a/inst/doc/Querying.pdf and b/inst/doc/Querying.pdf differ diff --git a/man/dbAppendTable-DatabaseConnectorConnection-character-method.Rd b/man/dbAppendTable-DatabaseConnectorConnection-character-method.Rd index 6a0dd028..45646899 100644 --- a/man/dbAppendTable-DatabaseConnectorConnection-character-method.Rd +++ b/man/dbAppendTable-DatabaseConnectorConnection-character-method.Rd @@ -17,7 +17,7 @@ ) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: diff --git a/man/dbClearResult-DatabaseConnectorDbiResult-method.Rd b/man/dbClearResult-DatabaseConnectorDbiResult-method.Rd index 1b5954d9..46ecb85e 100644 --- a/man/dbClearResult-DatabaseConnectorDbiResult-method.Rd +++ b/man/dbClearResult-DatabaseConnectorDbiResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbClearResult}{DatabaseConnectorDbiResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbClearResult-DatabaseConnectorJdbcResult-method.Rd b/man/dbClearResult-DatabaseConnectorJdbcResult-method.Rd index f575ce16..c84ba858 100644 --- a/man/dbClearResult-DatabaseConnectorJdbcResult-method.Rd +++ b/man/dbClearResult-DatabaseConnectorJdbcResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbClearResult}{DatabaseConnectorJdbcResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbColumnInfo-DatabaseConnectorDbiResult-method.Rd b/man/dbColumnInfo-DatabaseConnectorDbiResult-method.Rd index 91b9f848..424e9aba 100644 --- a/man/dbColumnInfo-DatabaseConnectorDbiResult-method.Rd +++ b/man/dbColumnInfo-DatabaseConnectorDbiResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbColumnInfo}{DatabaseConnectorDbiResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbColumnInfo-DatabaseConnectorJdbcResult-method.Rd b/man/dbColumnInfo-DatabaseConnectorJdbcResult-method.Rd index 3c6cd2b0..38129110 100644 --- a/man/dbColumnInfo-DatabaseConnectorJdbcResult-method.Rd +++ b/man/dbColumnInfo-DatabaseConnectorJdbcResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbColumnInfo}{DatabaseConnectorJdbcResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbCreateTable-DatabaseConnectorConnection-method.Rd b/man/dbCreateTable-DatabaseConnectorConnection-method.Rd index 928266f8..55b79c58 100644 --- a/man/dbCreateTable-DatabaseConnectorConnection-method.Rd +++ b/man/dbCreateTable-DatabaseConnectorConnection-method.Rd @@ -17,7 +17,7 @@ ) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: diff --git a/man/dbDisconnect-DatabaseConnectorConnection-method.Rd b/man/dbDisconnect-DatabaseConnectorConnection-method.Rd index a6879248..e66ae8ed 100644 --- a/man/dbDisconnect-DatabaseConnectorConnection-method.Rd +++ b/man/dbDisconnect-DatabaseConnectorConnection-method.Rd @@ -7,7 +7,7 @@ \S4method{dbDisconnect}{DatabaseConnectorConnection}(conn) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} } \value{ diff --git a/man/dbExecute-DatabaseConnectorConnection-character-method.Rd b/man/dbExecute-DatabaseConnectorConnection-character-method.Rd index 6686577c..fd8c0dc6 100644 --- a/man/dbExecute-DatabaseConnectorConnection-character-method.Rd +++ b/man/dbExecute-DatabaseConnectorConnection-character-method.Rd @@ -7,7 +7,7 @@ \S4method{dbExecute}{DatabaseConnectorConnection,character}(conn, statement, translate = TRUE, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{statement}{a character string containing SQL.} diff --git a/man/dbExistsTable-DatabaseConnectorConnection-character-method.Rd b/man/dbExistsTable-DatabaseConnectorConnection-character-method.Rd index 3077f28c..663b81df 100644 --- a/man/dbExistsTable-DatabaseConnectorConnection-character-method.Rd +++ b/man/dbExistsTable-DatabaseConnectorConnection-character-method.Rd @@ -7,7 +7,7 @@ \S4method{dbExistsTable}{DatabaseConnectorConnection,character}(conn, name, databaseSchema = NULL, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: diff --git a/man/dbFetch-DatabaseConnectorDbiResult-method.Rd b/man/dbFetch-DatabaseConnectorDbiResult-method.Rd index 84f0c3f1..d0228c14 100644 --- a/man/dbFetch-DatabaseConnectorDbiResult-method.Rd +++ b/man/dbFetch-DatabaseConnectorDbiResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbFetch}{DatabaseConnectorDbiResult}(res, n = -1, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}, created by +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}, created by \code{\link[DBI:dbSendQuery]{dbSendQuery()}}.} \item{n}{maximum number of records to retrieve per fetch. Use \code{n = -1} diff --git a/man/dbFetch-DatabaseConnectorJdbcResult-method.Rd b/man/dbFetch-DatabaseConnectorJdbcResult-method.Rd index 65993712..1863a0c5 100644 --- a/man/dbFetch-DatabaseConnectorJdbcResult-method.Rd +++ b/man/dbFetch-DatabaseConnectorJdbcResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbFetch}{DatabaseConnectorJdbcResult}(res, n = -1, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}, created by +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}, created by \code{\link[DBI:dbSendQuery]{dbSendQuery()}}.} \item{n}{maximum number of records to retrieve per fetch. Use \code{n = -1} diff --git a/man/dbGetInfo-DatabaseConnectorConnection-method.Rd b/man/dbGetInfo-DatabaseConnectorConnection-method.Rd index 8d7f3d9a..98f0aa60 100644 --- a/man/dbGetInfo-DatabaseConnectorConnection-method.Rd +++ b/man/dbGetInfo-DatabaseConnectorConnection-method.Rd @@ -7,14 +7,14 @@ \S4method{dbGetInfo}{DatabaseConnectorConnection}(dbObj, ...) } \arguments{ -\item{dbObj}{An object inheriting from \linkS4class{DBI:DBIObject}, -i.e. \linkS4class{DBI:DBIDriver}, \linkS4class{DBI:DBIConnection}, -or a \linkS4class{DBI:DBIResult}} +\item{dbObj}{An object inheriting from \link[DBI:DBIObject-class]{DBIObject}, +i.e. \link[DBI:DBIDriver-class]{DBIDriver}, \link[DBI:DBIConnection-class]{DBIConnection}, +or a \link[DBI:DBIResult-class]{DBIResult}} \item{...}{Other arguments to methods.} } \value{ -For objects of class \linkS4class{DBI:DBIDriver}, \code{dbGetInfo()} +For objects of class \link[DBI:DBIDriver-class]{DBIDriver}, \code{dbGetInfo()} returns a named list that contains at least the following components: \itemize{ @@ -22,7 +22,7 @@ that contains at least the following components: \item \code{client.version}: the version of the DBMS client library. } -For objects of class \linkS4class{DBI:DBIConnection}, \code{dbGetInfo()} +For objects of class \link[DBI:DBIConnection-class]{DBIConnection}, \code{dbGetInfo()} returns a named list that contains at least the following components: \itemize{ @@ -35,7 +35,7 @@ It must not contain a \code{password} component. Components that are not applicable should be set to \code{NA}. } -For objects of class \linkS4class{DBI:DBIResult}, \code{dbGetInfo()} +For objects of class \link[DBI:DBIResult-class]{DBIResult}, \code{dbGetInfo()} returns a named list that contains at least the following components: \itemize{ @@ -51,8 +51,8 @@ as returned by \code{\link[DBI:dbHasCompleted]{dbHasCompleted()}}. } } \description{ -Retrieves information on objects of class \linkS4class{DBI:DBIDriver}, -\linkS4class{DBI:DBIConnection} or \linkS4class{DBI:DBIResult}. +Retrieves information on objects of class \link[DBI:DBIDriver-class]{DBIDriver}, +\link[DBI:DBIConnection-class]{DBIConnection} or \link[DBI:DBIResult-class]{DBIResult}. } \seealso{ diff --git a/man/dbGetInfo-DatabaseConnectorDriver-method.Rd b/man/dbGetInfo-DatabaseConnectorDriver-method.Rd index 946154c2..31c30896 100644 --- a/man/dbGetInfo-DatabaseConnectorDriver-method.Rd +++ b/man/dbGetInfo-DatabaseConnectorDriver-method.Rd @@ -7,14 +7,14 @@ \S4method{dbGetInfo}{DatabaseConnectorDriver}(dbObj, ...) } \arguments{ -\item{dbObj}{An object inheriting from \linkS4class{DBI:DBIObject}, -i.e. \linkS4class{DBI:DBIDriver}, \linkS4class{DBI:DBIConnection}, -or a \linkS4class{DBI:DBIResult}} +\item{dbObj}{An object inheriting from \link[DBI:DBIObject-class]{DBIObject}, +i.e. \link[DBI:DBIDriver-class]{DBIDriver}, \link[DBI:DBIConnection-class]{DBIConnection}, +or a \link[DBI:DBIResult-class]{DBIResult}} \item{...}{Other arguments to methods.} } \value{ -For objects of class \linkS4class{DBI:DBIDriver}, \code{dbGetInfo()} +For objects of class \link[DBI:DBIDriver-class]{DBIDriver}, \code{dbGetInfo()} returns a named list that contains at least the following components: \itemize{ @@ -22,7 +22,7 @@ that contains at least the following components: \item \code{client.version}: the version of the DBMS client library. } -For objects of class \linkS4class{DBI:DBIConnection}, \code{dbGetInfo()} +For objects of class \link[DBI:DBIConnection-class]{DBIConnection}, \code{dbGetInfo()} returns a named list that contains at least the following components: \itemize{ @@ -35,7 +35,7 @@ It must not contain a \code{password} component. Components that are not applicable should be set to \code{NA}. } -For objects of class \linkS4class{DBI:DBIResult}, \code{dbGetInfo()} +For objects of class \link[DBI:DBIResult-class]{DBIResult}, \code{dbGetInfo()} returns a named list that contains at least the following components: \itemize{ @@ -51,8 +51,8 @@ as returned by \code{\link[DBI:dbHasCompleted]{dbHasCompleted()}}. } } \description{ -Retrieves information on objects of class \linkS4class{DBI:DBIDriver}, -\linkS4class{DBI:DBIConnection} or \linkS4class{DBI:DBIResult}. +Retrieves information on objects of class \link[DBI:DBIDriver-class]{DBIDriver}, +\link[DBI:DBIConnection-class]{DBIConnection} or \link[DBI:DBIResult-class]{DBIResult}. } \seealso{ diff --git a/man/dbGetQuery-DatabaseConnectorConnection-character-method.Rd b/man/dbGetQuery-DatabaseConnectorConnection-character-method.Rd index dff5ce88..9e7936fd 100644 --- a/man/dbGetQuery-DatabaseConnectorConnection-character-method.Rd +++ b/man/dbGetQuery-DatabaseConnectorConnection-character-method.Rd @@ -7,7 +7,7 @@ \S4method{dbGetQuery}{DatabaseConnectorConnection,character}(conn, statement, translate = TRUE, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{statement}{a character string containing SQL.} diff --git a/man/dbGetRowCount-DatabaseConnectorDbiResult-method.Rd b/man/dbGetRowCount-DatabaseConnectorDbiResult-method.Rd index 3b5b7edb..325f67e7 100644 --- a/man/dbGetRowCount-DatabaseConnectorDbiResult-method.Rd +++ b/man/dbGetRowCount-DatabaseConnectorDbiResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbGetRowCount}{DatabaseConnectorDbiResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbGetRowCount-DatabaseConnectorJdbcResult-method.Rd b/man/dbGetRowCount-DatabaseConnectorJdbcResult-method.Rd index 50e05474..ece3f12e 100644 --- a/man/dbGetRowCount-DatabaseConnectorJdbcResult-method.Rd +++ b/man/dbGetRowCount-DatabaseConnectorJdbcResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbGetRowCount}{DatabaseConnectorJdbcResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbGetRowsAffected-DatabaseConnectorDbiResult-method.Rd b/man/dbGetRowsAffected-DatabaseConnectorDbiResult-method.Rd index 5a1c7027..0677cd1e 100644 --- a/man/dbGetRowsAffected-DatabaseConnectorDbiResult-method.Rd +++ b/man/dbGetRowsAffected-DatabaseConnectorDbiResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbGetRowsAffected}{DatabaseConnectorDbiResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.Rd b/man/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.Rd index 662f116b..bf978d4e 100644 --- a/man/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.Rd +++ b/man/dbGetRowsAffected-DatabaseConnectorJdbcResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbGetRowsAffected}{DatabaseConnectorJdbcResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbGetStatement-DatabaseConnectorDbiResult-method.Rd b/man/dbGetStatement-DatabaseConnectorDbiResult-method.Rd index 0dc073ed..2d91c763 100644 --- a/man/dbGetStatement-DatabaseConnectorDbiResult-method.Rd +++ b/man/dbGetStatement-DatabaseConnectorDbiResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbGetStatement}{DatabaseConnectorDbiResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbGetStatement-DatabaseConnectorJdbcResult-method.Rd b/man/dbGetStatement-DatabaseConnectorJdbcResult-method.Rd index f133c19b..a464f11e 100644 --- a/man/dbGetStatement-DatabaseConnectorJdbcResult-method.Rd +++ b/man/dbGetStatement-DatabaseConnectorJdbcResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbGetStatement}{DatabaseConnectorJdbcResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbHasCompleted-DatabaseConnectorDbiResult-method.Rd b/man/dbHasCompleted-DatabaseConnectorDbiResult-method.Rd index e6658fcd..5f1fb095 100644 --- a/man/dbHasCompleted-DatabaseConnectorDbiResult-method.Rd +++ b/man/dbHasCompleted-DatabaseConnectorDbiResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbHasCompleted}{DatabaseConnectorDbiResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbHasCompleted-DatabaseConnectorJdbcResult-method.Rd b/man/dbHasCompleted-DatabaseConnectorJdbcResult-method.Rd index 618bf16a..d5de8d59 100644 --- a/man/dbHasCompleted-DatabaseConnectorJdbcResult-method.Rd +++ b/man/dbHasCompleted-DatabaseConnectorJdbcResult-method.Rd @@ -7,7 +7,7 @@ \S4method{dbHasCompleted}{DatabaseConnectorJdbcResult}(res, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBI:DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBIResult}.} \item{...}{Other arguments passed on to methods.} } diff --git a/man/dbIsValid-DatabaseConnectorDbiConnection-method.Rd b/man/dbIsValid-DatabaseConnectorDbiConnection-method.Rd index ea512b56..a4bce0af 100644 --- a/man/dbIsValid-DatabaseConnectorDbiConnection-method.Rd +++ b/man/dbIsValid-DatabaseConnectorDbiConnection-method.Rd @@ -7,9 +7,9 @@ \S4method{dbIsValid}{DatabaseConnectorDbiConnection}(dbObj, ...) } \arguments{ -\item{dbObj}{An object inheriting from \linkS4class{DBI:DBIObject}, -i.e. \linkS4class{DBI:DBIDriver}, \linkS4class{DBI:DBIConnection}, -or a \linkS4class{DBI:DBIResult}} +\item{dbObj}{An object inheriting from \link[DBI:DBIObject-class]{DBIObject}, +i.e. \link[DBI:DBIDriver-class]{DBIDriver}, \link[DBI:DBIConnection-class]{DBIConnection}, +or a \link[DBI:DBIResult-class]{DBIResult}} \item{...}{Other arguments to methods.} } @@ -17,14 +17,14 @@ or a \linkS4class{DBI:DBIResult}} \code{dbIsValid()} returns a logical scalar, \code{TRUE} if the object specified by \code{dbObj} is valid, \code{FALSE} otherwise. -A \linkS4class{DBI:DBIConnection} object is initially valid, +A \link[DBI:DBIConnection-class]{DBIConnection} object is initially valid, and becomes invalid after disconnecting with \code{\link[DBI:dbDisconnect]{dbDisconnect()}}. For an invalid connection object (e.g., for some drivers if the object is saved to a file and then restored), the method also returns \code{FALSE}. -A \linkS4class{DBI:DBIResult} object is valid after a call to \code{\link[DBI:dbSendQuery]{dbSendQuery()}}, +A \link[DBI:DBIResult-class]{DBIResult} object is valid after a call to \code{\link[DBI:dbSendQuery]{dbSendQuery()}}, and stays valid even after all rows have been fetched; only clearing it with \code{\link[DBI:dbClearResult]{dbClearResult()}} invalidates it. -A \linkS4class{DBI:DBIResult} object is also valid after a call to \code{\link[DBI:dbSendStatement]{dbSendStatement()}}, +A \link[DBI:DBIResult-class]{DBIResult} object is also valid after a call to \code{\link[DBI:dbSendStatement]{dbSendStatement()}}, and stays valid after querying the number of rows affected; only clearing it with \code{\link[DBI:dbClearResult]{dbClearResult()}} invalidates it. If the connection to the database system is dropped (e.g., due to diff --git a/man/dbIsValid-DatabaseConnectorJdbcConnection-method.Rd b/man/dbIsValid-DatabaseConnectorJdbcConnection-method.Rd index 091703c4..46170627 100644 --- a/man/dbIsValid-DatabaseConnectorJdbcConnection-method.Rd +++ b/man/dbIsValid-DatabaseConnectorJdbcConnection-method.Rd @@ -7,9 +7,9 @@ \S4method{dbIsValid}{DatabaseConnectorJdbcConnection}(dbObj, ...) } \arguments{ -\item{dbObj}{An object inheriting from \linkS4class{DBI:DBIObject}, -i.e. \linkS4class{DBI:DBIDriver}, \linkS4class{DBI:DBIConnection}, -or a \linkS4class{DBI:DBIResult}} +\item{dbObj}{An object inheriting from \link[DBI:DBIObject-class]{DBIObject}, +i.e. \link[DBI:DBIDriver-class]{DBIDriver}, \link[DBI:DBIConnection-class]{DBIConnection}, +or a \link[DBI:DBIResult-class]{DBIResult}} \item{...}{Other arguments to methods.} } @@ -17,14 +17,14 @@ or a \linkS4class{DBI:DBIResult}} \code{dbIsValid()} returns a logical scalar, \code{TRUE} if the object specified by \code{dbObj} is valid, \code{FALSE} otherwise. -A \linkS4class{DBI:DBIConnection} object is initially valid, +A \link[DBI:DBIConnection-class]{DBIConnection} object is initially valid, and becomes invalid after disconnecting with \code{\link[DBI:dbDisconnect]{dbDisconnect()}}. For an invalid connection object (e.g., for some drivers if the object is saved to a file and then restored), the method also returns \code{FALSE}. -A \linkS4class{DBI:DBIResult} object is valid after a call to \code{\link[DBI:dbSendQuery]{dbSendQuery()}}, +A \link[DBI:DBIResult-class]{DBIResult} object is valid after a call to \code{\link[DBI:dbSendQuery]{dbSendQuery()}}, and stays valid even after all rows have been fetched; only clearing it with \code{\link[DBI:dbClearResult]{dbClearResult()}} invalidates it. -A \linkS4class{DBI:DBIResult} object is also valid after a call to \code{\link[DBI:dbSendStatement]{dbSendStatement()}}, +A \link[DBI:DBIResult-class]{DBIResult} object is also valid after a call to \code{\link[DBI:dbSendStatement]{dbSendStatement()}}, and stays valid after querying the number of rows affected; only clearing it with \code{\link[DBI:dbClearResult]{dbClearResult()}} invalidates it. If the connection to the database system is dropped (e.g., due to diff --git a/man/dbListFields-DatabaseConnectorConnection-character-method.Rd b/man/dbListFields-DatabaseConnectorConnection-character-method.Rd index d0dd9a95..9aa1cc58 100644 --- a/man/dbListFields-DatabaseConnectorConnection-character-method.Rd +++ b/man/dbListFields-DatabaseConnectorConnection-character-method.Rd @@ -7,7 +7,7 @@ \S4method{dbListFields}{DatabaseConnectorConnection,character}(conn, name, databaseSchema = NULL, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: diff --git a/man/dbListTables-DatabaseConnectorConnection-method.Rd b/man/dbListTables-DatabaseConnectorConnection-method.Rd index cdca339c..5aae0f73 100644 --- a/man/dbListTables-DatabaseConnectorConnection-method.Rd +++ b/man/dbListTables-DatabaseConnectorConnection-method.Rd @@ -7,7 +7,7 @@ \S4method{dbListTables}{DatabaseConnectorConnection}(conn, databaseSchema = NULL, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{databaseSchema}{The name of the database schema. See details for platform-specific details.} diff --git a/man/dbReadTable-DatabaseConnectorConnection-character-method.Rd b/man/dbReadTable-DatabaseConnectorConnection-character-method.Rd index 9cc9f84c..2c69a1c2 100644 --- a/man/dbReadTable-DatabaseConnectorConnection-character-method.Rd +++ b/man/dbReadTable-DatabaseConnectorConnection-character-method.Rd @@ -14,7 +14,7 @@ ) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: diff --git a/man/dbRemoveTable-DatabaseConnectorConnection-ANY-method.Rd b/man/dbRemoveTable-DatabaseConnectorConnection-ANY-method.Rd index 2cc167af..f88ce34b 100644 --- a/man/dbRemoveTable-DatabaseConnectorConnection-ANY-method.Rd +++ b/man/dbRemoveTable-DatabaseConnectorConnection-ANY-method.Rd @@ -14,7 +14,7 @@ ) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: diff --git a/man/dbSendQuery-DatabaseConnectorDbiConnection-character-method.Rd b/man/dbSendQuery-DatabaseConnectorDbiConnection-character-method.Rd index 947ad190..fdf5766d 100644 --- a/man/dbSendQuery-DatabaseConnectorDbiConnection-character-method.Rd +++ b/man/dbSendQuery-DatabaseConnectorDbiConnection-character-method.Rd @@ -7,7 +7,7 @@ \S4method{dbSendQuery}{DatabaseConnectorDbiConnection,character}(conn, statement, translate = TRUE, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{statement}{a character string containing SQL.} @@ -18,7 +18,7 @@ } \value{ \code{dbSendQuery()} returns -an S4 object that inherits from \linkS4class{DBI:DBIResult}. +an S4 object that inherits from \link[DBI:DBIResult-class]{DBIResult}. The result set can be used with \code{\link[DBI:dbFetch]{dbFetch()}} to extract records. Once you have finished using a result, make sure to clear it with \code{\link[DBI:dbClearResult]{dbClearResult()}}. diff --git a/man/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.Rd b/man/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.Rd index d5b27237..95d07312 100644 --- a/man/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.Rd +++ b/man/dbSendQuery-DatabaseConnectorJdbcConnection-character-method.Rd @@ -7,7 +7,7 @@ \S4method{dbSendQuery}{DatabaseConnectorJdbcConnection,character}(conn, statement, translate = TRUE, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{statement}{a character string containing SQL.} @@ -18,7 +18,7 @@ } \value{ \code{dbSendQuery()} returns -an S4 object that inherits from \linkS4class{DBI:DBIResult}. +an S4 object that inherits from \link[DBI:DBIResult-class]{DBIResult}. The result set can be used with \code{\link[DBI:dbFetch]{dbFetch()}} to extract records. Once you have finished using a result, make sure to clear it with \code{\link[DBI:dbClearResult]{dbClearResult()}}. diff --git a/man/dbSendStatement-DatabaseConnectorConnection-character-method.Rd b/man/dbSendStatement-DatabaseConnectorConnection-character-method.Rd index 59155596..0f0200ea 100644 --- a/man/dbSendStatement-DatabaseConnectorConnection-character-method.Rd +++ b/man/dbSendStatement-DatabaseConnectorConnection-character-method.Rd @@ -7,7 +7,7 @@ \S4method{dbSendStatement}{DatabaseConnectorConnection,character}(conn, statement, translate = TRUE, ...) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{statement}{a character string containing SQL.} @@ -18,7 +18,7 @@ } \value{ \code{dbSendStatement()} returns -an S4 object that inherits from \linkS4class{DBI:DBIResult}. +an S4 object that inherits from \link[DBI:DBIResult-class]{DBIResult}. The result set can be used with \code{\link[DBI:dbGetRowsAffected]{dbGetRowsAffected()}} to determine the number of rows affected by the query. Once you have finished using a result, make sure to clear it diff --git a/man/dbWriteTable-DatabaseConnectorConnection-ANY-method.Rd b/man/dbWriteTable-DatabaseConnectorConnection-ANY-method.Rd index 1a1bb928..e9b01bc4 100644 --- a/man/dbWriteTable-DatabaseConnectorConnection-ANY-method.Rd +++ b/man/dbWriteTable-DatabaseConnectorConnection-ANY-method.Rd @@ -18,7 +18,7 @@ ) } \arguments{ -\item{conn}{A \linkS4class{DBI:DBIConnection} object, as returned by +\item{conn}{A \link[DBI:DBIConnection-class]{DBIConnection} object, as returned by \code{\link[DBI:dbConnect]{dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: diff --git a/man/jdbcDrivers.Rd b/man/jdbcDrivers.Rd index d56f7174..3af0dd6b 100644 --- a/man/jdbcDrivers.Rd +++ b/man/jdbcDrivers.Rd @@ -15,7 +15,7 @@ Use the \code{\link[=downloadJdbcDrivers]{downloadJdbcDrivers()}} function to do \section{Netezza}{ Read the instructions -\href{https://www.ibm.com/docs/en/SSULQD_7.2.1/com.ibm.nz.datacon.doc/t_datacon_setup_JDBC.html}{here} +\href{https://www.ibm.com/docs/en/netezza?topic=dls-installing-configuring-jdbc}{here} on how to obtain the Netezza JDBC driver. }