Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: New dbFetchArrowChunk() generic with different semantics #424

Merged
merged 4 commits into from Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions NAMESPACE
Expand Up @@ -28,6 +28,7 @@ export(dbExecute)
export(dbExistsTable)
export(dbFetch)
export(dbFetchArrow)
export(dbFetchArrowChunk)
export(dbGetConnectArgs)
export(dbGetDBIVersion)
export(dbGetException)
Expand Down Expand Up @@ -98,6 +99,7 @@ exportMethods(dbExecute)
exportMethods(dbExistsTable)
exportMethods(dbFetch)
exportMethods(dbFetchArrow)
exportMethods(dbFetchArrowChunk)
exportMethods(dbGetConnectArgs)
exportMethods(dbGetInfo)
exportMethods(dbGetQuery)
Expand Down
5 changes: 5 additions & 0 deletions R/dbFetchArrowChunk.R
@@ -0,0 +1,5 @@
#' @rdname dbFetch
#' @export
setGeneric("dbFetchArrowChunk",
def = function(res, ...) standardGeneric("dbFetchArrowChunk")
)
10 changes: 10 additions & 0 deletions R/dbFetchArrowChunk_DBIResultArrow.R
@@ -0,0 +1,10 @@
#' @rdname hidden_aliases
#' @usage NULL
dbFetchArrowChunk_DBIResultArrow <- function(res, ...) {
nanoarrow::as_nanoarrow_array(
dbFetch(res@result, n = 256, ...)
)
}
#' @rdname hidden_aliases
#' @export
setMethod("dbFetchArrowChunk", signature("DBIResultArrow"), dbFetchArrowChunk_DBIResultArrow)
18 changes: 15 additions & 3 deletions R/dbFetchArrow_DBIResultArrow.R
@@ -1,10 +1,22 @@
#' @rdname hidden_aliases
#' @usage NULL
dbFetchArrow_DBIResultArrow <- function(res, ...) {
nanoarrow::as_nanoarrow_array_stream(
dbFetch(res@result, n = -1, ...)
)
chunk <- dbFetchArrowChunk_DBIResultArrow(res)
out <- list(chunk)
# Corner case: add empty chunk only for zero rows, for schema
if (chunk$length == 0) {
return(nanoarrow::basic_array_stream(out, validate = FALSE))
}

repeat {
chunk <- dbFetchArrowChunk_DBIResultArrow(res)
if (chunk$length == 0) {
return(nanoarrow::basic_array_stream(out, validate = FALSE))
}
out <- c(out, list(chunk))
}
}

#' @rdname hidden_aliases
#' @export
setMethod("dbFetchArrow", signature("DBIResultArrow"), dbFetchArrow_DBIResultArrow)
7 changes: 3 additions & 4 deletions R/dbSendQueryArrow_DBIConnection.R
Expand Up @@ -5,10 +5,9 @@ dbSendQueryArrow_DBIConnection <- function(conn, statement, params = NULL, ...)
params <- as.data.frame(params)
}

new(
"DBIResultArrowDefault",
result = dbSendQuery(conn, statement, params = params, ...)
)
result <- dbSendQuery(conn, statement, params = params, ...)

new("DBIResultArrowDefault", result = result)
}
#' @rdname hidden_aliases
#' @export
Expand Down
6 changes: 5 additions & 1 deletion man/dbFetch.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 13 additions & 8 deletions man/hidden_aliases.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions vignettes/DBI-arrow.Rmd
Expand Up @@ -57,6 +57,7 @@ Apache Arrow is
- `dbGetQueryArrow()`
- `dbSendQueryArrow()`
- `dbFetchArrow()`
- `dbFetchArrowChunk()`
- `dbWriteTableArrow()`

- New classes:
Expand Down