feat: Basic tests for the new db*Arrow() interface

.github/workflows/custom/after-install/action.yml

@@ -0,0 +1,24 @@
+name: 'Custom steps to run after R packages are installed'
+
+runs:
+  using: "composite"
+  steps:
+    # Must happen after R is installed...
+    - name: Define R CMD check error condition
+      run: |
+        if (packageVersion("arrow") < "8.0.0") {
+          message("Setting RCMDCHECK_ERROR_ON = error")
+          cat('RCMDCHECK_ERROR_ON="error"\n', file = Sys.getenv("GITHUB_ENV"), append = TRUE)
+        } else if (getRversion() < "3.5") {
+          message("Setting RCMDCHECK_ERROR_ON = warning")
+          cat('RCMDCHECK_ERROR_ON="warning"\n', file = Sys.getenv("GITHUB_ENV"), append = TRUE)
+        }
+      shell: Rscript {0}
+
+    - name: Define _R_CHECK_FORCE_SUGGESTS_
+      run: |
+        if (getRversion() < "3.5") {
+          message("Setting _R_CHECK_FORCE_SUGGESTS_")
+          cat('_R_CHECK_FORCE_SUGGESTS_=false\n', file = Sys.getenv("GITHUB_ENV"), append = TRUE)
+        }
+      shell: Rscript {0}

DESCRIPTION

@@ -18,10 +18,11 @@ Depends:
 Imports: 
     blob (>= 1.2.0),
     callr,
-    DBI (>= 1.1.3),
+    DBI (>= 1.1.3.9004),
     desc,
     hms (>= 0.5.0),
     lubridate,
+    magrittr,
     methods,
     palmerpenguins,
     R6,
@@ -31,18 +32,20 @@ Imports:
     vctrs,
     withr
 Suggests: 
+    arrow,
     clipr,
     dblog (>= 0.0.0.9008),
     debugme,
     devtools,
+    dplyr,
     knitr,
     lintr,
     rmarkdown,
     RSQLite
 VignetteBuilder: 
     knitr
 Remotes: 
-    r-dbi/dblog
+    r-dbi/DBI
 Additional_repositories: https://r-dbi.r-universe.dev
 Config/autostyle/scope: line_breaks
 Config/autostyle/strict: false
@@ -102,6 +105,15 @@ Collate:
     'spec-meta-get-rows-affected.R'
     'spec-transaction-begin-commit-rollback.R'
     'spec-transaction-with-transaction.R'
+    'spec-arrow-send-query-arrow.R'
+    'spec-arrow-fetch-arrow.R'
+    'spec-arrow-get-query-arrow.R'
+    'spec-arrow-read-table-arrow.R'
+    'spec-arrow-write-table-arrow.R'
+    'spec-arrow-create-table-arrow.R'
+    'spec-arrow-append-table-arrow.R'
+    'spec-arrow-bind.R'
+    'spec-arrow-roundtrip.R'
     'spec-driver-get-info.R'
     'spec-connection-get-info.R'
     'spec-sql-list-fields.R'
@@ -112,6 +124,7 @@ Collate:
     'spec-result.R'
     'spec-sql.R'
     'spec-meta.R'
+    'spec-arrow.R'
     'spec-transaction.R'
     'spec-compliance.R'
     'spec-stress-connection.R'
@@ -126,6 +139,7 @@ Collate:
     'test-sql.R'
     'test-meta.R'
     'test-transaction.R'
+    'test-arrow.R'
     'test-compliance.R'
     'test-stress.R'
     'tweaks.R'

NAMESPACE

@@ -7,6 +7,7 @@ export(get_default_context)
 export(make_context)
 export(set_default_context)
 export(test_all)
+export(test_arrow)
 export(test_compliance)
 export(test_connection)
 export(test_driver)
@@ -18,50 +19,11 @@ export(test_sql)
 export(test_stress)
 export(test_transaction)
 export(tweaks)
+import(DBI)
 import(testthat)
