#28 création d'une fonction qui récupère les commentaires d'une base de données sur le SGBD

R/comment_db.R

+#' get_db_comment : Récupérer les commentaires d'une base de données sur le SGBD
+#'
+#' @param db :  base de données dont on recherche le descriptif.
+#' @param user : l'identifiant de l'utilisateur SGBD qui se connecte
+#' @param server : l'adresse IP du serveur, laisser à NULL pour utiliser la variable d'environnement du .Renviron
+#' @return le commentaire de la bases de données dans un dataframe avec les champs (nom_base, commentaire)
+#'
+#' @export
+#' @importFrom attempt stop_if_not stop_if
+#' @importFrom DBI dbGetQuery
+#' @importFrom dplyr transmute
+#' @importFrom rlang .data
+
+
+get_db_comment <- function(db = "public", user = "does", server = NULL) {
+  # Connexion à la base de données
+  con <- datalibaba::connect_to_db(db = db, user = user, server = server)
+
+  # Construction de la requête SQL pour récupérer le commentaire de la base de données
+  query <- "SELECT datname AS nom_base, description AS commentaire FROM pg_database JOIN pg_shdescription ON pg_database.oid = pg_shdescription.objoid WHERE datname = current_database();"
+
+  # Récupération du commentaire
+  com <- DBI::dbGetQuery(conn = con, statement = query) %>%
+    dplyr::transmute(nom_base = .data$nom_base, commentaire = .data$commentaire)
+
+  # Déconnexion de la base de données
+  DBI::dbDisconnect(con)
+  rm(con)
+
+  return(com)
+}
+