Read from a PostgreSQL database — tl_read

Connects to a PostgreSQL database, executes a SQL query, and returns the result as a tidylearn_data object. Accepts either a connection string or individual connection parameters. Requires DBI and RPostgres.

Usage

tl_read_postgres(
  dsn,
  query,
  dbname = NULL,
  user = NULL,
  password = NULL,
  port = 5432,
  ...
)

Arguments

dsn: A PostgreSQL connection string (e.g., "postgres://user:pass@host:port/dbname"), or the database host if using named parameters. Percent-encode special characters in the user name and password (@ as %40). Query parameters such as ?sslmode=require are passed to libpq as connection keywords.
query: A SQL query string.
dbname: Database name (if not in dsn).
user: Username (if not in dsn).
password: Password (if not in dsn), which keeps it out of the connection string.
port: Port number. Default is 5432.
...: Additional arguments passed to DBI::dbConnect().

Value

A tidylearn_data object containing the query results.

Examples

if (FALSE) { # \dontrun{
# Needs a running PostgreSQL server
tl_read_postgres(
  dsn = "localhost",
  query = "SELECT * FROM my_table",
  dbname = "mydb",
  user = "myuser",
  password = Sys.getenv("PGPASSWORD")
)

# The same connection as a URL, with the password still kept out of it
tl_read_postgres(
  "postgres://myuser@localhost:5432/mydb?sslmode=require",
  query = "SELECT * FROM my_table",
  password = Sys.getenv("PGPASSWORD")
)
} # }