dbCreateTableArrow

r-dbi · Dec 23, 2023 · f846693 · f846693
1 parent d6e0b45
commit f846693
Show file tree

Hide file tree

Showing 27 changed files with 198 additions and 12 deletions.
diff --git a/R/12-dbCreateTable.R b/R/12-dbCreateTable.R
@@ -2,6 +2,8 @@
 #'
 #' The default `dbCreateTable()` method calls [sqlCreateTable()] and
 #' [dbExecute()].
+#' Use [dbCreateTableArrow()] to create a table from an Arrow schema.
+#'
 #' Backends compliant to ANSI SQL 99 don't need to override it.
 #' Backends with a different SQL syntax can override `sqlCreateTable()`,
 #' backends with entirely different ways to create tables need to

diff --git a/R/22-dbCreateTableArrow.R b/R/22-dbCreateTableArrow.R
@@ -1,7 +1,34 @@
-#' @name dbCreateTable
-#' @aliases dbCreateTableArrow
-#' @param value An object coercible to an Arrow RecordBatchReader.
+#' Create a table in the database based on an Arrow object
+#'
+#' The default `dbCreateTableArrow()` method determines the R data types
+#' of the Arrow schema associated with the Arrow object,
+#' and calls [dbCreateTable()].
+#' Backends who implement [dbAppendTableArrow()] should typically
+#' also implement this generic.
+#' Use [dbCreateTable()] to create a table from the column types
+#' as defined in a data frame.
+#'
+#' @param value An object for which a schema can be determined via
+#'   [nanoarrow::infer_nanoarrow_schema()].
+#' @inheritParams dbReadTable
+#' @inheritParams sqlCreateTable
+#'
+#' @inherit DBItest::spec_arrow_create_table_arrow return
+#' @inheritSection DBItest::spec_arrow_create_table_arrow Failure modes
+#' @inheritSection DBItest::spec_arrow_create_table_arrow Additional arguments
+#' @inheritSection DBItest::spec_arrow_create_table_arrow Specification
+#'
+#' @template methods
+#' @templateVar method_name dbCreateTableArrow
+#'
+#' @family DBIConnection generics
 #' @export
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE)
+#' con <- dbConnect(RSQLite::SQLite(), ":memory:")
+#' ptype <- data.frame(a = numeric())
+#' dbCreateTableArrow(con, "df", nanoarrow::infer_nanoarrow_schema(ptype))
+#' dbReadTable(con, "df")
+#' dbDisconnect(con)
 setGeneric("dbCreateTableArrow",
   def = function(conn, name, value, ...) standardGeneric("dbCreateTableArrow")
 )
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -82,6 +82,7 @@ reference:
   contents:
   - dbReadTableArrow
   - dbWriteTableArrow
+  - dbCreateTableArrow
 
 - title: Classes
   desc: S4 classes defined by DBI.

diff --git a/man/DBIConnection-class.Rd b/man/DBIConnection-class.Rd
diff --git a/man/dbAppendTable.Rd b/man/dbAppendTable.Rd
diff --git a/man/dbCreateTable.Rd b/man/dbCreateTable.Rd
diff --git a/man/dbCreateTableArrow.Rd b/man/dbCreateTableArrow.Rd
diff --git a/man/dbDataType.Rd b/man/dbDataType.Rd
diff --git a/man/dbDisconnect.Rd b/man/dbDisconnect.Rd
diff --git a/man/dbExecute.Rd b/man/dbExecute.Rd
diff --git a/man/dbExistsTable.Rd b/man/dbExistsTable.Rd
diff --git a/man/dbGetException.Rd b/man/dbGetException.Rd
diff --git a/man/dbGetInfo.Rd b/man/dbGetInfo.Rd
diff --git a/man/dbGetQuery.Rd b/man/dbGetQuery.Rd
diff --git a/man/dbIsReadOnly.Rd b/man/dbIsReadOnly.Rd
diff --git a/man/dbIsValid.Rd b/man/dbIsValid.Rd
diff --git a/man/dbListFields.Rd b/man/dbListFields.Rd
diff --git a/man/dbListObjects.Rd b/man/dbListObjects.Rd
diff --git a/man/dbListResults.Rd b/man/dbListResults.Rd
diff --git a/man/dbListTables.Rd b/man/dbListTables.Rd
diff --git a/man/dbReadTable.Rd b/man/dbReadTable.Rd
diff --git a/man/dbReadTableArrow.Rd b/man/dbReadTableArrow.Rd
diff --git a/man/dbRemoveTable.Rd b/man/dbRemoveTable.Rd
diff --git a/man/dbSendQuery.Rd b/man/dbSendQuery.Rd