-importFrom(DBI,Id)
-importFrom(DBI,SQL)
-importFrom(DBI,dbAppendTable)
-importFrom(DBI,dbBegin)
-importFrom(DBI,dbBind)
-importFrom(DBI,dbBreak)
-importFrom(DBI,dbCallProc)
-importFrom(DBI,dbClearResult)
-importFrom(DBI,dbColumnInfo)
-importFrom(DBI,dbCommit)
-importFrom(DBI,dbConnect)
-importFrom(DBI,dbCreateTable)
-importFrom(DBI,dbDataType)
-importFrom(DBI,dbDisconnect)
-importFrom(DBI,dbExecute)
-importFrom(DBI,dbExistsTable)
-importFrom(DBI,dbFetch)
-importFrom(DBI,dbGetDBIVersion)
-importFrom(DBI,dbGetInfo)
-importFrom(DBI,dbGetQuery)
-importFrom(DBI,dbGetRowCount)
-importFrom(DBI,dbGetRowsAffected)
-importFrom(DBI,dbGetStatement)
-importFrom(DBI,dbHasCompleted)
-importFrom(DBI,dbIsValid)
-importFrom(DBI,dbListConnections)
-importFrom(DBI,dbListFields)
-importFrom(DBI,dbListObjects)
-importFrom(DBI,dbListTables)
-importFrom(DBI,dbQuoteIdentifier)
-importFrom(DBI,dbQuoteLiteral)
-importFrom(DBI,dbQuoteString)
-importFrom(DBI,dbReadTable)
-importFrom(DBI,dbRemoveTable)
-importFrom(DBI,dbRollback)
-importFrom(DBI,dbSendQuery)
-importFrom(DBI,dbSendStatement)
-importFrom(DBI,dbSetDataMappings)
-importFrom(DBI,dbUnquoteIdentifier)
-importFrom(DBI,dbWithTransaction)
-importFrom(DBI,dbWriteTable)
 importFrom(callr,r)
 importFrom(lubridate,with_tz)
+importFrom(magrittr,"%>%")
 importFrom(methods,extends)
 importFrom(methods,findMethod)
 importFrom(methods,getClass)

R/dbi.R

