R/AdbiResultArrow.R

In adbi: 'DBI' Compliant Database Access Using 'ADBC'

#' @include AdbiConnection.R
NULL

AdbiResultArrow <- function(connection, statement, immediate = NULL,
                            type = c("query", "statement"), bigint = NULL,
                            rows_affected_callback = identity) {

  init_result(
    connection = connection,
    statement = statement,
    class = "AdbiResultArrow",
    immediate = immediate,
    type = type,
    bigint = bigint,
    rows_affected_callback = rows_affected_callback
  )
}

#' Class AdbiResultArrow (and methods)
#'
#' 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}.
#'
#' @seealso
#' The corresponding generic functions
#' [DBI::dbFetchArrow()], [DBI::dbFetchArrowChunk()], [DBI::dbClearResult()],
#' [DBI::dbBind()], [DBI::dbColumnInfo()], [DBI::dbGetRowsAffected()],
#' [DBI::dbGetRowCount()], [DBI::dbHasCompleted()], and [DBI::dbGetStatement()].
#'
#' @export
#' @keywords internal
setClass(
  "AdbiResultArrow",
  contains = "DBIResultArrow",
  slots = list(
    statement = "ANY",
    metadata = "environment",
    bigint = "character",
    rows_affected_callback = "function"
  )
)