R/qrc_query.R

In kimjam/qrcutils: Contains utility functions for data pipeline project.

#' @title qrc_query
#' @description Function to query qrc_raw Postgresql database.
#'
#' @param db Database name.
#' @param query Query to send to database.
#' @param dbhost Host IP address. Set to QRC_DB_HOST in .Renviron.
#' @param port Port that server is listening on. Defaults to 5432.
#' @param uid User ID. Set as QRC_DB_USER in .Renviron file.
#' @param pwd Password. Set as QRC_DB_PWD in .Renviron file.
#'
#' @return Returns query results in dataframe.
#' @export
qrc_query <- function(
  db,
  query,
  dbhost = Sys.getenv('QRC_DB_HOST'),
  port = 5432,
  uid = Sys.getenv('QRC_DB_USER'),
  pwd = Sys.getenv('QRC_DB_PWD')
) {
  con <- DBI::dbConnect(drv = RPostgreSQL::PostgreSQL(),
                        dbname = db,
                        host = dbhost,
                        port = port,
                        user = uid,
                        password = pwd)

  df <- DBI::dbGetQuery(conn = con,
                        statement = query)

  DBI::dbDisconnect(conn = con)
  return(df)
}