Read a table from a PostgreSQL database as a data frame.

psql_read_table(
  tbl_name,
  schema = "public",
  config_path = getOption("psql.config_path", NULL),
  config_value = getOption("psql.config_value", "default")
)

Arguments

tbl_name

A string indicating the name of the table.

schema

A string of the schema name. Default value is "public".

config_path

A string of a file path to the yaml configuration file. The default value grabs the file path from the psql.config_path option and uses NULL if no value supplied.

config_value

A string of the name of value. The default value grabs the value from the psql.config_value option and uses "default" if no value is supplied.

Value

A data frame

Details

The function open and closes its own database connection. You do not need to close the database connection afterwards.

Examples

if (FALSE) { # \dontrun{
psql_read_table("capture")
psql_read_table("counts", "boat_count")
} # }