From d817b430bde5ebd93a057afc2d1825f212d2675a Mon Sep 17 00:00:00 2001 From: Nicolas Bennett Date: Wed, 3 Sep 2025 21:33:12 +0200 Subject: [PATCH 1/3] add pkg link targets --- DESCRIPTION | 2 +- NEWS.md | 4 ++++ R/AdbiConnection.R | 4 ++-- R/AdbiDriver.R | 4 ++-- R/AdbiResult.R | 2 +- R/AdbiResultArrow.R | 4 ++-- R/dbConnect_AdbiDriver.R | 6 +++--- R/dbFetch_AdbiResult.R | 17 +++++++++-------- R/dbQuoteIdentifier_AdbiConnection_character.R | 2 ++ R/dbRemoveTable_AdbiConnection_character.R | 2 +- R/dbSendQuery_AdbiConnection_character.R | 8 ++++---- cran-comments.md | 4 ++-- man/AdbiConnection-class.Rd | 9 +++++---- man/AdbiDriver-class.Rd | 4 ++-- man/AdbiResult-class.Rd | 2 +- man/AdbiResultArrow-class.Rd | 4 ++-- man/dbConnect.Rd | 6 +++--- man/dbFetch.Rd | 17 +++++++++-------- man/dbSendQuery.Rd | 8 ++++---- 19 files changed, 59 insertions(+), 50 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 1626998..f4fab8f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: adbi Title: 'DBI' Compliant Database Access Using 'ADBC' -Version: 0.1.1 +Version: 0.1.2 Authors@R: c(person(given = "Nicolas", family = "Bennett", diff --git a/NEWS.md b/NEWS.md index ef3f018..b5c9ecd 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# adbi 0.1.2 (2024-09-03) + +- Docs only update + # adbi 0.1.1 (2024-01-25) - Update for adbcdrivermanager 0.9.0.1 diff --git a/R/AdbiConnection.R b/R/AdbiConnection.R index d540649..d1295cc 100644 --- a/R/AdbiConnection.R +++ b/R/AdbiConnection.R @@ -24,8 +24,8 @@ AdbiConnection <- function(driver, ..., rows_affected_callback = identity, #' #' AdbiConnection objects are created by passing [adbi()] as first #' argument to [DBI::dbConnect()]. They are a superclass of the -#' [DBIConnection-class] class. The "Usage" section lists the class methods -#' overridden by \pkg{adbi}. +#' [DBI::DBIConnection-class] class. The "Usage" section lists the class +#' methods overridden by \pkg{adbi}. #' #' @seealso #' The corresponding generic functions diff --git a/R/AdbiDriver.R b/R/AdbiDriver.R index d67516b..7cb97c9 100644 --- a/R/AdbiDriver.R +++ b/R/AdbiDriver.R @@ -80,8 +80,8 @@ adbi <- function(driver = NA_character_) { #' Class AdbiDriver (and methods) #' #' AdbiDriver objects are created by [adbi()], and used to select the -#' correct method in [dbConnect()]. They are a superclass of the -#' [DBIDriver-class] class, and used purely for dispatch. +#' correct method in [DBI::dbConnect()]. They are a superclass of the +#' [DBI::DBIDriver-class] class, and used purely for dispatch. #' The "Usage" section lists the class methods overridden by \pkg{adbi}. #' #' @keywords internal diff --git a/R/AdbiResult.R b/R/AdbiResult.R index f5bc8ac..8e47012 100644 --- a/R/AdbiResult.R +++ b/R/AdbiResult.R @@ -106,7 +106,7 @@ new_result <- function(statement, immediate, prepared, type, sql, #' #' AdbiResult objects are created by [DBI::dbSendQuery()] or #' [DBI::dbSendStatement()], and encapsulate the result of an SQL statement -#' (either `SELECT` or not). They are a superclass of the [DBIResult-class] +#' (either `SELECT` or not). They are a superclass of the [DBI::DBIResult-class] #' class. The "Usage" section lists the class methods overridden by #' \pkg{adbi}. #' diff --git a/R/AdbiResultArrow.R b/R/AdbiResultArrow.R index 6d742f4..8ca0031 100644 --- a/R/AdbiResultArrow.R +++ b/R/AdbiResultArrow.R @@ -20,8 +20,8 @@ AdbiResultArrow <- function(connection, statement, immediate = NULL, #' #' AdbiResultArrow objects are created by [DBI::dbSendQueryArrow()], and #' encapsulate the result of an SQL query (a `SELECT` statement). They are a -#' superclass of the [DBIResultArrow-class] class. The "Usage" section lists -#' the class methods overridden by \pkg{adbi}. +#' superclass of the [DBI::DBIResultArrow-class] class. The "Usage" section +#' lists the class methods overridden by \pkg{adbi}. #' #' @seealso #' The corresponding generic functions diff --git a/R/dbConnect_AdbiDriver.R b/R/dbConnect_AdbiDriver.R index 2632700..f84f070 100644 --- a/R/dbConnect_AdbiDriver.R +++ b/R/dbConnect_AdbiDriver.R @@ -1,5 +1,5 @@ #' @rdname dbConnect -#' @param ... Extra arguments passed to [dbConnect()] are forwarded to +#' @param ... Extra arguments passed to [DBI::dbConnect()] are forwarded to #' [adbcdrivermanager::adbc_database_init()] #' @param bigint The R type that 64-bit integer types should be mapped to, #' default is [bit64::integer64], if bit64 is installed and `character` @@ -12,8 +12,8 @@ #' dbDisconnect(con) #' dbIsValid(con) #' @return A connection object (S4 class `AdbiCOnnection`, inheriting from -#' [DBIConnection-class]) is returned by [dbConnect()], while -#' [dbDisconnect()] returns `TRUE` invisibly. +#' [DBI::DBIConnection-class]) is returned by [DBI::dbConnect()], while +#' [DBI::dbDisconnect()] returns `TRUE` invisibly. #' @usage NULL dbConnect_AdbiDriver <- function(drv, ..., bigint = NULL) { AdbiConnection(drv, ..., bigint = bigint) diff --git a/R/dbFetch_AdbiResult.R b/R/dbFetch_AdbiResult.R index 337c56e..3ba60ff 100644 --- a/R/dbFetch_AdbiResult.R +++ b/R/dbFetch_AdbiResult.R @@ -1,12 +1,13 @@ #' Fetch result sets #' -#' When fetching results using [dbFetch()], the argument `n` can be specified -#' to control chunk size per fetching operation. The default value of `-1` -#' corresponds to retrieving the entire result set at once, while a positive -#' integer will try returning as many rows (as long as `n` does not exceed the -#' available number of rows), in line with standard DBI expectations. As data -#' transfer is mediated by Arrow data structures, which are retrieved as array -#' chunks, the underlying chunk size can be used by passing an `n` value `NA`. +#' When fetching results using [DBI::dbFetch()], the argument `n` can be +#' specified to control chunk size per fetching operation. The default value of +#' `-1` corresponds to retrieving the entire result set at once, while a +#' positive integer will try returning as many rows (as long as `n` does not +#' exceed the available number of rows), in line with standard DBI +#' expectations. As data transfer is mediated by Arrow data structures, which +#' are retrieved as array chunks, the underlying chunk size can be used by +#' passing an `n` value `NA`. #' #' @rdname dbFetch #' @inheritParams DBI::dbFetch @@ -21,7 +22,7 @@ #' dbDisconnect(con) #' } #' @return A `data.frame` with the requested number of rows (or zero rows if -#' [dbFetch()] is called on a result set with no more remaining rows). +#' [DBI::dbFetch()] is called on a result set with no more remaining rows). #' @usage NULL dbFetch_AdbiResult <- function(res, n = -1, ...) { diff --git a/R/dbQuoteIdentifier_AdbiConnection_character.R b/R/dbQuoteIdentifier_AdbiConnection_character.R index 566a2fb..465b167 100644 --- a/R/dbQuoteIdentifier_AdbiConnection_character.R +++ b/R/dbQuoteIdentifier_AdbiConnection_character.R @@ -1,3 +1,5 @@ +#' @param x A character vector, [DBI::SQL] or [DBI::Id] object to quote as +#' identifier. #' @rdname AdbiConnection-class #' @inheritParams DBI::dbQuoteIdentifier #' @usage NULL diff --git a/R/dbRemoveTable_AdbiConnection_character.R b/R/dbRemoveTable_AdbiConnection_character.R index 02ff062..445dc80 100644 --- a/R/dbRemoveTable_AdbiConnection_character.R +++ b/R/dbRemoveTable_AdbiConnection_character.R @@ -1,5 +1,5 @@ #' @rdname AdbiConnection-class -#' @param fail_if_missing If `FALSE`, `dbRemoveTable()` succeeds if the +#' @param fail_if_missing If `FALSE`, [DBI::dbRemoveTable()] succeeds if the #' table doesn't exist. #' @inheritParams DBI::dbRemoveTable #' @usage NULL diff --git a/R/dbSendQuery_AdbiConnection_character.R b/R/dbSendQuery_AdbiConnection_character.R index 500edc3..72019e0 100644 --- a/R/dbSendQuery_AdbiConnection_character.R +++ b/R/dbSendQuery_AdbiConnection_character.R @@ -1,7 +1,7 @@ #' Create result sets #' -#' Creating result sets using [dbSendQuery()] (and by extension using -#' [dbGetQuery()]) mostly follows DBI specification. One way where adbi +#' Creating result sets using [DBI::dbSendQuery()] (and by extension using +#' [DBI::dbGetQuery()]) mostly follows DBI specification. One way where adbi #' deviates from DBI mechanisms is how the `bigint` setting is not only per #' connection, but the per-connection setting can be overridden on a result #' set basis. As default, the connection setting is applied, but passing one @@ -15,7 +15,7 @@ #' #' @seealso adbi-driver #' @rdname dbSendQuery -#' @param params Optional query parameters (forwarded to [dbBind()]) +#' @param params Optional query parameters (forwarded to [DBI::dbBind()]) #' @param immediate Passing a value `TRUE` is intended for statements containing #' no placeholders and `FALSE` otherwise. The default value `NULL` will #' inspect the statement for presence of placeholders (will `PREPARE` the @@ -37,7 +37,7 @@ #' ) #' dbDisconnect(con) #' } -#' @return An S4 class `AdbiResult` (inheriting from [DBIResult-class]). +#' @return An S4 class `AdbiResult` (inheriting from [DBI::DBIResult-class]). #' @usage NULL dbSendQuery_AdbiConnection_character <- function(conn, statement, ..., params = NULL, immediate = NULL, bigint = NULL) { diff --git a/cran-comments.md b/cran-comments.md index cb6703b..34032e9 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,6 +1,6 @@ ## Test environments -* local R installation, macOS 14.1.1, aarch64, R 4.2.2 +* local R installation, macOS 14.1.1, aarch64, R 4.4.2 * GitHub Actions (ubuntu-22.04): devel, release, oldrel-1, oldrel-2, oldrel-3, oldrel-4 * GitHub Actions (windows-latest): release, oldrel-3 @@ -11,4 +11,4 @@ 0 errors | 0 warnings | 0 notes -* Update for adbcdrivermanager 0.9.0.1 compatibility +* Update fixing link targets in docs diff --git a/man/AdbiConnection-class.Rd b/man/AdbiConnection-class.Rd index 704180c..24bbd7e 100644 --- a/man/AdbiConnection-class.Rd +++ b/man/AdbiConnection-class.Rd @@ -163,12 +163,13 @@ or \linkS4class{DBIConnection}} \item{obj}{An R object whose SQL type we want to determine.} -\item{x}{A character vector, \link[DBI]{SQL} or \link[DBI]{Id} object to quote as identifier.} +\item{x}{A character vector, \link[DBI:SQL]{DBI::SQL} or \link[DBI:Id]{DBI::Id} object to quote as +identifier.} \item{temporary}{a logical specifying whether the new table should be temporary. Its default is \code{FALSE}.} -\item{fail_if_missing}{If \code{FALSE}, \code{dbRemoveTable()} succeeds if the +\item{fail_if_missing}{If \code{FALSE}, \code{\link[DBI:dbRemoveTable]{DBI::dbRemoveTable()}} succeeds if the table doesn't exist.} \item{overwrite}{Allow overwriting the destination table. Cannot be @@ -186,8 +187,8 @@ with \code{\link[DBI:dbDataType]{DBI::dbDataType()}}).} \description{ AdbiConnection objects are created by passing \code{\link[=adbi]{adbi()}} as first argument to \code{\link[DBI:dbConnect]{DBI::dbConnect()}}. They are a superclass of the -\linkS4class{DBIConnection} class. The "Usage" section lists the class methods -overridden by \pkg{adbi}. +\link[DBI:DBIConnection-class]{DBI::DBIConnection} class. The "Usage" section lists the class +methods overridden by \pkg{adbi}. } \seealso{ The corresponding generic functions diff --git a/man/AdbiDriver-class.Rd b/man/AdbiDriver-class.Rd index f1df275..3d1795b 100644 --- a/man/AdbiDriver-class.Rd +++ b/man/AdbiDriver-class.Rd @@ -34,8 +34,8 @@ or \linkS4class{DBIConnection}} } \description{ AdbiDriver objects are created by \code{\link[=adbi]{adbi()}}, and used to select the -correct method in \code{\link[=dbConnect]{dbConnect()}}. They are a superclass of the -\linkS4class{DBIDriver} class, and used purely for dispatch. +correct method in \code{\link[DBI:dbConnect]{DBI::dbConnect()}}. They are a superclass of the +\link[DBI:DBIDriver-class]{DBI::DBIDriver} class, and used purely for dispatch. The "Usage" section lists the class methods overridden by \pkg{adbi}. } \keyword{internal} diff --git a/man/AdbiResult-class.Rd b/man/AdbiResult-class.Rd index 180daaf..c259d92 100644 --- a/man/AdbiResult-class.Rd +++ b/man/AdbiResult-class.Rd @@ -68,7 +68,7 @@ or a \linkS4class{DBIResult}} \description{ AdbiResult objects are created by \code{\link[DBI:dbSendQuery]{DBI::dbSendQuery()}} or \code{\link[DBI:dbSendStatement]{DBI::dbSendStatement()}}, and encapsulate the result of an SQL statement -(either \code{SELECT} or not). They are a superclass of the \linkS4class{DBIResult} +(either \code{SELECT} or not). They are a superclass of the \link[DBI:DBIResult-class]{DBI::DBIResult} class. The "Usage" section lists the class methods overridden by \pkg{adbi}. } diff --git a/man/AdbiResultArrow-class.Rd b/man/AdbiResultArrow-class.Rd index 36bfeb8..bc85e3c 100644 --- a/man/AdbiResultArrow-class.Rd +++ b/man/AdbiResultArrow-class.Rd @@ -78,8 +78,8 @@ or a \linkS4class{DBIResult}} \description{ AdbiResultArrow objects are created by \code{\link[DBI:dbSendQueryArrow]{DBI::dbSendQueryArrow()}}, and encapsulate the result of an SQL query (a \code{SELECT} statement). They are a -superclass of the \linkS4class{DBIResultArrow} class. The "Usage" section lists -the class methods overridden by \pkg{adbi}. +superclass of the \link[DBI:DBIResultArrow-class]{DBI::DBIResultArrow} class. The "Usage" section +lists the class methods overridden by \pkg{adbi}. } \seealso{ The corresponding generic functions diff --git a/man/dbConnect.Rd b/man/dbConnect.Rd index 13763ff..741f330 100644 --- a/man/dbConnect.Rd +++ b/man/dbConnect.Rd @@ -24,7 +24,7 @@ more information.} or an existing \linkS4class{DBIConnection} object (in order to clone an existing connection).} -\item{...}{Extra arguments passed to \code{\link[=dbConnect]{dbConnect()}} are forwarded to +\item{...}{Extra arguments passed to \code{\link[DBI:dbConnect]{DBI::dbConnect()}} are forwarded to \code{\link[adbcdrivermanager:adbc_database_init]{adbcdrivermanager::adbc_database_init()}}} \item{bigint}{The R type that 64-bit integer types should be mapped to, @@ -38,8 +38,8 @@ otherwise} } \value{ A connection object (S4 class \code{AdbiCOnnection}, inheriting from -\linkS4class{DBIConnection}) is returned by \code{\link[=dbConnect]{dbConnect()}}, while -\code{\link[=dbDisconnect]{dbDisconnect()}} returns \code{TRUE} invisibly. +\link[DBI:DBIConnection-class]{DBI::DBIConnection}) is returned by \code{\link[DBI:dbConnect]{DBI::dbConnect()}}, while +\code{\link[DBI:dbDisconnect]{DBI::dbDisconnect()}} returns \code{TRUE} invisibly. } \description{ In order to open a database connection, \code{\link[DBI:dbConnect]{DBI::dbConnect()}} dispatches on a diff --git a/man/dbFetch.Rd b/man/dbFetch.Rd index b5657b5..cd941d7 100644 --- a/man/dbFetch.Rd +++ b/man/dbFetch.Rd @@ -20,16 +20,17 @@ special values.} } \value{ A \code{data.frame} with the requested number of rows (or zero rows if -\code{\link[=dbFetch]{dbFetch()}} is called on a result set with no more remaining rows). +\code{\link[DBI:dbFetch]{DBI::dbFetch()}} is called on a result set with no more remaining rows). } \description{ -When fetching results using \code{\link[=dbFetch]{dbFetch()}}, the argument \code{n} can be specified -to control chunk size per fetching operation. The default value of \code{-1} -corresponds to retrieving the entire result set at once, while a positive -integer will try returning as many rows (as long as \code{n} does not exceed the -available number of rows), in line with standard DBI expectations. As data -transfer is mediated by Arrow data structures, which are retrieved as array -chunks, the underlying chunk size can be used by passing an \code{n} value \code{NA}. +When fetching results using \code{\link[DBI:dbFetch]{DBI::dbFetch()}}, the argument \code{n} can be +specified to control chunk size per fetching operation. The default value of +\code{-1} corresponds to retrieving the entire result set at once, while a +positive integer will try returning as many rows (as long as \code{n} does not +exceed the available number of rows), in line with standard DBI +expectations. As data transfer is mediated by Arrow data structures, which +are retrieved as array chunks, the underlying chunk size can be used by +passing an \code{n} value \code{NA}. } \examples{ if (requireNamespace("adbcsqlite")) { diff --git a/man/dbSendQuery.Rd b/man/dbSendQuery.Rd index 294b433..6971874 100644 --- a/man/dbSendQuery.Rd +++ b/man/dbSendQuery.Rd @@ -46,7 +46,7 @@ \item{...}{Other parameters passed on to methods.} -\item{params}{Optional query parameters (forwarded to \code{\link[=dbBind]{dbBind()}})} +\item{params}{Optional query parameters (forwarded to \code{\link[DBI:dbBind]{DBI::dbBind()}})} \item{immediate}{Passing a value \code{TRUE} is intended for statements containing no placeholders and \code{FALSE} otherwise. The default value \code{NULL} will @@ -57,11 +57,11 @@ statement)} default is chosen according to the connection setting} } \value{ -An S4 class \code{AdbiResult} (inheriting from \linkS4class{DBIResult}). +An S4 class \code{AdbiResult} (inheriting from \link[DBI:DBIResult-class]{DBI::DBIResult}). } \description{ -Creating result sets using \code{\link[=dbSendQuery]{dbSendQuery()}} (and by extension using -\code{\link[=dbGetQuery]{dbGetQuery()}}) mostly follows DBI specification. One way where adbi +Creating result sets using \code{\link[DBI:dbSendQuery]{DBI::dbSendQuery()}} (and by extension using +\code{\link[DBI:dbGetQuery]{DBI::dbGetQuery()}}) mostly follows DBI specification. One way where adbi deviates from DBI mechanisms is how the \code{bigint} setting is not only per connection, but the per-connection setting can be overridden on a result set basis. As default, the connection setting is applied, but passing one From f0cc0d741878cef015c0516dd8cf653d25fade37 Mon Sep 17 00:00:00 2001 From: Nicolas Bennett <3158446+nbenn@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:20:07 +0200 Subject: [PATCH 2/3] rm all of linkS4class in docs --- R/dbBegin_AdbiConnection.R | 2 ++ R/dbClearResult_AdbiResult.R | 1 + R/dbClearResult_AdbiResultArrow.R | 1 + R/dbConnect_AdbiDriver.R | 5 ++++- R/dbDisconnect_AdbiConnection.R | 3 ++- R/dbFetch_AdbiResult.R | 2 ++ R/dbIsValid_AdbiConnection.R | 2 ++ R/dbIsValid_AdbiDriver.R | 2 ++ R/dbIsValid_AdbiResult.R | 3 +++ R/dbIsValid_AdbiResultArrow.R | 3 +++ R/dbSendQuery_AdbiConnection_character.R | 3 +++ man/AdbiConnection-class.Rd | 8 ++++---- man/AdbiDriver-class.Rd | 4 ++-- man/AdbiResult-class.Rd | 8 ++++---- man/AdbiResultArrow-class.Rd | 8 ++++---- man/dbConnect.Rd | 9 +++++---- man/dbFetch.Rd | 4 ++-- man/dbSendQuery.Rd | 4 ++-- 18 files changed, 48 insertions(+), 24 deletions(-) diff --git a/R/dbBegin_AdbiConnection.R b/R/dbBegin_AdbiConnection.R index 77da16e..02a67b5 100644 --- a/R/dbBegin_AdbiConnection.R +++ b/R/dbBegin_AdbiConnection.R @@ -1,4 +1,6 @@ #' @rdname AdbiConnection-class +#' @param conn A [DBI::DBIConnection][DBI::DBIConnection-class] object, +#' as returned by [DBI::dbConnect()]. #' @inheritParams DBI::dbBegin #' @usage NULL dbBegin_AdbiConnection <- function(conn, ...) { diff --git a/R/dbClearResult_AdbiResult.R b/R/dbClearResult_AdbiResult.R index a92eb48..2f8f9c5 100644 --- a/R/dbClearResult_AdbiResult.R +++ b/R/dbClearResult_AdbiResult.R @@ -1,4 +1,5 @@ #' @rdname AdbiResult-class +#' @param res An object inheriting from [DBI::DBIResult][DBI::DBIResult-class]. #' @inheritParams DBI::dbClearResult #' @usage NULL dbClearResult_AdbiResult <- function(res, ...) { diff --git a/R/dbClearResult_AdbiResultArrow.R b/R/dbClearResult_AdbiResultArrow.R index ddd3218..a4048ce 100644 --- a/R/dbClearResult_AdbiResultArrow.R +++ b/R/dbClearResult_AdbiResultArrow.R @@ -1,4 +1,5 @@ #' @rdname AdbiResultArrow-class +#' @param res An object inheriting from [DBI::DBIResult][DBI::DBIResult-class]. #' @inheritParams DBI::dbClearResult #' @usage NULL dbClearResult_AdbiResultArrow <- function(res, ...) { diff --git a/R/dbConnect_AdbiDriver.R b/R/dbConnect_AdbiDriver.R index f84f070..a065106 100644 --- a/R/dbConnect_AdbiDriver.R +++ b/R/dbConnect_AdbiDriver.R @@ -1,10 +1,13 @@ #' @rdname dbConnect +#' @param drv An object that inherits from +#' [DBI::DBIDriver][DBI::DBIDriver-class], +#' or an existing [DBI::DBIConnection][DBI::DBIConnection-class] +#' object (in order to clone an existing connection). #' @param ... Extra arguments passed to [DBI::dbConnect()] are forwarded to #' [adbcdrivermanager::adbc_database_init()] #' @param bigint The R type that 64-bit integer types should be mapped to, #' default is [bit64::integer64], if bit64 is installed and `character` #' otherwise -#' @inheritParams DBI::dbConnect #' @examples #' library(DBI) #' con <- dbConnect(adbi()) diff --git a/R/dbDisconnect_AdbiConnection.R b/R/dbDisconnect_AdbiConnection.R index dca1d99..fdc1ba1 100644 --- a/R/dbDisconnect_AdbiConnection.R +++ b/R/dbDisconnect_AdbiConnection.R @@ -3,7 +3,8 @@ #' (default) or to simply inform about open results and mark the connection for #' finalization (which is triggered when the last open result is closed). #' @rdname dbConnect -#' @inheritParams DBI::dbDisconnect +#' @param conn A [DBI::DBIConnection][DBI::DBIConnection-class] object, +#' as returned by [DBI::dbConnect()]. #' @param force Close open results when disconnecting #' @usage NULL dbDisconnect_AdbiConnection <- function(conn, diff --git a/R/dbFetch_AdbiResult.R b/R/dbFetch_AdbiResult.R index 3ba60ff..b00148f 100644 --- a/R/dbFetch_AdbiResult.R +++ b/R/dbFetch_AdbiResult.R @@ -11,6 +11,8 @@ #' #' @rdname dbFetch #' @inheritParams DBI::dbFetch +#' @param res An object inheriting from [DBI::DBIResult][DBI::DBIResult-class], +#' created by [DBI::dbSendQuery()]. #' @examples #' if (requireNamespace("adbcsqlite")) { #' library(DBI) diff --git a/R/dbIsValid_AdbiConnection.R b/R/dbIsValid_AdbiConnection.R index 029e843..355f6e0 100644 --- a/R/dbIsValid_AdbiConnection.R +++ b/R/dbIsValid_AdbiConnection.R @@ -1,4 +1,6 @@ #' @rdname AdbiConnection-class +#' @param dbObj A object inheriting from [DBI::DBIDriver][DBI::DBIDriver-class] +#' or [DBI::DBIConnection][DBI::DBIConnection-class] #' @inheritParams DBI::dbIsValid #' @usage NULL dbIsValid_AdbiConnection <- function(dbObj, ...) { diff --git a/R/dbIsValid_AdbiDriver.R b/R/dbIsValid_AdbiDriver.R index e90fbd7..afad849 100644 --- a/R/dbIsValid_AdbiDriver.R +++ b/R/dbIsValid_AdbiDriver.R @@ -1,4 +1,6 @@ #' @rdname AdbiDriver-class +#' @param dbObj A object inheriting from [DBI::DBIDriver][DBI::DBIDriver-class] +#' or [DBI::DBIConnection][DBI::DBIConnection-class] #' @inheritParams DBI::dbIsValid #' @usage NULL dbIsValid_AdbiDriver <- function(dbObj, ...) { diff --git a/R/dbIsValid_AdbiResult.R b/R/dbIsValid_AdbiResult.R index 6dc8bcb..be617d1 100644 --- a/R/dbIsValid_AdbiResult.R +++ b/R/dbIsValid_AdbiResult.R @@ -1,4 +1,7 @@ #' @rdname AdbiResult-class +#' @param dbObj An object inheriting from [DBI::DBIObject-class], +#' i.e. [DBI::DBIDriver-class], [DBI::DBIConnection-class], +#' or a [DBI::DBIResult-class] #' @inheritParams DBI::dbIsValid #' @usage NULL dbIsValid_AdbiResult <- function(dbObj, ...) { diff --git a/R/dbIsValid_AdbiResultArrow.R b/R/dbIsValid_AdbiResultArrow.R index 4350317..2e268d9 100644 --- a/R/dbIsValid_AdbiResultArrow.R +++ b/R/dbIsValid_AdbiResultArrow.R @@ -1,4 +1,7 @@ #' @rdname AdbiResultArrow-class +#' @param dbObj An object inheriting from [DBI::DBIObject-class], +#' i.e. [DBI::DBIDriver-class], [DBI::DBIConnection-class], +#' or a [DBI::DBIResult-class] #' @inheritParams DBI::dbIsValid #' @usage NULL dbIsValid_AdbiResultArrow <- function(dbObj, ...) { diff --git a/R/dbSendQuery_AdbiConnection_character.R b/R/dbSendQuery_AdbiConnection_character.R index 72019e0..268b344 100644 --- a/R/dbSendQuery_AdbiConnection_character.R +++ b/R/dbSendQuery_AdbiConnection_character.R @@ -15,6 +15,9 @@ #' #' @seealso adbi-driver #' @rdname dbSendQuery +#' @param conn A [DBI::DBIConnection][DBI::DBIConnection-class] object, +#' as returned by [DBI::dbConnect()]. +#' @param statement a character string containing SQL. #' @param params Optional query parameters (forwarded to [DBI::dbBind()]) #' @param immediate Passing a value `TRUE` is intended for statements containing #' no placeholders and `FALSE` otherwise. The default value `NULL` will diff --git a/man/AdbiConnection-class.Rd b/man/AdbiConnection-class.Rd index 24bbd7e..88757d7 100644 --- a/man/AdbiConnection-class.Rd +++ b/man/AdbiConnection-class.Rd @@ -135,8 +135,8 @@ \S4method{show}{AdbiConnection}(object) } \arguments{ -\item{conn}{A \linkS4class{DBIConnection} object, as returned by -\code{\link[DBI:dbConnect]{dbConnect()}}.} +\item{conn}{A \link[DBI:DBIConnection-class]{DBI::DBIConnection} object, +as returned by \code{\link[DBI:dbConnect]{DBI::dbConnect()}}.} \item{name}{The table name, passed on to \code{\link[DBI:dbQuoteIdentifier]{dbQuoteIdentifier()}}. Options are: \itemize{ @@ -158,8 +158,8 @@ will be whatever the R identifier \code{"row.names"} maps to the DBMS (see \code{\link[DBI:make.db.names]{DBI::make.db.names()}}). If \code{NA} will add rows names if they are characters, otherwise will ignore.} -\item{dbObj}{A object inheriting from \linkS4class{DBIDriver} -or \linkS4class{DBIConnection}} +\item{dbObj}{A object inheriting from \link[DBI:DBIDriver-class]{DBI::DBIDriver} +or \link[DBI:DBIConnection-class]{DBI::DBIConnection}} \item{obj}{An R object whose SQL type we want to determine.} diff --git a/man/AdbiDriver-class.Rd b/man/AdbiDriver-class.Rd index 3d1795b..ca86ff0 100644 --- a/man/AdbiDriver-class.Rd +++ b/man/AdbiDriver-class.Rd @@ -23,8 +23,8 @@ \S4method{show}{AdbiDriver}(object) } \arguments{ -\item{dbObj}{A object inheriting from \linkS4class{DBIDriver} -or \linkS4class{DBIConnection}} +\item{dbObj}{A object inheriting from \link[DBI:DBIDriver-class]{DBI::DBIDriver} +or \link[DBI:DBIConnection-class]{DBI::DBIConnection}} \item{obj}{An R object whose SQL type we want to determine.} diff --git a/man/AdbiResult-class.Rd b/man/AdbiResult-class.Rd index c259d92..d6f53be 100644 --- a/man/AdbiResult-class.Rd +++ b/man/AdbiResult-class.Rd @@ -50,7 +50,7 @@ \S4method{show}{AdbiResult}(object) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBI::DBIResult}.} \item{params}{For \code{dbBind()}, a list of values, named or unnamed, or a data frame, with one element/column per query parameter. @@ -59,9 +59,9 @@ with one column per query parameter.} \item{...}{Other arguments passed on to methods.} -\item{dbObj}{An object inheriting from \linkS4class{DBIObject}, -i.e. \linkS4class{DBIDriver}, \linkS4class{DBIConnection}, -or a \linkS4class{DBIResult}} +\item{dbObj}{An object inheriting from \link[DBI:DBIObject-class]{DBI::DBIObject}, +i.e. \link[DBI:DBIDriver-class]{DBI::DBIDriver}, \link[DBI:DBIConnection-class]{DBI::DBIConnection}, +or a \link[DBI:DBIResult-class]{DBI::DBIResult}} \item{object}{Any R object} } diff --git a/man/AdbiResultArrow-class.Rd b/man/AdbiResultArrow-class.Rd index bc85e3c..4eb7f0f 100644 --- a/man/AdbiResultArrow-class.Rd +++ b/man/AdbiResultArrow-class.Rd @@ -60,7 +60,7 @@ \S4method{show}{AdbiResultArrow}(object) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBIResult}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBI::DBIResult}.} \item{params}{For \code{dbBind()}, a list of values, named or unnamed, or a data frame, with one element/column per query parameter. @@ -69,9 +69,9 @@ with one column per query parameter.} \item{...}{Other arguments passed on to methods.} -\item{dbObj}{An object inheriting from \linkS4class{DBIObject}, -i.e. \linkS4class{DBIDriver}, \linkS4class{DBIConnection}, -or a \linkS4class{DBIResult}} +\item{dbObj}{An object inheriting from \link[DBI:DBIObject-class]{DBI::DBIObject}, +i.e. \link[DBI:DBIDriver-class]{DBI::DBIDriver}, \link[DBI:DBIConnection-class]{DBI::DBIConnection}, +or a \link[DBI:DBIResult-class]{DBI::DBIResult}} \item{object}{Any R object} } diff --git a/man/dbConnect.Rd b/man/dbConnect.Rd index 741f330..1c47af2 100644 --- a/man/dbConnect.Rd +++ b/man/dbConnect.Rd @@ -20,8 +20,9 @@ adbi(driver = NA_character_) arguments) to give an \code{\link[adbcdrivermanager:adbc_driver_void]{adbcdrivermanager::adbc_driver()}}. See Details for more information.} -\item{drv}{an object that inherits from \linkS4class{DBIDriver}, -or an existing \linkS4class{DBIConnection} +\item{drv}{An object that inherits from +\link[DBI:DBIDriver-class]{DBI::DBIDriver}, +or an existing \link[DBI:DBIConnection-class]{DBI::DBIConnection} object (in order to clone an existing connection).} \item{...}{Extra arguments passed to \code{\link[DBI:dbConnect]{DBI::dbConnect()}} are forwarded to @@ -31,8 +32,8 @@ object (in order to clone an existing connection).} default is \link[bit64:bit64-package]{bit64::integer64}, if bit64 is installed and \code{character} otherwise} -\item{conn}{A \linkS4class{DBIConnection} object, as returned by -\code{\link[DBI:dbConnect]{dbConnect()}}.} +\item{conn}{A \link[DBI:DBIConnection-class]{DBI::DBIConnection} object, +as returned by \code{\link[DBI:dbConnect]{DBI::dbConnect()}}.} \item{force}{Close open results when disconnecting} } diff --git a/man/dbFetch.Rd b/man/dbFetch.Rd index cd941d7..2cd5897 100644 --- a/man/dbFetch.Rd +++ b/man/dbFetch.Rd @@ -8,8 +8,8 @@ \S4method{dbFetch}{AdbiResult}(res, n = -1, ...) } \arguments{ -\item{res}{An object inheriting from \linkS4class{DBIResult}, created by -\code{\link[DBI:dbSendQuery]{dbSendQuery()}}.} +\item{res}{An object inheriting from \link[DBI:DBIResult-class]{DBI::DBIResult}, +created by \code{\link[DBI:dbSendQuery]{DBI::dbSendQuery()}}.} \item{n}{maximum number of records to retrieve per fetch. Use \code{n = -1} or \code{n = Inf} diff --git a/man/dbSendQuery.Rd b/man/dbSendQuery.Rd index 6971874..88b01e0 100644 --- a/man/dbSendQuery.Rd +++ b/man/dbSendQuery.Rd @@ -39,8 +39,8 @@ ) } \arguments{ -\item{conn}{A \linkS4class{DBIConnection} object, as returned by -\code{\link[DBI:dbConnect]{dbConnect()}}.} +\item{conn}{A \link[DBI:DBIConnection-class]{DBI::DBIConnection} object, +as returned by \code{\link[DBI:dbConnect]{DBI::dbConnect()}}.} \item{statement}{a character string containing SQL.} From 1a0155090890294a7f2bd7f921ac7f6fa13abcca Mon Sep 17 00:00:00 2001 From: Nicolas Bennett <3158446+nbenn@users.noreply.github.com> Date: Wed, 3 Sep 2025 22:39:27 +0200 Subject: [PATCH 3/3] fix local in cran comments --- cran-comments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cran-comments.md b/cran-comments.md index 34032e9..ad64397 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,6 +1,6 @@ ## Test environments -* local R installation, macOS 14.1.1, aarch64, R 4.4.2 +* local R installation, macOS 15.6.1, aarch64, R 4.4.2 * GitHub Actions (ubuntu-22.04): devel, release, oldrel-1, oldrel-2, oldrel-3, oldrel-4 * GitHub Actions (windows-latest): release, oldrel-3