Skip to contents

Streaming Arrow result for queries on DuckDB connections. Implements DBIResultArrow-class.

Usage

# S4 method for class 'duckdb_result_arrow'
dbBind(res, params, ...)

# S4 method for class 'duckdb_result_arrow'
dbBindArrow(res, params, ...)

# S4 method for class 'duckdb_result_arrow'
dbClearResult(res, ...)

# S4 method for class 'duckdb_result_arrow'
dbColumnInfo(res, ...)

# S4 method for class 'duckdb_result_arrow'
dbFetchArrow(res, ..., chunk_size = 1e+06)

# S4 method for class 'duckdb_result_arrow'
dbFetchArrowChunk(res, ..., chunk_size = 1e+06)

# S4 method for class 'duckdb_result_arrow'
dbGetRowCount(res, ...)

# S4 method for class 'duckdb_result_arrow'
dbGetRowsAffected(res, ...)

# S4 method for class 'duckdb_result_arrow'
dbGetStatement(res, ...)

# S4 method for class 'duckdb_result_arrow'
dbHasCompleted(res, ...)

# S4 method for class 'duckdb_result_arrow'
dbIsValid(dbObj, ...)

# S4 method for class 'duckdb_result_arrow'
show(object)

Arguments

res

An object inheriting from DBI::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.

chunk_size

The chunk size in rows used when pulling Arrow batches from DuckDB.

dbObj

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

object

Any R object

Slots

connection

the duckdb_connection the query was executed on.

stmt_lst

internal list describing the prepared statement.

env

environment holding the result's mutable fetch state.