DBIResultArrow

R/07-DBIResultArrow.R

@@ -1,8 +1,24 @@
-#' @rdname DBIResult-class
+#' DBIResultArrow class
+#'
+#' This virtual class describes the result and state of execution of
+#' a DBMS statement (any statement, query or non-query)
+#' for returning data as an Arrow object.
+#'
+#' @section Implementation notes:
+#' Individual drivers are free to allow single or multiple
+#' active results per connection.
+#'
+#' The default show method displays a summary of the query using other
+#' DBI generics.
+#'
+#' @name DBIResultArrow-class
+#' @docType class
+#' @family DBI classes
+#' @family DBIResultArrow generics
 #' @export
 setClass("DBIResultArrow", contains = c("DBIObject", "VIRTUAL"))
 
-#' @rdname DBIResult-class
+#' @rdname DBIResultArrow-class
 #' @export
 setClass("DBIResultArrowDefault",
   contains = "DBIResultArrow",

R/15-dbBind.R

@@ -142,6 +142,7 @@
 #'   For `dbBindArrow()`, values as a nanoarrow stream,
 #'   with one column per query parameter.
 #' @family DBIResult generics
+#' @family DBIResultArrow generics
 #' @family data retrieval generics
 #' @family command execution generics
 #' @export

R/dbClearResult.R

@@ -17,6 +17,7 @@
 #' @param res An object inheriting from [DBIResult-class].
 #' @param ... Other arguments passed on to methods.
 #' @family DBIResult generics
+#' @family DBIResultArrow generics
 #' @family data retrieval generics
 #' @family command execution generics
 #' @export

R/dbFetchArrow.R

@@ -20,7 +20,7 @@
 #' @param ... Other arguments passed on to methods.
 #' @seealso Close the result set with [dbClearResult()] as soon as you
 #'   finish retrieving the records you want.
-#' @family DBIResult generics
+#' @family DBIResultArrow generics
 #' @family data retrieval generics
 #' @export
 #' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE)

R/dbFetchArrowChunk.R

@@ -21,7 +21,7 @@
 #' @param ... Other arguments passed on to methods.
 #' @seealso Close the result set with [dbClearResult()] as soon as you
 #'   finish retrieving the records you want.
-#' @family DBIResult generics
+#' @family DBIResultArrow generics
 #' @family data retrieval generics
 #' @export
 #' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE)

R/dbHasCompleted.R

@@ -15,6 +15,7 @@
 #'
 #' @inheritParams dbClearResult
 #' @family DBIResult generics
+#' @family DBIResultArrow generics
 #' @family data retrieval generics
 #' @export
 #' @examplesIf requireNamespace("RSQLite", quietly = TRUE)

R/dbIsValid.R

@@ -12,6 +12,7 @@
 #' @family DBIDriver generics
 #' @family DBIConnection generics
 #' @family DBIResult generics
+#' @family DBIResultArrow generics
 #' @export
 #' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' dbIsValid(RSQLite::SQLite())

R/dbQuoteIdentifier.R

@@ -16,7 +16,7 @@
 #' @inheritSection DBItest::spec_sql_quote_identifier Failure modes
 #' @inheritSection DBItest::spec_sql_quote_identifier Specification
 #'
-#' @family DBIResult generics
+#' @family DBIConnection generics
 #' @export
 #' @examples
 #' # Quoting ensures that arbitrary input is safe for use in a query

R/dbUnquoteIdentifier.R

@@ -14,7 +14,7 @@
 #' @inheritSection DBItest::spec_sql_unquote_identifier Failure modes
 #' @inheritSection DBItest::spec_sql_unquote_identifier Specification
 #'
-#' @family DBIResult generics
+#' @family DBIConnection generics
 #' @export
 #' @examples
 #' # Unquoting allows to understand the structure of a

_pkgdown.yml

@@ -98,6 +98,7 @@ reference:
   - DBIDriver-class
   - DBIConnection-class
   - DBIResult-class
+  - DBIResultArrow-class
   - DBIConnector-class
   - Id-class