duckdb_result-class: DuckDB Result Set

Description Usage Arguments

Description

Methods for accessing result sets for queries on DuckDB connections. Implements DBIResult.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
## S4 method for signature 'duckdb_result'
show(object)

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

duckdb_fetch_arrow(
  res,
  stream = FALSE,
  vector_per_chunk = 1,
  return_table = FALSE
)

duckdb_fetch_record_batch(res, approx_batch_size = 1)

## S4 method for signature 'duckdb_result'
dbFetch(res, n = -1, ...)

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

## S4 method for signature 'duckdb_result'
dbGetInfo(dbObj, ...)

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

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

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

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

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

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

Arguments

object

Any R object

res

Query result to be converted to an Arrow Table

...

Other arguments passed on to methods.

stream

If we are streaming the query result or returning it all at once

vector_per_chunk

If streaming, how many vectors per chunk we should emit

return_table

If we return results as a list of RecordBatches or an Arrow Table

n

maximum number of records to retrieve per fetch. Use n = -1 or n = Inf to retrieve all pending records. Some implementations may recognize other special values.

dbObj

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

params

A list of bindings, named or unnamed.


duckdb documentation built on Nov. 22, 2021, 5:07 p.m.