get_returned_rows: Extract and check the 'RETURNING' rows

In dbplyr: A 'dplyr' Back End for Databases

Extract and check the RETURNING rows

Description

get_returned_rows() extracts the RETURNING rows produced by dplyr::rows_insert(), dplyr::rows_append(), dplyr::rows_update(), dplyr::rows_upsert(), or dplyr::rows_delete() if these are called with the returning argument. An error is raised if this information is not available.

has_returned_rows() checks if x has stored RETURNING rows produced by dplyr::rows_insert(), dplyr::rows_append(), dplyr::rows_update(), dplyr::rows_upsert(), or dplyr::rows_delete().

Usage

get_returned_rows(x)

has_returned_rows(x)

Arguments

x	A lazy tbl.

Value

For get_returned_rows(), a tibble.

For has_returned_rows(), a scalar logical.

Examples

library(dplyr)

con <- DBI::dbConnect(RSQLite::SQLite(), ":memory:")
DBI::dbExecute(con, "CREATE TABLE Info (
   id INTEGER PRIMARY KEY AUTOINCREMENT,
   number INTEGER
)")
info <- tbl(con, "Info")

rows1 <- copy_inline(con, data.frame(number = c(1, 5)))
rows_insert(info, rows1, conflict = "ignore", in_place = TRUE)
info

# If the table has an auto incrementing primary key, you can use
# the returning argument + `get_returned_rows()` its value
rows2 <- copy_inline(con, data.frame(number = c(13, 27)))
info <- rows_insert(
  info,
  rows2,
  conflict = "ignore",
  in_place = TRUE,
  returning = id
)
info
get_returned_rows(info)

dbplyr documentation built on Sept. 10, 2025, 10:29 a.m.