R/dbpf_tables.R

In geocryology/PermafrostDB: PermafrostDB

# =============================================================================
#'
#' @title Returns names of all tables within DB
#'
#' @description Basic information on permafrost database @ Carleton University
#' 
#' @param con Database connection object, as returned by dbpf_con()
#' 
#' @details These simple functions return all data as data frames. When
#'          making a query many times, optimise the SQL statement to only
#'          request the data you actually need.
#'
#' @return List of tables in the DB
#'
#' @export
#' @examples
#' \dontrun{
#' tab <- dbpf_tables()
#' }
#' @author Stephan Gruber <stephan.gruber@@carleton.ca>
# =============================================================================

dbpf_tables <- function(con) {
    if (missing(con)){
      con <- dbpf_con() # get connection
    }

    tables <- DBI::dbListTables(con)

    return(tables)
}