AdbiResultArrow-class: Class AdbiResultArrow (and methods)

AdbiResultArrow-classR Documentation

Class AdbiResultArrow (and methods)

Description

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. The "Usage" section lists the class methods overridden by adbi.

Usage

## S4 method for signature 'AdbiResultArrow'
dbBindArrow(res, params, ...)

## S4 method for signature 'AdbiResultArrow'
dbBind(res, params, ...)

## S4 method for signature 'AdbiResultArrow'
dbClearResult(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbColumnInfo(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbFetchArrowChunk(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbFetchArrow(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbGetRowCount(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbGetRowsAffected(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbGetStatement(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbHasCompleted(res, ...)

## S4 method for signature 'AdbiResultArrow'
dbIsValid(dbObj, ...)

## S4 method for signature 'AdbiResultArrow'
show(object)

Arguments

res

An object inheriting from DBIResult.

params

For dbBind(), a list of values, named or unnamed, or a data frame, with one element/column per query parameter. For dbBindArrow(), values as a nanoarrow stream, with one column per query parameter.

...

Other arguments passed on to methods.

dbObj

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

object

Any R object

See Also

The corresponding generic functions DBI::dbFetchArrow(), DBI::dbFetchArrowChunk(), DBI::dbClearResult(), DBI::dbBind(), DBI::dbColumnInfo(), DBI::dbGetRowsAffected(), DBI::dbGetRowCount(), DBI::dbHasCompleted(), and DBI::dbGetStatement().


adbi documentation built on May 29, 2024, 7:12 a.m.