R/get_metadata.R

In oxcovid19: An R API to the Oxford COVID-19 Database

################################################################################
#
#'
#' Get remote table metadata
#'
#' @param x An object of class `tbl_lazy` produced by [get_table()]
#'
#' @return A named list of remote table metadata
#'
#' @author Ernest Guevarra
#'
#' @examples
#' x <- get_table(con = connect_oxcovid19(), tbl_name = "epidemiology")
#' get_metadata(x)
#'
#' @export
#'
#
################################################################################

get_metadata <- function(x) {
  md <- list(dbplyr::remote_name(x),
             dbplyr::remote_src(x),
             dbplyr::remote_con(x),
             dbplyr::remote_query(x),
             dbplyr::remote_query_plan(x))

  names(md) <- c("Name", "Source", "DBI connection", "Query text", "Query plan")

  return(md)
}