diff --git a/R/dbGetQuery.R b/R/dbGetQuery.R index 1bdf8b45f..cc43157ea 100644 --- a/R/dbGetQuery.R +++ b/R/dbGetQuery.R @@ -4,13 +4,14 @@ #' `dbGetQuery()` comes with a default implementation #' (which should work with most backends) that calls #' [dbSendQuery()], then [dbFetch()], ensuring that -#' the result is always free-d by [dbClearResult()]. +#' the result is always freed by [dbClearResult()]. #' For retrieving chunked/paged results or for passing query parameters, #' see [dbSendQuery()], in particular the "The data retrieval flow" section. +#' For retrieving results as an Arrow object, see [dbGetQueryArrow()]. #' #' This method is for `SELECT` queries only #' (incl. other SQL statements that return a `SELECT`-alike result, -#' e. g. execution of a stored procedure or data manipulation queries +#' e.g., execution of a stored procedure or data manipulation queries #' like `INSERT INTO ... RETURNING ...`). #' To execute a stored procedure that does not return a result set, #' use [dbExecute()]. @@ -23,11 +24,10 @@ #' @template methods #' @templateVar method_name dbGetQuery #' -#' @inherit DBItest::spec_result_get_query return -#' @inheritSection DBItest::spec_result_get_query Failure modes -#' @inheritSection DBItest::spec_result_get_query Additional arguments -#' @inheritSection DBItest::spec_result_get_query Specification -#' @inheritSection DBItest::spec_result_get_query Specification for the `immediate` argument +#' @inherit DBItest::spec_arrow_get_query_arrow return +#' @inheritSection DBItest::spec_arrow_get_query_arrow Failure modes +#' @inheritSection DBItest::spec_arrow_get_query_arrow Additional arguments +#' @inheritSection DBItest::spec_arrow_get_query_arrow Specification for the `immediate` argument #' #' @section Implementation notes: #' Subclasses should override this method only if they provide some sort of diff --git a/R/dbGetQueryArrow.R b/R/dbGetQueryArrow.R index 711f830fd..d43f28fae 100644 --- a/R/dbGetQueryArrow.R +++ b/R/dbGetQueryArrow.R @@ -1,3 +1,46 @@ +#' Send query, retrieve results as an Arrow object and then clear result set +#' +#' Returns the result of a query as a data frame. +#' `dbGetQuery()` comes with a default implementation +#' (which should work with most backends) that calls +#' [dbSendQueryArrow()], then [dbFetchArrow()], ensuring that +#' the result is always freed by [dbClearResult()]. +#' For passing query parameters, +#' see [dbSendQueryArrow()], in particular the "The data retrieval flow" section. +#' For retrieving results as a data frame, see [dbGetQuery()]. +#' +#' This method is for `SELECT` queries only +#' (incl. other SQL statements that return a `SELECT`-alike result, +#' e.g., execution of a stored procedure or data manipulation queries +#' like `INSERT INTO ... RETURNING ...`). +#' To execute a stored procedure that does not return a result set, +#' use [dbExecute()]. +#' +#' Some backends may +#' support data manipulation statements through this method. +#' However, callers are strongly advised to use +#' [dbExecute()] for data manipulation statements. +#' +#' @template methods +#' @templateVar method_name dbGetQueryArrow +#' +#' @inherit DBItest::spec_result_get_query return +#' @inheritSection DBItest::spec_result_get_query Failure modes +#' @inheritSection DBItest::spec_result_get_query Additional arguments +#' @inheritSection DBItest::spec_result_get_query Specification +#' @inheritSection DBItest::spec_result_get_query Specification for the `immediate` argument +#' +#' @section Implementation notes: +#' Subclasses should override this method only if they provide some sort of +#' performance optimization. +#' +#' @param conn A [DBIConnection-class] object, as returned by +#' [dbConnect()]. +#' @param statement a character string containing SQL. +#' @param ... Other parameters passed on to methods. +#' @family DBIConnection generics +#' @family data retrieval generics +#' @seealso For updates: [dbSendStatementArrow()] and [dbExecute()]. #' @export #' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE) #' # Retrieve data as arrow table @@ -7,7 +50,6 @@ #' dbGetQueryArrow(con, "SELECT * FROM mtcars") #' #' dbDisconnect(con) -#' @rdname dbGetQuery setGeneric("dbGetQueryArrow", def = function(conn, statement, ...) standardGeneric("dbGetQueryArrow") ) diff --git a/_pkgdown.yml b/_pkgdown.yml index ef3d5f216..5d3e4e205 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -84,6 +84,7 @@ reference: - dbWriteTableArrow - dbCreateTableArrow - dbAppendTableArrow + - dbGetQueryArrow - title: Classes desc: S4 classes defined by DBI. diff --git a/man/DBIConnection-class.Rd b/man/DBIConnection-class.Rd index 1042000fa..20bc84215 100644 --- a/man/DBIConnection-class.Rd +++ b/man/DBIConnection-class.Rd @@ -46,6 +46,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbAppendTable.Rd b/man/dbAppendTable.Rd index 216308524..8dc4ac123 100644 --- a/man/dbAppendTable.Rd +++ b/man/dbAppendTable.Rd @@ -174,6 +174,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbAppendTableArrow.Rd b/man/dbAppendTableArrow.Rd index 1a6874b04..1415ee6cf 100644 --- a/man/dbAppendTableArrow.Rd +++ b/man/dbAppendTableArrow.Rd @@ -146,6 +146,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbBind.Rd b/man/dbBind.Rd index aee8d4de1..bc5c2cc5a 100644 --- a/man/dbBind.Rd +++ b/man/dbBind.Rd @@ -361,6 +361,7 @@ Other data retrieval generics: \code{\link{dbClearResult}()}, \code{\link{dbFetch}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbHasCompleted}()}, \code{\link{dbSendQuery}()} diff --git a/man/dbClearResult.Rd b/man/dbClearResult.Rd index f1f157394..0a64d36dc 100644 --- a/man/dbClearResult.Rd +++ b/man/dbClearResult.Rd @@ -145,6 +145,7 @@ Other data retrieval generics: \code{\link{dbBind}()}, \code{\link{dbFetch}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbHasCompleted}()}, \code{\link{dbSendQuery}()} diff --git a/man/dbCreateTable.Rd b/man/dbCreateTable.Rd index c53d267c8..577fb241a 100644 --- a/man/dbCreateTable.Rd +++ b/man/dbCreateTable.Rd @@ -145,6 +145,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbCreateTableArrow.Rd b/man/dbCreateTableArrow.Rd index a1122bfd8..c98cf11cc 100644 --- a/man/dbCreateTableArrow.Rd +++ b/man/dbCreateTableArrow.Rd @@ -120,6 +120,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbDataType.Rd b/man/dbDataType.Rd index 87f171a57..dae415539 100644 --- a/man/dbDataType.Rd +++ b/man/dbDataType.Rd @@ -143,6 +143,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbDisconnect.Rd b/man/dbDisconnect.Rd index b7385bce0..6c0aec5a1 100644 --- a/man/dbDisconnect.Rd +++ b/man/dbDisconnect.Rd @@ -52,6 +52,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbExecute.Rd b/man/dbExecute.Rd index ce6f2e1c1..e0d07bd2d 100644 --- a/man/dbExecute.Rd +++ b/man/dbExecute.Rd @@ -161,6 +161,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbExistsTable.Rd b/man/dbExistsTable.Rd index 1b63f97fd..95ff63f0f 100644 --- a/man/dbExistsTable.Rd +++ b/man/dbExistsTable.Rd @@ -84,6 +84,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbFetch.Rd b/man/dbFetch.Rd index c650d0c24..2af04ed66 100644 --- a/man/dbFetch.Rd +++ b/man/dbFetch.Rd @@ -221,6 +221,7 @@ Other data retrieval generics: \code{\link{dbBind}()}, \code{\link{dbClearResult}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbHasCompleted}()}, \code{\link{dbSendQuery}()} } diff --git a/man/dbGetException.Rd b/man/dbGetException.Rd index a76b68721..b6127e982 100644 --- a/man/dbGetException.Rd +++ b/man/dbGetException.Rd @@ -34,6 +34,7 @@ Other DBIConnection generics: \code{\link{dbExistsTable}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbGetInfo.Rd b/man/dbGetInfo.Rd index dfaa6ea37..bbeccc286 100644 --- a/man/dbGetInfo.Rd +++ b/man/dbGetInfo.Rd @@ -87,6 +87,7 @@ Other DBIConnection generics: \code{\link{dbExistsTable}()}, \code{\link{dbGetException}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbGetQuery.Rd b/man/dbGetQuery.Rd index d36c63da2..b5730f0a8 100644 --- a/man/dbGetQuery.Rd +++ b/man/dbGetQuery.Rd @@ -1,13 +1,10 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dbGetQuery.R, R/dbGetQueryArrow.R +% Please edit documentation in R/dbGetQuery.R \name{dbGetQuery} \alias{dbGetQuery} -\alias{dbGetQueryArrow} \title{Send query, retrieve results and then clear result set} \usage{ dbGetQuery(conn, statement, ...) - -dbGetQueryArrow(conn, statement, ...) } \arguments{ \item{conn}{A \linkS4class{DBIConnection} object, as returned by @@ -18,7 +15,7 @@ dbGetQueryArrow(conn, statement, ...) \item{...}{Other parameters passed on to methods.} } \value{ -\code{dbGetQuery()} always returns a \link{data.frame} +\code{dbGetQueryArrow()} always returns an object coercible to a \link{data.frame} with as many rows as records were fetched and as many columns as fields in the result set, even if the result is a single value @@ -30,16 +27,17 @@ Returns the result of a query as a data frame. \code{dbGetQuery()} comes with a default implementation (which should work with most backends) that calls \code{\link[=dbSendQuery]{dbSendQuery()}}, then \code{\link[=dbFetch]{dbFetch()}}, ensuring that -the result is always free-d by \code{\link[=dbClearResult]{dbClearResult()}}. +the result is always freed by \code{\link[=dbClearResult]{dbClearResult()}}. For retrieving chunked/paged results or for passing query parameters, see \code{\link[=dbSendQuery]{dbSendQuery()}}, in particular the "The data retrieval flow" section. +For retrieving results as an Arrow object, see \code{\link[=dbGetQueryArrow]{dbGetQueryArrow()}}. \Sexpr[results=rd,stage=render]{DBI:::methods_as_rd("dbGetQuery")} } \details{ This method is for \code{SELECT} queries only (incl. other SQL statements that return a \code{SELECT}-alike result, -e. g. execution of a stored procedure or data manipulation queries +e.g., execution of a stored procedure or data manipulation queries like \verb{INSERT INTO ... RETURNING ...}). To execute a stored procedure that does not return a result set, use \code{\link[=dbExecute]{dbExecute()}}. @@ -62,20 +60,21 @@ An error is raised when issuing a query over a closed or invalid connection, if the syntax of the query is invalid, or if the query is not a non-\code{NA} string. -If the \code{n} argument is not an atomic whole number -greater or equal to -1 or Inf, an error is raised, -but a subsequent call to \code{dbGetQuery()} with proper \code{n} argument succeeds. +The object returned by \code{dbGetQueryArrow()} can also be passed to +\code{\link[nanoarrow:as_nanoarrow_array_stream]{nanoarrow::as_nanoarrow_array_stream()}} to create a nanoarrow +array stream object that can be used to read the result set +in batches. +The chunk size is implementation-specific. } \section{Additional arguments}{ -The following arguments are not part of the \code{dbGetQuery()} generic +The following arguments are not part of the \code{dbGetQueryArrow()} generic (to improve compatibility across backends) but are part of the DBI specification: \itemize{ -\item \code{n} (default: -1) \item \code{params} (default: \code{NULL}) \item \code{immediate} (default: \code{NULL}) } @@ -83,26 +82,6 @@ but are part of the DBI specification: They must be provided as named arguments. See the "Specification" and "Value" sections for details on their usage. -} - -\section{Specification}{ - - - -A column named \code{row_names} is treated like any other column. - -The \code{n} argument specifies the number of rows to be fetched. -If omitted, fetching multi-row queries with one -or more columns returns the entire result. -A value of \link{Inf} for the \code{n} argument is supported -and also returns the full result. -If more rows than available are fetched (by passing a too large value for -\code{n}), the result is returned in full without warning. -If zero rows are requested, the columns of the data frame are still fully -typed. -Fetching fewer rows than available is permitted, -no warning is issued. - The \code{param} argument allows passing query parameters, see \code{\link[=dbBind]{dbBind()}} for details. } @@ -169,15 +148,6 @@ dbGetQuery( params = list(1:8) ) -dbDisconnect(con) -\dontshow{\}) # examplesIf} -\dontshow{if (requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} -# Retrieve data as arrow table -con <- dbConnect(RSQLite::SQLite(), ":memory:") - -dbWriteTable(con, "mtcars", mtcars) -dbGetQueryArrow(con, "SELECT * FROM mtcars") - dbDisconnect(con) \dontshow{\}) # examplesIf} } @@ -196,6 +166,7 @@ Other DBIConnection generics: \code{\link{dbExistsTable}()}, \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, @@ -214,6 +185,7 @@ Other data retrieval generics: \code{\link{dbBind}()}, \code{\link{dbClearResult}()}, \code{\link{dbFetch}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbHasCompleted}()}, \code{\link{dbSendQuery}()} } diff --git a/man/dbGetQueryArrow.Rd b/man/dbGetQueryArrow.Rd new file mode 100644 index 000000000..61b97a94d --- /dev/null +++ b/man/dbGetQueryArrow.Rd @@ -0,0 +1,202 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/dbGetQueryArrow.R +\name{dbGetQueryArrow} +\alias{dbGetQueryArrow} +\title{Send query, retrieve results as an Arrow object and then clear result set} +\usage{ +dbGetQueryArrow(conn, statement, ...) +} +\arguments{ +\item{conn}{A \linkS4class{DBIConnection} object, as returned by +\code{\link[=dbConnect]{dbConnect()}}.} + +\item{statement}{a character string containing SQL.} + +\item{...}{Other parameters passed on to methods.} +} +\value{ +\code{dbGetQuery()} always returns a \link{data.frame} +with as many rows as records were fetched and as many +columns as fields in the result set, +even if the result is a single value +or has one +or zero rows. +} +\description{ +Returns the result of a query as a data frame. +\code{dbGetQuery()} comes with a default implementation +(which should work with most backends) that calls +\code{\link[=dbSendQueryArrow]{dbSendQueryArrow()}}, then \code{\link[=dbFetchArrow]{dbFetchArrow()}}, ensuring that +the result is always freed by \code{\link[=dbClearResult]{dbClearResult()}}. +For passing query parameters, +see \code{\link[=dbSendQueryArrow]{dbSendQueryArrow()}}, in particular the "The data retrieval flow" section. +For retrieving results as a data frame, see \code{\link[=dbGetQuery]{dbGetQuery()}}. + +\Sexpr[results=rd,stage=render]{DBI:::methods_as_rd("dbGetQueryArrow")} +} +\details{ +This method is for \code{SELECT} queries only +(incl. other SQL statements that return a \code{SELECT}-alike result, +e.g., execution of a stored procedure or data manipulation queries +like \verb{INSERT INTO ... RETURNING ...}). +To execute a stored procedure that does not return a result set, +use \code{\link[=dbExecute]{dbExecute()}}. + +Some backends may +support data manipulation statements through this method. +However, callers are strongly advised to use +\code{\link[=dbExecute]{dbExecute()}} for data manipulation statements. +} +\section{Implementation notes}{ + +Subclasses should override this method only if they provide some sort of +performance optimization. +} + +\section{Failure modes}{ + + +An error is raised when issuing a query over a closed +or invalid connection, +if the syntax of the query is invalid, +or if the query is not a non-\code{NA} string. +If the \code{n} argument is not an atomic whole number +greater or equal to -1 or Inf, an error is raised, +but a subsequent call to \code{dbGetQuery()} with proper \code{n} argument succeeds. + +} + +\section{Additional arguments}{ + + +The following arguments are not part of the \code{dbGetQuery()} generic +(to improve compatibility across backends) +but are part of the DBI specification: +\itemize{ +\item \code{n} (default: -1) +\item \code{params} (default: \code{NULL}) +\item \code{immediate} (default: \code{NULL}) +} + +They must be provided as named arguments. +See the "Specification" and "Value" sections for details on their usage. + +} + +\section{Specification}{ + + + +A column named \code{row_names} is treated like any other column. + +The \code{n} argument specifies the number of rows to be fetched. +If omitted, fetching multi-row queries with one +or more columns returns the entire result. +A value of \link{Inf} for the \code{n} argument is supported +and also returns the full result. +If more rows than available are fetched (by passing a too large value for +\code{n}), the result is returned in full without warning. +If zero rows are requested, the columns of the data frame are still fully +typed. +Fetching fewer rows than available is permitted, +no warning is issued. + +The \code{param} argument allows passing query parameters, see \code{\link[=dbBind]{dbBind()}} for details. + +} + +\section{Specification for the \code{immediate} argument}{ + + + +The \code{immediate} argument supports distinguishing between "direct" +and "prepared" APIs offered by many database drivers. +Passing \code{immediate = TRUE} leads to immediate execution of the +query or statement, via the "direct" API (if supported by the driver). +The default \code{NULL} means that the backend should choose whatever API +makes the most sense for the database, and (if relevant) tries the +other API if the first attempt fails. A successful second attempt +should result in a message that suggests passing the correct +\code{immediate} argument. +Examples for possible behaviors: +\enumerate{ +\item DBI backend defaults to \code{immediate = TRUE} internally +\enumerate{ +\item A query without parameters is passed: query is executed +\item A query with parameters is passed: +\enumerate{ +\item \code{params} not given: rejected immediately by the database +because of a syntax error in the query, the backend tries +\code{immediate = FALSE} (and gives a message) +\item \code{params} given: query is executed using \code{immediate = FALSE} +} +} +\item DBI backend defaults to \code{immediate = FALSE} internally +\enumerate{ +\item A query without parameters is passed: +\enumerate{ +\item simple query: query is executed +\item "special" query (such as setting a config options): fails, +the backend tries \code{immediate = TRUE} (and gives a message) +} +\item A query with parameters is passed: +\enumerate{ +\item \code{params} not given: waiting for parameters via \code{\link[=dbBind]{dbBind()}} +\item \code{params} given: query is executed +} +} +} + +} + +\examples{ +\dontshow{if (requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE)) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +# Retrieve data as arrow table +con <- dbConnect(RSQLite::SQLite(), ":memory:") + +dbWriteTable(con, "mtcars", mtcars) +dbGetQueryArrow(con, "SELECT * FROM mtcars") + +dbDisconnect(con) +\dontshow{\}) # examplesIf} +} +\seealso{ +For updates: \code{\link[=dbSendStatementArrow]{dbSendStatementArrow()}} and \code{\link[=dbExecute]{dbExecute()}}. + +Other DBIConnection generics: +\code{\link{DBIConnection-class}}, +\code{\link{dbAppendTable}()}, +\code{\link{dbAppendTableArrow}()}, +\code{\link{dbCreateTable}()}, +\code{\link{dbCreateTableArrow}()}, +\code{\link{dbDataType}()}, +\code{\link{dbDisconnect}()}, +\code{\link{dbExecute}()}, +\code{\link{dbExistsTable}()}, +\code{\link{dbGetException}()}, +\code{\link{dbGetInfo}()}, +\code{\link{dbGetQuery}()}, +\code{\link{dbIsReadOnly}()}, +\code{\link{dbIsValid}()}, +\code{\link{dbListFields}()}, +\code{\link{dbListObjects}()}, +\code{\link{dbListResults}()}, +\code{\link{dbListTables}()}, +\code{\link{dbReadTable}()}, +\code{\link{dbReadTableArrow}()}, +\code{\link{dbRemoveTable}()}, +\code{\link{dbSendQuery}()}, +\code{\link{dbSendStatement}()}, +\code{\link{dbWriteTable}()}, +\code{\link{dbWriteTableArrow}()} + +Other data retrieval generics: +\code{\link{dbBind}()}, +\code{\link{dbClearResult}()}, +\code{\link{dbFetch}()}, +\code{\link{dbGetQuery}()}, +\code{\link{dbHasCompleted}()}, +\code{\link{dbSendQuery}()} +} +\concept{DBIConnection generics} +\concept{data retrieval generics} diff --git a/man/dbHasCompleted.Rd b/man/dbHasCompleted.Rd index 53a409309..71edc8f43 100644 --- a/man/dbHasCompleted.Rd +++ b/man/dbHasCompleted.Rd @@ -129,6 +129,7 @@ Other data retrieval generics: \code{\link{dbClearResult}()}, \code{\link{dbFetch}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbSendQuery}()} } \concept{DBIResult generics} diff --git a/man/dbIsReadOnly.Rd b/man/dbIsReadOnly.Rd index a7b713f3a..c8a4e1a73 100644 --- a/man/dbIsReadOnly.Rd +++ b/man/dbIsReadOnly.Rd @@ -45,6 +45,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, \code{\link{dbListObjects}()}, diff --git a/man/dbIsValid.Rd b/man/dbIsValid.Rd index 9e838f946..a08f0cf6f 100644 --- a/man/dbIsValid.Rd +++ b/man/dbIsValid.Rd @@ -78,6 +78,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbListFields}()}, \code{\link{dbListObjects}()}, diff --git a/man/dbListFields.Rd b/man/dbListFields.Rd index c41909cf1..3d8c0b20f 100644 --- a/man/dbListFields.Rd +++ b/man/dbListFields.Rd @@ -90,6 +90,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListObjects}()}, diff --git a/man/dbListObjects.Rd b/man/dbListObjects.Rd index 40f2d4191..dcd8b72fd 100644 --- a/man/dbListObjects.Rd +++ b/man/dbListObjects.Rd @@ -113,6 +113,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbListResults.Rd b/man/dbListResults.Rd index 6a1448287..9e4c7c1e5 100644 --- a/man/dbListResults.Rd +++ b/man/dbListResults.Rd @@ -35,6 +35,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbListTables.Rd b/man/dbListTables.Rd index 2cb883adf..1adb75559 100644 --- a/man/dbListTables.Rd +++ b/man/dbListTables.Rd @@ -68,6 +68,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbReadTable.Rd b/man/dbReadTable.Rd index 3c68b7a8e..1ca0f3077 100644 --- a/man/dbReadTable.Rd +++ b/man/dbReadTable.Rd @@ -141,6 +141,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbReadTableArrow.Rd b/man/dbReadTableArrow.Rd index 1716aa060..fe7da023b 100644 --- a/man/dbReadTableArrow.Rd +++ b/man/dbReadTableArrow.Rd @@ -92,6 +92,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbRemoveTable.Rd b/man/dbRemoveTable.Rd index 70ffbd1c2..8c54a7d0a 100644 --- a/man/dbRemoveTable.Rd +++ b/man/dbRemoveTable.Rd @@ -115,6 +115,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbSendQuery.Rd b/man/dbSendQuery.Rd index 67521a464..7528c02b5 100644 --- a/man/dbSendQuery.Rd +++ b/man/dbSendQuery.Rd @@ -234,6 +234,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, @@ -252,6 +253,7 @@ Other data retrieval generics: \code{\link{dbClearResult}()}, \code{\link{dbFetch}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbHasCompleted}()} } \concept{DBIConnection generics} diff --git a/man/dbSendStatement.Rd b/man/dbSendStatement.Rd index 708e5a560..e64ee60fc 100644 --- a/man/dbSendStatement.Rd +++ b/man/dbSendStatement.Rd @@ -214,6 +214,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbWriteTable.Rd b/man/dbWriteTable.Rd index cc226550e..689fcfc11 100644 --- a/man/dbWriteTable.Rd +++ b/man/dbWriteTable.Rd @@ -227,6 +227,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()}, diff --git a/man/dbWriteTableArrow.Rd b/man/dbWriteTableArrow.Rd index 5d8d66d48..6aebdab98 100644 --- a/man/dbWriteTableArrow.Rd +++ b/man/dbWriteTableArrow.Rd @@ -190,6 +190,7 @@ Other DBIConnection generics: \code{\link{dbGetException}()}, \code{\link{dbGetInfo}()}, \code{\link{dbGetQuery}()}, +\code{\link{dbGetQueryArrow}()}, \code{\link{dbIsReadOnly}()}, \code{\link{dbIsValid}()}, \code{\link{dbListFields}()},