dbAppendTableArrow

R/11-dbAppendTable.R

@@ -3,7 +3,10 @@
 #' The `dbAppendTable()` method assumes that the table has been created
 #' beforehand, e.g. with [dbCreateTable()].
 #' The default implementation calls [sqlAppendTableTemplate()] and then
-#' [dbExecute()] with the `param` argument. Backends compliant to
+#' [dbExecute()] with the `param` argument.
+#' Use [dbAppendTableArrow()] to append data from an Arrow stream.
+#'
+#' Backends compliant to
 #' ANSI SQL 99 which use `?` as a placeholder for prepared queries don't need
 #' to override it. Backends with a different SQL syntax which use `?`
 #' as a placeholder for prepared queries can override [sqlAppendTable()].
@@ -14,8 +17,7 @@
 #' Process the values with [sqlRownamesToColumn()] before calling this method.
 #'
 #' @inheritParams dbReadTable
-#' @param value For `dbAppendTable()`, a [data.frame] (or coercible to data.frame).
-#'   For `dbAppendTableArrow()`, an object coercible to an Arrow RecordBatchReader.
+#' @param value A [data.frame] (or coercible to data.frame).
 #' @param row.names Must be `NULL`.
 #' @inheritParams sqlAppendTableTemplate
 #'

R/21-dbAppendTableArrow.R

@@ -1,6 +1,30 @@
-#' @name dbAppendTable
-#' @aliases dbAppendTableArrow
+#' Insert rows into a table from an Arrow stream
+#'
+#' The `dbAppendTableArrow()` method assumes that the table has been created
+#' beforehand, e.g. with [dbCreateTableArrow()].
+#' The default implementation calls [dbAppendTable()] for each chunk
+#' of the stream.
+#' Use [dbAppendTable()] to append data from a data.frame.
+#'
+#' @inheritParams dbReadTable
+#' @param value An object coercible with [nanoarrow::as_nanoarrow_array_stream()].
+#' @inheritParams sqlAppendTableTemplate
+#'
+#' @template methods
+#' @templateVar method_name dbAppendTableArrow
+#'
+#' @inherit DBItest::spec_arrow_append_table_arrow return
+#' @inheritSection DBItest::spec_arrow_append_table_arrow Failure modes
+#' @inheritSection DBItest::spec_arrow_append_table_arrow Specification
+#'
+#' @family DBIConnection generics
 #' @export
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE)
+#' con <- dbConnect(RSQLite::SQLite(), ":memory:")
+#' dbCreateTableArrow(con, "iris", iris[0, ])
+#' dbAppendTableArrow(con, "iris", iris[1:5, ])
+#' dbReadTable(con, "iris")
+#' dbDisconnect(con)
 setGeneric("dbAppendTableArrow",
   def = function(conn, name, value, ...) standardGeneric("dbAppendTableArrow")
 )

_pkgdown.yml

@@ -83,6 +83,7 @@ reference:
   - dbReadTableArrow
   - dbWriteTableArrow
   - dbCreateTableArrow
+  - dbAppendTableArrow
 
 - title: Classes
   desc: S4 classes defined by DBI.