From 310308252f19e14a7af31935317c44a6c647fb0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Sun, 24 Dec 2023 19:31:11 +0100 Subject: [PATCH 1/3] dbReadTableArrow --- R/spec-arrow-read-table-arrow.R | 4 ++-- man/spec_arrow_read_table_arrow.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/spec-arrow-read-table-arrow.R b/R/spec-arrow-read-table-arrow.R index 0f8870441..390e8a85e 100644 --- a/R/spec-arrow-read-table-arrow.R +++ b/R/spec-arrow-read-table-arrow.R @@ -14,7 +14,7 @@ spec_arrow_read_table_arrow <- list( skip_if_not_dbitest(ctx, "1.7.99.2") #' @return - #' `dbReadTableArrow()` returns a data frame that contains the complete data + #' `dbReadTableArrow()` returns an Arrow object that contains the complete data #' from the remote table, effectively the result of calling [dbGetQueryArrow()] #' with `SELECT * FROM `. penguins_in <- get_penguins(ctx) @@ -35,7 +35,7 @@ spec_arrow_read_table_arrow <- list( skip("Causes segfault in adbc and duckdb") #' @return - #' An empty table is returned as a data frame with zero rows. + #' An empty table is returned as an Arrow object with zero rows. penguins_in <- get_penguins(ctx)[integer(), ] dbWriteTable(con, table_name, penguins_in) penguins_out <- check_arrow(dbReadTableArrow(con, table_name)) diff --git a/man/spec_arrow_read_table_arrow.Rd b/man/spec_arrow_read_table_arrow.Rd index 04f005bd7..b797681e8 100644 --- a/man/spec_arrow_read_table_arrow.Rd +++ b/man/spec_arrow_read_table_arrow.Rd @@ -5,11 +5,11 @@ \alias{spec_arrow_read_table_arrow} \title{spec_arrow_read_table_arrow} \value{ -\code{dbReadTableArrow()} returns a data frame that contains the complete data +\code{dbReadTableArrow()} returns an Arrow object that contains the complete data from the remote table, effectively the result of calling \code{\link[=dbGetQueryArrow]{dbGetQueryArrow()}} with \verb{SELECT * FROM }. -An empty table is returned as a data frame with zero rows. +An empty table is returned as an Arrow object with zero rows. } \description{ spec_arrow_read_table_arrow From d06ba912a24e202259bcda821d2418f7f931ebb8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Sun, 24 Dec 2023 20:23:15 +0100 Subject: [PATCH 2/3] Formatting? --- R/spec-arrow-get-query-arrow.R | 4 ++-- R/spec-result-get-query.R | 4 ++-- man/spec_arrow_get_query_arrow.Rd | 4 ++-- man/spec_result_get_query.Rd | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/R/spec-arrow-get-query-arrow.R b/R/spec-arrow-get-query-arrow.R index 7a3c8031b..e4acff691 100644 --- a/R/spec-arrow-get-query-arrow.R +++ b/R/spec-arrow-get-query-arrow.R @@ -11,8 +11,8 @@ spec_arrow_get_query_arrow <- list( arrow_get_query_arrow_atomic = function(con) { #' @return - #' `dbGetQueryArrow()` always returns an object coercible to a [data.frame] - #' with as many rows as records were fetched and as many + #' `dbGetQueryArrow()` always returns an object coercible to a [data.frame], with + #' as many rows as records were fetched and as many #' columns as fields in the result set, #' even if the result is a single value query <- trivial_query() diff --git a/R/spec-result-get-query.R b/R/spec-result-get-query.R index 5c28d2889..1b03e5bae 100644 --- a/R/spec-result-get-query.R +++ b/R/spec-result-get-query.R @@ -11,8 +11,8 @@ spec_result_get_query <- list( get_query_atomic = function(con) { #' @return - #' `dbGetQuery()` always returns a [data.frame] - #' with as many rows as records were fetched and as many + #' `dbGetQuery()` always returns a [data.frame], with + #' as many rows as records were fetched and as many #' columns as fields in the result set, #' even if the result is a single value query <- trivial_query() diff --git a/man/spec_arrow_get_query_arrow.Rd b/man/spec_arrow_get_query_arrow.Rd index eb98cf7f2..9ca08a479 100644 --- a/man/spec_arrow_get_query_arrow.Rd +++ b/man/spec_arrow_get_query_arrow.Rd @@ -5,8 +5,8 @@ \alias{spec_arrow_get_query_arrow} \title{spec_arrow_get_query_arrow} \value{ -\code{dbGetQueryArrow()} always returns an object coercible to a \link{data.frame} -with as many rows as records were fetched and as many +\code{dbGetQueryArrow()} always returns an object coercible to a \link{data.frame}, with +as many rows as records were fetched and as many columns as fields in the result set, even if the result is a single value or has one diff --git a/man/spec_result_get_query.Rd b/man/spec_result_get_query.Rd index 7f9fdd2ee..56dbb0a4b 100644 --- a/man/spec_result_get_query.Rd +++ b/man/spec_result_get_query.Rd @@ -5,8 +5,8 @@ \alias{spec_result_get_query} \title{spec_result_get_query} \value{ -\code{dbGetQuery()} always returns a \link{data.frame} -with as many rows as records were fetched and as many +\code{dbGetQuery()} always returns a \link{data.frame}, with +as many rows as records were fetched and as many columns as fields in the result set, even if the result is a single value or has one From f440b6ac2d7ce2d4636663020c0602d4ff086aeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Sun, 24 Dec 2023 20:33:37 +0100 Subject: [PATCH 3/3] Avoid link at EOL --- R/spec-arrow-append-table-arrow.R | 4 ++-- R/spec-arrow-create-table-arrow.R | 4 ++-- R/spec-arrow-fetch-arrow-chunk.R | 4 ++-- R/spec-arrow-fetch-arrow.R | 4 ++-- R/spec-arrow-read-table-arrow.R | 8 ++++---- R/spec-arrow-write-table-arrow.R | 4 ++-- R/spec-driver-constructor.R | 3 +-- R/spec-driver-data-type.R | 4 ++-- R/spec-meta-bind-expr.R | 4 ++-- R/spec-meta-get-statement.R | 4 ++-- R/spec-result-fetch.R | 12 ++++++------ R/spec-sql-append-table.R | 4 ++-- R/spec-sql-create-table.R | 4 ++-- R/spec-sql-exists-table.R | 4 ++-- R/spec-sql-list-objects.R | 4 ++-- R/spec-sql-list-tables.R | 4 ++-- R/spec-sql-read-table.R | 4 ++-- R/spec-sql-remove-table.R | 4 ++-- R/spec-sql-unquote-identifier.R | 4 ++-- R/spec-sql-write-table.R | 4 ++-- man/spec_arrow_append_table_arrow.Rd | 4 ++-- man/spec_arrow_create_table_arrow.Rd | 4 ++-- man/spec_arrow_fetch_arrow.Rd | 4 ++-- man/spec_arrow_fetch_arrow_chunk.Rd | 4 ++-- man/spec_arrow_read_table_arrow.Rd | 8 ++++---- man/spec_arrow_write_table_arrow.Rd | 4 ++-- man/spec_driver_constructor.Rd | 3 +-- man/spec_driver_data_type.Rd | 4 ++-- man/spec_meta_bind.Rd | 4 ++-- man/spec_meta_get_statement.Rd | 4 ++-- man/spec_result_fetch.Rd | 12 ++++++------ man/spec_sql_append_table.Rd | 4 ++-- man/spec_sql_create_table.Rd | 4 ++-- man/spec_sql_exists_table.Rd | 4 ++-- man/spec_sql_list_objects.Rd | 4 ++-- man/spec_sql_list_tables.Rd | 4 ++-- man/spec_sql_read_table.Rd | 4 ++-- man/spec_sql_remove_table.Rd | 4 ++-- man/spec_sql_unquote_identifier.Rd | 4 ++-- man/spec_sql_write_table.Rd | 4 ++-- man/test_data_type.Rd | 4 ++-- 41 files changed, 92 insertions(+), 94 deletions(-) diff --git a/R/spec-arrow-append-table-arrow.R b/R/spec-arrow-append-table-arrow.R index 62be50ef7..7139d9b91 100644 --- a/R/spec-arrow-append-table-arrow.R +++ b/R/spec-arrow-append-table-arrow.R @@ -67,9 +67,9 @@ spec_arrow_append_table_arrow <- list( arrow_append_table_arrow_error = function(con, table_name) { #' An error is also raised test_in <- stream_frame(a = 1L) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbAppendTableArrow(con, NA, test_in)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbAppendTableArrow(con, c("test", "test"), test_in)) }, diff --git a/R/spec-arrow-create-table-arrow.R b/R/spec-arrow-create-table-arrow.R index 0a88c3a01..0958d50ec 100644 --- a/R/spec-arrow-create-table-arrow.R +++ b/R/spec-arrow-create-table-arrow.R @@ -45,9 +45,9 @@ spec_arrow_create_table_arrow <- list( arrow_create_table_arrow_error = function(ctx, con, table_name) { #' An error is also raised test_in <- stream_frame(a = 1L) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbCreateTableArrow(con, NA, test_in)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbCreateTableArrow(con, c(table_name, table_name), test_in)) #' Invalid values for the `temporary` argument diff --git a/R/spec-arrow-fetch-arrow-chunk.R b/R/spec-arrow-fetch-arrow-chunk.R index 64418d101..17261ac22 100644 --- a/R/spec-arrow-fetch-arrow-chunk.R +++ b/R/spec-arrow-fetch-arrow-chunk.R @@ -11,8 +11,8 @@ spec_arrow_fetch_arrow_chunk <- list( arrow_fetch_arrow_chunk_atomic = function(con) { #' @return - #' `dbFetchArrowChunk()` always returns an object coercible to a [data.frame] - #' with as many rows as records were fetched and as many + #' `dbFetchArrowChunk()` always returns an object coercible to a [data.frame] with + #' as many rows as records were fetched and as many #' columns as fields in the result set, #' even if the result is a single value query <- trivial_query() diff --git a/R/spec-arrow-fetch-arrow.R b/R/spec-arrow-fetch-arrow.R index 8353b2f03..1cbb5738d 100644 --- a/R/spec-arrow-fetch-arrow.R +++ b/R/spec-arrow-fetch-arrow.R @@ -11,8 +11,8 @@ spec_arrow_fetch_arrow <- list( arrow_fetch_arrow_atomic = function(con) { #' @return - #' `dbFetchArrow()` always returns an object coercible to a [data.frame] - #' with as many rows as records were fetched and as many + #' `dbFetchArrow()` always returns an object coercible to a [data.frame] with + #' as many rows as records were fetched and as many #' columns as fields in the result set, #' even if the result is a single value query <- trivial_query() diff --git a/R/spec-arrow-read-table-arrow.R b/R/spec-arrow-read-table-arrow.R index 390e8a85e..b6d838544 100644 --- a/R/spec-arrow-read-table-arrow.R +++ b/R/spec-arrow-read-table-arrow.R @@ -15,8 +15,8 @@ spec_arrow_read_table_arrow <- list( #' @return #' `dbReadTableArrow()` returns an Arrow object that contains the complete data - #' from the remote table, effectively the result of calling [dbGetQueryArrow()] - #' with `SELECT * FROM `. + #' from the remote table, effectively the result of calling [dbGetQueryArrow()] with + #' `SELECT * FROM `. penguins_in <- get_penguins(ctx) dbWriteTable(con, table_name, penguins_in) penguins_out <- check_arrow(dbReadTableArrow(con, table_name)) @@ -63,9 +63,9 @@ spec_arrow_read_table_arrow <- list( arrow_read_table_arrow_error = function(ctx, con, table_name) { #' An error is raised dbWriteTable(con, table_name, data.frame(a = 1.5)) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbReadTableArrow(con, NA)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbReadTableArrow(con, c(table_name, table_name))) }, diff --git a/R/spec-arrow-write-table-arrow.R b/R/spec-arrow-write-table-arrow.R index fa5e59012..82efb056b 100644 --- a/R/spec-arrow-write-table-arrow.R +++ b/R/spec-arrow-write-table-arrow.R @@ -58,9 +58,9 @@ spec_arrow_write_table_arrow <- list( #' An error is also raised test_in <- stream_frame(a = 1L) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbWriteTableArrow(con, NA, test_in %>% stream_frame())) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbWriteTableArrow(con, c(table_name, table_name), test_in %>% stream_frame())) #' Invalid values for the additional arguments diff --git a/R/spec-driver-constructor.R b/R/spec-driver-constructor.R index 3fd1a1c2f..7f1b97e06 100644 --- a/R/spec-driver-constructor.R +++ b/R/spec-driver-constructor.R @@ -8,8 +8,7 @@ spec_driver_constructor <- list( constructor = function(ctx) { pkg_name <- package_name(ctx) - #' The backend must support creation of an instance of its [DBIDriver-class] - #' subclass + #' The backend must support creation of an instance of its [DBIDriver-class] subclass #' with a \dfn{constructor function}. #' By default, its name is the package name without the leading \sQuote{R} #' (if it exists), e.g., `SQLite` for the \pkg{RSQLite} package. diff --git a/R/spec-driver-data-type.R b/R/spec-driver-data-type.R index 2271f6167..1b03d26c2 100644 --- a/R/spec-driver-data-type.R +++ b/R/spec-driver-data-type.R @@ -113,12 +113,12 @@ test_data_type <- function(ctx, dbObj) { } ) - #' The SQL data type for [factor] + #' The SQL data type for [factor] and expect_identical( dbDataType(dbObj, letters), dbDataType(dbObj, factor(letters)) ) - #' and [ordered] is the same as for character. + #' [ordered] is the same as for character. expect_identical( dbDataType(dbObj, letters), dbDataType(dbObj, ordered(letters)) diff --git a/R/spec-meta-bind-expr.R b/R/spec-meta-bind-expr.R index 4a7ad0292..f1c1b4b6a 100644 --- a/R/spec-meta-bind-expr.R +++ b/R/spec-meta-bind-expr.R @@ -24,7 +24,7 @@ spec_meta_bind_expr <- function( expect_false(bind_res$visible) } - #' for queries issued by [dbSendQuery()] or [dbSendQueryArrow()] + #' for queries issued by [dbSendQuery()] or [dbSendQueryArrow()] and test_select_bind_expr( arrow = arrow, bind = bind, @@ -39,7 +39,7 @@ spec_meta_bind_expr <- function( expect_false(bind_res$visible) } - #' and also for data manipulation statements issued by + #' also for data manipulation statements issued by #' [dbSendStatement()]. test_select_bind_expr( arrow = arrow, diff --git a/R/spec-meta-get-statement.R b/R/spec-meta-get-statement.R index da4a01003..9a471eae6 100644 --- a/R/spec-meta-get-statement.R +++ b/R/spec-meta-get-statement.R @@ -13,7 +13,7 @@ spec_meta_get_statement <- list( #' @return #' `dbGetStatement()` returns a string, the query used in query <- trivial_query() - #' either [dbSendQuery()] + #' either [dbSendQuery()] or res <- local_result(dbSendQuery(con, query)) s <- dbGetStatement(res) expect_type(s, "character") @@ -22,7 +22,7 @@ spec_meta_get_statement <- list( # get_statement_statement = function(con, table_name) { query <- paste0("CREATE TABLE ", table_name, " (a integer)") - #' or [dbSendStatement()]. + #' [dbSendStatement()]. res <- local_result(dbSendStatement(con, query)) s <- dbGetStatement(res) expect_type(s, "character") diff --git a/R/spec-result-fetch.R b/R/spec-result-fetch.R index 3cbcc1bbf..0b434f1c3 100644 --- a/R/spec-result-fetch.R +++ b/R/spec-result-fetch.R @@ -11,8 +11,8 @@ spec_result_fetch <- list( fetch_atomic = function(con) { #' @return - #' `dbFetch()` always returns a [data.frame] - #' with as many rows as records were fetched and as many + #' `dbFetch()` always returns a [data.frame] with + #' as many rows as records were fetched and as many #' columns as fields in the result set, #' even if the result is a single value query <- trivial_query() @@ -87,8 +87,8 @@ spec_result_fetch <- list( fetch_no_return_value = function(con, table_name) { #' #' Calling `dbFetch()` on a result set from a data manipulation query - #' created by [dbSendStatement()] - #' can be fetched and return an empty data frame, with a warning. + #' created by [dbSendStatement()] can + #' be fetched and return an empty data frame, with a warning. query <- paste0("CREATE TABLE ", table_name, " (a integer)") res <- local_result(dbSendStatement(con, query)) @@ -124,11 +124,11 @@ spec_result_fetch <- list( result <- trivial_df(25) res <- local_result(dbSendQuery(con, query)) - #' by passing a whole number ([integer] + #' by passing a whole number ([integer] or rows <- check_df(dbFetch(res, 10L)) expect_identical(rows, unrowname(result[1:10, , drop = FALSE])) - #' or [numeric]) + #' [numeric]) rows <- check_df(dbFetch(res, 10)) expect_identical(rows, unrowname(result[11:20, , drop = FALSE])) diff --git a/R/spec-sql-append-table.R b/R/spec-sql-append-table.R index 6442b91c6..dc708ddb3 100644 --- a/R/spec-sql-append-table.R +++ b/R/spec-sql-append-table.R @@ -64,9 +64,9 @@ spec_sql_append_table <- list( append_table_error = function(con, table_name) { #' An error is also raised test_in <- data.frame(a = 1L) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbAppendTable(con, NA, test_in)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbAppendTable(con, c("test", "test"), test_in)) #' Invalid values for the `row.names` argument diff --git a/R/spec-sql-create-table.R b/R/spec-sql-create-table.R index b67c10910..7b28eb22c 100644 --- a/R/spec-sql-create-table.R +++ b/R/spec-sql-create-table.R @@ -43,9 +43,9 @@ spec_sql_create_table <- list( create_table_error = function(ctx, con, table_name) { #' An error is also raised test_in <- data.frame(a = 1L) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbCreateTable(con, NA, test_in)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbCreateTable(con, c(table_name, table_name), test_in)) #' Invalid values for the `row.names` and `temporary` arguments diff --git a/R/spec-sql-exists-table.R b/R/spec-sql-exists-table.R index 587cf6ead..5e53d3c4c 100644 --- a/R/spec-sql-exists-table.R +++ b/R/spec-sql-exists-table.R @@ -51,9 +51,9 @@ spec_sql_exists_table <- list( exists_table_error = function(con, table_name) { #' An error is also raised dbWriteTable(con, table_name, data.frame(a = 1L)) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbExistsTable(con, NA)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbExistsTable(con, c(table_name, table_name))) }, diff --git a/R/spec-sql-list-objects.R b/R/spec-sql-list-objects.R index 4d3111790..0fad7e640 100644 --- a/R/spec-sql-list-objects.R +++ b/R/spec-sql-list-objects.R @@ -37,11 +37,11 @@ spec_sql_list_objects <- list( #' accessible from the prefix (if passed) or from the global namespace #' (if prefix is omitted). - #' Tables added with [dbWriteTable()] + #' Tables added with [dbWriteTable()] are penguins <- get_penguins(ctx) dbWriteTable(con, table_name, penguins) - #' are part of the data frame. + #' part of the data frame. objects <- dbListObjects(con) quoted_tables <- vapply(objects$table, dbQuoteIdentifier, conn = con, character(1)) expect_true(dbQuoteIdentifier(con, table_name) %in% quoted_tables) diff --git a/R/spec-sql-list-tables.R b/R/spec-sql-list-tables.R index 3f89b678a..f7b4f0381 100644 --- a/R/spec-sql-list-tables.R +++ b/R/spec-sql-list-tables.R @@ -22,11 +22,11 @@ spec_sql_list_tables <- list( # TODO #' in the database. - #' Tables added with [dbWriteTable()] + #' Tables added with [dbWriteTable()] are penguins <- get_penguins(ctx) dbWriteTable(con, table_name, penguins) - #' are part of the list. + #' part of the list. tables <- dbListTables(con) expect_true(table_name %in% tables) }, diff --git a/R/spec-sql-read-table.R b/R/spec-sql-read-table.R index ad5b9ffb8..9bbe43f46 100644 --- a/R/spec-sql-read-table.R +++ b/R/spec-sql-read-table.R @@ -12,8 +12,8 @@ spec_sql_read_table <- list( read_table = function(ctx, con, table_name) { #' @return #' `dbReadTable()` returns a data frame that contains the complete data - #' from the remote table, effectively the result of calling [dbGetQuery()] - #' with `SELECT * FROM `. + #' from the remote table, effectively the result of calling [dbGetQuery()] with + #' `SELECT * FROM `. penguins_in <- get_penguins(ctx) dbWriteTable(con, table_name, penguins_in) penguins_out <- check_df(dbReadTable(con, table_name)) diff --git a/R/spec-sql-remove-table.R b/R/spec-sql-remove-table.R index b0682c188..8310d36f5 100644 --- a/R/spec-sql-remove-table.R +++ b/R/spec-sql-remove-table.R @@ -45,9 +45,9 @@ spec_sql_remove_table <- list( remove_table_error = function(con, table_name) { #' An error is also raised dbWriteTable(con, table_name, data.frame(a = 1L)) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbRemoveTable(con, NA)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbRemoveTable(con, c(table_name, table_name))) }, diff --git a/R/spec-sql-unquote-identifier.R b/R/spec-sql-unquote-identifier.R index 2bde18b48..be1bbe259 100644 --- a/R/spec-sql-unquote-identifier.R +++ b/R/spec-sql-unquote-identifier.R @@ -139,8 +139,8 @@ spec_sql_unquote_identifier <- list( #' unquote_identifier_simple = function(con) { - #' Unquoting simple strings (consisting of only letters) wrapped with [SQL()] - #' and then quoting via [dbQuoteIdentifier()] gives the same result as just + #' Unquoting simple strings (consisting of only letters) wrapped with [SQL()] and + #' then quoting via [dbQuoteIdentifier()] gives the same result as just #' quoting the string. simple_in <- "simple" simple_quoted <- dbQuoteIdentifier(con, simple_in) diff --git a/R/spec-sql-write-table.R b/R/spec-sql-write-table.R index d11c32d44..09ec31a93 100644 --- a/R/spec-sql-write-table.R +++ b/R/spec-sql-write-table.R @@ -54,9 +54,9 @@ spec_sql_write_table <- list( write_table_error = function(ctx, con, table_name) { #' An error is also raised test_in <- data.frame(a = 1L) - #' if `name` cannot be processed with [dbQuoteIdentifier()] + #' if `name` cannot be processed with [dbQuoteIdentifier()] or expect_error(dbWriteTable(con, NA, test_in)) - #' or if this results in a non-scalar. + #' if this results in a non-scalar. expect_error(dbWriteTable(con, c(table_name, table_name), test_in)) #' Invalid values for the additional arguments `row.names`, diff --git a/man/spec_arrow_append_table_arrow.Rd b/man/spec_arrow_append_table_arrow.Rd index e94375678..9887f46a2 100644 --- a/man/spec_arrow_append_table_arrow.Rd +++ b/man/spec_arrow_append_table_arrow.Rd @@ -21,8 +21,8 @@ an error is raised; the remote table remains unchanged. An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. } \section{Specification}{ diff --git a/man/spec_arrow_create_table_arrow.Rd b/man/spec_arrow_create_table_arrow.Rd index 9b3c10009..54a6262d9 100644 --- a/man/spec_arrow_create_table_arrow.Rd +++ b/man/spec_arrow_create_table_arrow.Rd @@ -17,8 +17,8 @@ If the table exists, an error is raised; the remote table remains unchanged. An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. Invalid values for the \code{temporary} argument (non-scalars, unsupported data types, diff --git a/man/spec_arrow_fetch_arrow.Rd b/man/spec_arrow_fetch_arrow.Rd index e770fc2da..b5b2b07af 100644 --- a/man/spec_arrow_fetch_arrow.Rd +++ b/man/spec_arrow_fetch_arrow.Rd @@ -5,8 +5,8 @@ \alias{spec_arrow_fetch_arrow} \title{spec_arrow_fetch_arrow} \value{ -\code{dbFetchArrow()} always returns an object coercible to a \link{data.frame} -with as many rows as records were fetched and as many +\code{dbFetchArrow()} always returns an object coercible to a \link{data.frame} with +as many rows as records were fetched and as many columns as fields in the result set, even if the result is a single value or has one diff --git a/man/spec_arrow_fetch_arrow_chunk.Rd b/man/spec_arrow_fetch_arrow_chunk.Rd index c91c31637..58fe76a8d 100644 --- a/man/spec_arrow_fetch_arrow_chunk.Rd +++ b/man/spec_arrow_fetch_arrow_chunk.Rd @@ -5,8 +5,8 @@ \alias{spec_arrow_fetch_arrow_chunk} \title{spec_arrow_fetch_arrow_chunk} \value{ -\code{dbFetchArrowChunk()} always returns an object coercible to a \link{data.frame} -with as many rows as records were fetched and as many +\code{dbFetchArrowChunk()} always returns an object coercible to a \link{data.frame} with +as many rows as records were fetched and as many columns as fields in the result set, even if the result is a single value or has one diff --git a/man/spec_arrow_read_table_arrow.Rd b/man/spec_arrow_read_table_arrow.Rd index b797681e8..f2c66da84 100644 --- a/man/spec_arrow_read_table_arrow.Rd +++ b/man/spec_arrow_read_table_arrow.Rd @@ -6,8 +6,8 @@ \title{spec_arrow_read_table_arrow} \value{ \code{dbReadTableArrow()} returns an Arrow object that contains the complete data -from the remote table, effectively the result of calling \code{\link[=dbGetQueryArrow]{dbGetQueryArrow()}} -with \verb{SELECT * FROM }. +from the remote table, effectively the result of calling \code{\link[=dbGetQueryArrow]{dbGetQueryArrow()}} with +\verb{SELECT * FROM }. An empty table is returned as an Arrow object with zero rows. } @@ -22,8 +22,8 @@ An error is raised if the table does not exist. An error is raised when calling this method for a closed or invalid connection. An error is raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. } \section{Specification}{ diff --git a/man/spec_arrow_write_table_arrow.Rd b/man/spec_arrow_write_table_arrow.Rd index f2023d81a..445349138 100644 --- a/man/spec_arrow_write_table_arrow.Rd +++ b/man/spec_arrow_write_table_arrow.Rd @@ -20,8 +20,8 @@ an error is raised; the remote table remains unchanged. An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. Invalid values for the additional arguments \code{overwrite}, \code{append}, and \code{temporary} (non-scalars, diff --git a/man/spec_driver_constructor.Rd b/man/spec_driver_constructor.Rd index bffe394f1..d5ff91fd8 100644 --- a/man/spec_driver_constructor.Rd +++ b/man/spec_driver_constructor.Rd @@ -9,8 +9,7 @@ spec_driver_constructor } \section{Construction of the DBIDriver object}{ -The backend must support creation of an instance of its \linkS4class{DBIDriver} -subclass +The backend must support creation of an instance of its \linkS4class{DBIDriver} subclass with a \dfn{constructor function}. By default, its name is the package name without the leading \sQuote{R} (if it exists), e.g., \code{SQLite} for the \pkg{RSQLite} package. diff --git a/man/spec_driver_data_type.Rd b/man/spec_driver_data_type.Rd index 48b9bb557..0202d43a7 100644 --- a/man/spec_driver_data_type.Rd +++ b/man/spec_driver_data_type.Rd @@ -42,8 +42,8 @@ this method also must accept lists of \link{raw} vectors, and \link[blob:blob]{blob::blob} objects. As-is objects (i.e., wrapped by \code{\link[=I]{I()}}) must be supported and return the same results as their unwrapped counterparts. -The SQL data type for \link{factor} -and \link{ordered} is the same as for character. +The SQL data type for \link{factor} and +\link{ordered} is the same as for character. The behavior for other object types is not specified. } diff --git a/man/spec_meta_bind.Rd b/man/spec_meta_bind.Rd index aa1654d79..1ba88da32 100644 --- a/man/spec_meta_bind.Rd +++ b/man/spec_meta_bind.Rd @@ -8,8 +8,8 @@ \value{ \code{dbBind()} returns the result set, invisibly, -for queries issued by \code{\link[=dbSendQuery]{dbSendQuery()}} or \code{\link[=dbSendQueryArrow]{dbSendQueryArrow()}} -and also for data manipulation statements issued by +for queries issued by \code{\link[=dbSendQuery]{dbSendQuery()}} or \code{\link[=dbSendQueryArrow]{dbSendQueryArrow()}} and +also for data manipulation statements issued by \code{\link[=dbSendStatement]{dbSendStatement()}}. } \description{ diff --git a/man/spec_meta_get_statement.Rd b/man/spec_meta_get_statement.Rd index 9af26860a..c5916fa86 100644 --- a/man/spec_meta_get_statement.Rd +++ b/man/spec_meta_get_statement.Rd @@ -6,8 +6,8 @@ \title{spec_meta_get_statement} \value{ \code{dbGetStatement()} returns a string, the query used in -either \code{\link[=dbSendQuery]{dbSendQuery()}} -or \code{\link[=dbSendStatement]{dbSendStatement()}}. +either \code{\link[=dbSendQuery]{dbSendQuery()}} or +\code{\link[=dbSendStatement]{dbSendStatement()}}. } \description{ spec_meta_get_statement diff --git a/man/spec_result_fetch.Rd b/man/spec_result_fetch.Rd index 96ffd66a3..99b6e237e 100644 --- a/man/spec_result_fetch.Rd +++ b/man/spec_result_fetch.Rd @@ -5,8 +5,8 @@ \alias{spec_result_fetch} \title{spec_result_fetch} \value{ -\code{dbFetch()} always returns a \link{data.frame} -with as many rows as records were fetched and as many +\code{dbFetch()} always returns a \link{data.frame} with +as many rows as records were fetched and as many columns as fields in the result set, even if the result is a single value or has one @@ -25,8 +25,8 @@ greater or equal to -1 or Inf, an error is raised, but a subsequent call to \code{dbFetch()} with proper \code{n} argument succeeds. Calling \code{dbFetch()} on a result set from a data manipulation query -created by \code{\link[=dbSendStatement]{dbSendStatement()}} -can be fetched and return an empty data frame, with a warning. +created by \code{\link[=dbSendStatement]{dbSendStatement()}} can +be fetched and return an empty data frame, with a warning. } \section{Specification}{ @@ -34,8 +34,8 @@ can be fetched and return an empty data frame, with a warning. Fetching multi-row queries with one or more columns by default returns the entire result. Multi-row queries can also be fetched progressively -by passing a whole number (\link{integer} -or \link{numeric}) +by passing a whole number (\link{integer} or +\link{numeric}) as the \code{n} argument. A value of \link{Inf} for the \code{n} argument is supported and also returns the full result. diff --git a/man/spec_sql_append_table.Rd b/man/spec_sql_append_table.Rd index 7bf370b79..564b45ef2 100644 --- a/man/spec_sql_append_table.Rd +++ b/man/spec_sql_append_table.Rd @@ -21,8 +21,8 @@ an error is raised; the remote table remains unchanged. An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. Invalid values for the \code{row.names} argument (non-scalars, unsupported data types, diff --git a/man/spec_sql_create_table.Rd b/man/spec_sql_create_table.Rd index fef0398a3..7d4a57a70 100644 --- a/man/spec_sql_create_table.Rd +++ b/man/spec_sql_create_table.Rd @@ -17,8 +17,8 @@ If the table exists, an error is raised; the remote table remains unchanged. An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. Invalid values for the \code{row.names} and \code{temporary} arguments (non-scalars, unsupported data types, diff --git a/man/spec_sql_exists_table.Rd b/man/spec_sql_exists_table.Rd index c5e319363..8c9e1f737 100644 --- a/man/spec_sql_exists_table.Rd +++ b/man/spec_sql_exists_table.Rd @@ -18,8 +18,8 @@ spec_sql_exists_table An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. } \section{Specification}{ diff --git a/man/spec_sql_list_objects.Rd b/man/spec_sql_list_objects.Rd index a6752d230..69441a166 100644 --- a/man/spec_sql_list_objects.Rd +++ b/man/spec_sql_list_objects.Rd @@ -17,8 +17,8 @@ This data frame contains one row for each object (schema, table and view) accessible from the prefix (if passed) or from the global namespace (if prefix is omitted). -Tables added with \code{\link[=dbWriteTable]{dbWriteTable()}} -are part of the data frame. +Tables added with \code{\link[=dbWriteTable]{dbWriteTable()}} are +part of the data frame. As soon a table is removed from the database, it is also removed from the data frame of database objects. diff --git a/man/spec_sql_list_tables.Rd b/man/spec_sql_list_tables.Rd index 1b98295c3..8267fe92c 100644 --- a/man/spec_sql_list_tables.Rd +++ b/man/spec_sql_list_tables.Rd @@ -10,8 +10,8 @@ returns a character vector that enumerates all tables and views in the database. -Tables added with \code{\link[=dbWriteTable]{dbWriteTable()}} -are part of the list. +Tables added with \code{\link[=dbWriteTable]{dbWriteTable()}} are +part of the list. As soon a table is removed from the database, it is also removed from the list of database tables. diff --git a/man/spec_sql_read_table.Rd b/man/spec_sql_read_table.Rd index e588a1a8a..d06bbd104 100644 --- a/man/spec_sql_read_table.Rd +++ b/man/spec_sql_read_table.Rd @@ -6,8 +6,8 @@ \title{spec_sql_read_table} \value{ \code{dbReadTable()} returns a data frame that contains the complete data -from the remote table, effectively the result of calling \code{\link[=dbGetQuery]{dbGetQuery()}} -with \verb{SELECT * FROM }. +from the remote table, effectively the result of calling \code{\link[=dbGetQuery]{dbGetQuery()}} with +\verb{SELECT * FROM }. An empty table is returned as a data frame with zero rows. diff --git a/man/spec_sql_remove_table.Rd b/man/spec_sql_remove_table.Rd index 97116b04a..e56d1bac9 100644 --- a/man/spec_sql_remove_table.Rd +++ b/man/spec_sql_remove_table.Rd @@ -18,8 +18,8 @@ An attempt to remove a view with this function may result in an error. An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. } \section{Additional arguments}{ diff --git a/man/spec_sql_unquote_identifier.Rd b/man/spec_sql_unquote_identifier.Rd index caf6b3bc5..35f327706 100644 --- a/man/spec_sql_unquote_identifier.Rd +++ b/man/spec_sql_unquote_identifier.Rd @@ -41,8 +41,8 @@ or quotes used to mark strings or identifiers, if the database supports this. -Unquoting simple strings (consisting of only letters) wrapped with \code{\link[=SQL]{SQL()}} -and then quoting via \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} gives the same result as just +Unquoting simple strings (consisting of only letters) wrapped with \code{\link[=SQL]{SQL()}} and +then quoting via \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} gives the same result as just quoting the string. Similarly, unquoting expressions of the form \code{SQL("schema.table")} and then quoting gives the same result as quoting the identifier diff --git a/man/spec_sql_write_table.Rd b/man/spec_sql_write_table.Rd index 6974e8ca9..44e60bd8a 100644 --- a/man/spec_sql_write_table.Rd +++ b/man/spec_sql_write_table.Rd @@ -20,8 +20,8 @@ an error is raised; the remote table remains unchanged. An error is raised when calling this method for a closed or invalid connection. An error is also raised -if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} -or if this results in a non-scalar. +if \code{name} cannot be processed with \code{\link[=dbQuoteIdentifier]{dbQuoteIdentifier()}} or +if this results in a non-scalar. Invalid values for the additional arguments \code{row.names}, \code{overwrite}, \code{append}, \code{field.types}, and \code{temporary} (non-scalars, diff --git a/man/test_data_type.Rd b/man/test_data_type.Rd index a23703c1c..ae8d39a91 100644 --- a/man/test_data_type.Rd +++ b/man/test_data_type.Rd @@ -47,8 +47,8 @@ this method also must accept lists of \link{raw} vectors, and \link[blob:blob]{blob::blob} objects. As-is objects (i.e., wrapped by \code{\link[=I]{I()}}) must be supported and return the same results as their unwrapped counterparts. -The SQL data type for \link{factor} -and \link{ordered} is the same as for character. +The SQL data type for \link{factor} and +\link{ordered} is the same as for character. The behavior for other object types is not specified. }