Skip to content

Commit

Permalink
docs: Reword warning message for misuse of dbGetQuery()/`dbSendQuer…
Browse files Browse the repository at this point in the history
…y()`/`dbFetch()` (#524)

* Suggest decor (required for tests)

* Reword dbFetch() with SELECT warning

* Update tests

* Add test for original issue
  • Loading branch information
mikmart authored Nov 17, 2024
1 parent 57c07f6 commit a12b12f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Suggests:
callr,
cli,
DBItest (>= 1.8.0),
decor,
gert,
gh,
hms,
Expand Down
2 changes: 1 addition & 1 deletion src/SqliteResultImpl.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ cpp11::list SqliteResultImpl::fetch_rows(const int n_max, int& n) {
SqliteDataFrame data(stmt, cache.names_, n_max, types_, with_alt_types_);

if (complete_ && data.get_ncols() == 0) {
Rf_warning("SQL statements must be issued with dbExecute() or dbSendStatement() instead of dbGetQuery() or dbSendQuery().");
Rf_warning("`dbGetQuery()`, `dbSendQuery()` and `dbFetch()` should only be used with `SELECT` queries. Did you mean `dbExecute()`, `dbSendStatement()` or `dbGetRowsAffected()`?");
}

while (!complete_) {
Expand Down
16 changes: 14 additions & 2 deletions tests/testthat/test-dbSendQuery.R
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ test_that("simple position binding works", {
),
"deprecated"
),
"SQL statements"
"`SELECT` queries"
)

expect_equal(dbReadTable(con, "t1")$x, c(1, 2))
Expand All @@ -64,7 +64,7 @@ test_that("simple named binding works", {
bind.data = data.frame(y = 1, x = 2)
) %>%
expect_warning("deprecated") %>%
expect_warning("SQL statements")
expect_warning("`SELECT` queries")

expect_equal(dbReadTable(con, "t1")$x, c(1, 2))
})
Expand Down Expand Up @@ -173,3 +173,15 @@ test_that("mark UTF-8 encoding on non-ASCII colnames", {
expect_equal(Encoding(got), "UTF-8")
expect_equal(got, cn_field)
})

test_that("dbFetch with statement other than SELECT warns reasonably (#523)", {
memoise::forget(warning_once)
con <- dbConnect(SQLite(), ":memory:")
on.exit(dbDisconnect(con), add = TRUE)

dbWriteTable(con, "t1", data.frame(x = 1, y = 2))
res <- dbSendStatement(con, "INSERT INTO t1 VALUES (2, 1)")
on.exit(dbClearResult(res), add = TRUE, after = FALSE)

expect_warning(dbFetch(res), "dbGetRowsAffected")
})

0 comments on commit a12b12f

Please sign in to comment.