db.read_table {shinyNotes}

Read remote database tables into data frames with additional validation

Description

Wrapper function to read table from default or custom schema, and return NA by default if an error is encountered.

Usage

db.read_table(con, table, schema = NA, collect = TRUE, error_value = NA)

Arguments

con

An object that inherits from DBIConnection-class, typically generated by dbConnect()

table

A character string specifying the DBMS table name.

schema

A character string specifying the schema in which the table is nested.

collect

A logical specifying whether the query results should be collected into memory or left as a lazy query.

error_value

Error value to return if dbReadTable() fails. Default is NA.

Value

If the SQL query executes successfully, the return value will be an object of class tibble. If an error is encountered, the return value will be inherited from the error_value argument provided (default is NA).

Examples

con <- connect_sqlite(auto_disconnect = FALSE)
dplyr::copy_to(con, iris, "df", temporary = FALSE)
db.read_table(con = con, table = 'df')