GH-44069: [Docs][R] Add note to to_arrow() docs about collect/compute (…

…#44094) ### Rationale for this change Improves the documentation for the `to_arrow()` function for the use case referenced in #44069. ### What changes are included in this PR? Just docs. ### Are these changes tested? Yes. Built and tested locally. ### Are there any user-facing changes? Just docs. * GitHub Issue: #44069 Authored-by: Bryce Mecum <[email protected]> Signed-off-by: Nic Crane <[email protected]>
apache · Sep 14, 2024 · 41c481f · 41c481f
1 parent 3eb4135
commit 41c481f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/r/R/duckdb.R b/r/R/duckdb.R
@@ -137,7 +137,13 @@ duckdb_disconnector <- function(con, tbl_name) {
 
 #' Create an Arrow object from a DuckDB connection
 #'
-#' This can be used in pipelines that pass data back and forth between Arrow and DuckDB
+#' This can be used in pipelines that pass data back and forth between Arrow and
+#' DuckDB.
+#'
+#' Note that you can only call `collect()` or `compute()` on the result of this
+#' function once. To work around this limitation, you should either only call
+#' `collect()` as the final step in a pipeline or call `as_arrow_table()` on the
+#' result to materialize the entire Table in-memory.
 #'
 #' @param .data the object to be converted
 #' @return A `RecordBatchReader`.

diff --git a/r/man/to_arrow.Rd b/r/man/to_arrow.Rd