@@ -36,13 +36,13 @@ dbi_generics <- function(version) {
 
   if (version < "1.7.4") {
     generics <- setdiff(generics, c(
-      "dbGetStream",
-      "dbAppendStream",
-      "dbStream",
-      "dbWriteStream",
-      "dbSendQueryStream",
-      "dbStreamTable",
-      "dbCreateFromStream"
+      "dbGetQueryArrow",
+      "dbAppendTableArrow",
+      "dbFetchArrow",
+      "dbWriteTableArrow",
+      "dbSendQueryArrow",
+      "dbReadTableArrow",
+      "dbCreateTableArrow"
     ))
   }
 

R/expectations.R

@@ -80,6 +80,10 @@ expect_equal_df <- function(actual, expected) {
   expect_identical(actual, expected)
 }
 
+expect_equal_arrow <- function(actual, expected) {
+  expect_equal_df(as.data.frame(actual), as.data.frame(expected))
+}
+
 skip_if_not_dbitest <- function(ctx, version) {
   if (as.package_version(ctx$tweaks$dbitest_version) < version) {
     skip(paste0("tweak: dbitest_version: required: ", version, ", available: ", ctx$tweaks$dbitest_version))

R/generics.R

@@ -2,28 +2,29 @@
 all_dbi_generics <- function() {
   c(
     "Id",
-    "dbAppendStream",
     "dbAppendTable",
+    "dbAppendTableArrow",
     "dbBegin",
     "dbBind",
     "dbCanConnect",
     "dbClearResult",
     "dbColumnInfo",
     "dbCommit",
     "dbConnect",
-    "dbCreateFromStream",
     "dbCreateTable",
+    "dbCreateTableArrow",
     "dbDataType",
     "dbDisconnect",
     "dbExecute",
     "dbExistsTable",
     "dbFetch",
+    "dbFetchArrow",
     "dbGetInfo",
     "dbGetQuery",
+    "dbGetQueryArrow",
     "dbGetRowCount",
     "dbGetRowsAffected",
     "dbGetStatement",
-    "dbGetStream",
     "dbHasCompleted",
     "dbIsReadOnly",
     "dbIsValid",
@@ -34,17 +35,16 @@ all_dbi_generics <- function() {
     "dbQuoteLiteral",
     "dbQuoteString",
     "dbReadTable",
+    "dbReadTableArrow",
     "dbRemoveTable",
     "dbRollback",
     "dbSendQuery",
-    "dbSendQueryStream",
+    "dbSendQueryArrow",
     "dbSendStatement",
-    "dbStream",
-    "dbStreamTable",
     "dbUnquoteIdentifier",
     "dbWithTransaction",
-    "dbWriteStream",
     "dbWriteTable",
+    "dbWriteTableArrow",
     NULL
   )
 }

R/import-dbi.R

@@ -1,13 +1,2 @@
-# The imports below were generated using the following call:
-# @import.gen::importFrom("DBI")
-#' @importFrom DBI dbAppendTable dbBegin dbBind dbBreak dbCallProc dbClearResult dbColumnInfo
-#' @importFrom DBI dbCommit dbConnect dbCreateTable dbDataType dbDisconnect
-#' @importFrom DBI dbExecute dbExistsTable dbFetch dbGetDBIVersion
-#' @importFrom DBI dbGetInfo dbGetQuery dbGetRowCount dbGetRowsAffected
-#' @importFrom DBI dbGetStatement dbHasCompleted dbIsValid
-#' @importFrom DBI dbListConnections dbListFields dbListObjects dbListTables
-#' @importFrom DBI dbQuoteIdentifier dbQuoteLiteral dbQuoteString dbReadTable dbRemoveTable
-#' @importFrom DBI dbRollback dbSendQuery dbSendStatement dbSetDataMappings
-#' @importFrom DBI dbUnquoteIdentifier dbWithTransaction dbWriteTable
-#' @importFrom DBI Id SQL
+#' @import DBI
 NULL

R/import-testthat.R

@@ -7,4 +7,5 @@ NULL
 #' @importFrom methods findMethod getClasses getClass extends
 #' @importFrom stats setNames
 #' @importFrom utils head
+#' @importFrom magrittr %>%
 NULL

R/spec-.R

@@ -1,7 +1,7 @@
 # reverse order
 
 # Script to create new spec files from subspec names read from clipboard:
-# xclip -out -se c | sed 's/,//' | for i in $(cat); do f=$(echo $i | sed 's/_/-/g;s/$/.R/'); echo "$i <- list(" > R/$f; echo ")" >> R/$f; echo "#' @include $f"; done | tac
+# pbpaste | gsed 's/,//' | for i in $(cat); do f=$(echo $i | gsed 's/_/-/g;s/$/.R/'); echo "$i <- list(" > R/$f; echo ")" >> R/$f; echo "#' @include $f"; done | tac | pbcopy
 #
 # Example input:
 # test_xxx_1,
@@ -17,6 +17,7 @@
 ##### Aggregators
 #' @include spec-compliance.R
 #' @include spec-transaction.R
+#' @include spec-arrow.R
 #' @include spec-meta.R
 #' @include spec-sql.R
 #' @include spec-result.R
@@ -28,6 +29,16 @@
 #' @include spec-sql-list-fields.R
 #' @include spec-connection-get-info.R
 #' @include spec-driver-get-info.R
+##### Arrow
+#' @include spec-arrow-roundtrip.R
+#' @include spec-arrow-bind.R
+#' @include spec-arrow-append-table-arrow.R
+#' @include spec-arrow-create-table-arrow.R
+#' @include spec-arrow-write-table-arrow.R
+#' @include spec-arrow-read-table-arrow.R
+#' @include spec-arrow-get-query-arrow.R
+#' @include spec-arrow-fetch-arrow.R
+#' @include spec-arrow-send-query-arrow.R
 ##### Method specs
 #' @include spec-transaction-with-transaction.R
 #' @include spec-transaction-begin-commit-rollback.R

R/spec-all.R

@@ -6,6 +6,7 @@ spec_all <- c(
   spec_sql,
   spec_meta,
   spec_transaction,
+  spec_arrow,
   spec_compliance,
   spec_stress
 )