Merge branch 'dev' into 'master'

Création des tests pour insert_into_table()

See merge request !64

R/create_dummy.R

@@ -28,7 +28,7 @@
 #'              schema = "public",
 #'              table = "dummy",
 #'              pk = NULL,
-#'              id_range = "1:5"
+#'              id_range = "1:5",
 #'              role = "runner")
 #' }
 create_dummy <- function(host, database, schema, table, pk = NULL,

R/import_and_merge_tables.R

@@ -23,14 +23,14 @@
 #' @export
 #' @examples
 #' \dontrun{
-#' # Créer une table dummy dans le schéma collectr de la base production
+#' # Créer une table source dans le schéma public de la base collectr
 #' create_dummy(host = "localhost",
 #'              database = "collectr",
 #'              schema = "public",
 #'              table = "source",
 #'              pk = "id",
 #'              role = "runner")
-#' # Créer une table dummy dans le schéma collectr de la base production
+#' # Créer une table target dans le schéma public de la base collectr
 #' create_dummy(host = "localhost",
 #'              database = "collectr",
 #'              schema = "public",

R/insert_into_table.R

 
 #' Insère un dataframe dans une table existante
 #'
-#' @description Fonction pour insérer les données d'un dataframe dans une table 
-#' existante d'une base de données PostgreSQL, en vérifiant la correspondance 
-#' de la structure entre le dataframe et la table. Si la correspondance est 
+#' @description Fonction pour insérer les données d'un dataframe dans une table
+#' existante d'une base de données PostgreSQL, en vérifiant la correspondance
+#' de la structure entre le dataframe et la table. Si la correspondance est
 #' vérifiée, les données sont insérées dans la table. Si la correspondance
 #' n'est pas vérifiée les différences de strcture entre le dataframe et la table
 #' sont listées.
 #'
+#' @param host Hôte de la base de données PostgreSQL.
 #' @param database Nom de la base de données.
 #' @param schema Le schéma de la table dans la base de données.
 #' @param table Le nom de la table existante dans la base de données.
 #' @param dataframe Le dataframe contenant les données à insérer.
 #' @param role Le rôle du propriétaire de la table.
-#' 
+#'
 #' @return Le nombre de lignes insérées dans la table en base.
 #'
 #' @importFrom datalibaba connect_to_db
@@ -23,54 +24,61 @@
 #' @export
 #' @examples
 #' \dontrun{
-#' # Création d'un dataframe à partir d'un fichier XLSX
-#' data_ars_2022 <- collectr::import_xlsx(
-#'   filepath = "C:\\TEMP\\Nitrates_2022.xlsx",
-#'   sheet = 1,
-#'   row = 1)
-#'
-#' # Ajout d'un champs de géométrie
-#' data_ars_2022 <- data_ars_2022 |>
-#'   dplyr::select(-coord_x,-coord_y) |>
-#'   dplyr::mutate(eligible_ades = rep(NA, dplyr::n()))
-#'
+#' # Créer une dataframe source
+#' source <- data.frame(
+#'   id = 6:10,
+#'   name = c("Alice", "Bob", "Charlie", "David", "Eve"),
+#'   birthdate = c("1990-01-15", "1985-06-22", "1992-09-10", "1988-03-05", "1995-12-30"),
+#'   value = rnorm(5)
+#' )
+#' # Créer une table target dans le schéma public de la base collectr
+#' create_dummy(host = "localhost",
+#'              database = "collectr",
+#'              schema = "public",
+#'              table = "target",
+#'              pk = "id",
+#'              id_range = "1:5",
+#'              role = "runner")
 #' # Utilisation de la fonction insert_into_table()
-#' insert_into_table(database = "si_eau",
-#'                   schema = "nitrates",
-#'                   table = "nitrate_data_analyse_ars_test",
-#'                   dataframe = data_ars_2022,
-#'                   role = "admin")
+#' insert_into_table(host = "localhost",
+#'                   database = "collectr",
+#'                   schema = "public",
+#'                   table = "target",
+#'                   dataframe = source,
+#'                   role = "runner")
 #' }
-insert_into_table <- function(database, schema, table, dataframe, role) {
+insert_into_table <- function(host, database, schema, table, dataframe, role) {
   # Se connecter à la base de données PostgreSQL
-  connexion <- datalibaba::connect_to_db(db = database, 
-                                         user = role, 
+  connexion <- datalibaba::connect_to_db(server = host,
+                                         db = database,
+                                         user = role,
                                          ecoSQL = FALSE)
-  
+
   # Vérifier si la table existe dans la base de données
-  if (!table_exists(database = database, schema = schema, table = table, role = role)) {
+  if (!table_exists(host = host, database = database, schema = schema,
+                    table = table, role = role)) {
     stop("La table sp\u00e9cifi\u00e9e n\'existe pas dans la base de donn\u00e9es.")
   }
 
-  # Vérifier si les attributs correspondent 
-  if (!check_structure_table(database = database, schema = schema, 
-                             table = table, dataframe = dataframe, 
+  # Vérifier si les attributs correspondent
+  if (!check_structure_table(host = host, database = database, schema = schema,
+                             table = table, dataframe = dataframe,
                              role = role)) {
     return(FALSE)
   }
 
   # Utiliser sqlAppendTable pour préparer la requête d'insertion
   insert_query <- DBI::sqlAppendTable(connexion,
-                                    DBI::Id(schema = schema, table = table),
-                                    dataframe,
-                                    row.names = FALSE)
+                                      DBI::Id(schema = schema, table = table),
+                                      dataframe,
+                                      row.names = FALSE)
 
   # Exécuter la requête d'insertion
   result <- DBI::dbExecute(connexion, insert_query)
 
   # Se déconnecter de la base de données
   DBI::dbDisconnect(connexion)
-  
+
   # Renvoyer le nombre de lignes insérées
   return(result)
 }

dev/0-dev_history.Rmd

@@ -87,6 +87,7 @@ usethis::use_r("import_and_merge_tables")
 usethis::use_r("import_geopackage")
 usethis::use_r("import_shapefile")
 usethis::use_r("import_xlsx")
+usethis::use_r("insert_into_table")
 usethis::use_r("modify_column_type")
 usethis::use_r("remove_special_chars")
 usethis::use_r("rename_field")
@@ -110,6 +111,7 @@ usethis::use_test("import_and_merge_tables")
 usethis::use_test("import_geopackage")
 usethis::use_test("import_shapefile")
 usethis::use_test("import_xlsx")
+usethis::use_test("insert_into_table")
 usethis::use_test("modify_column_type")
 usethis::use_test("remove_special_chars")
 usethis::use_test("rename_field")

man/create_dummy.Rd

@@ -36,7 +36,7 @@ create_dummy(host = "localhost",
              schema = "public",
              table = "dummy",
              pk = NULL,
-             id_range = "1:5"
+             id_range = "1:5",
              role = "runner")
 }
 }

man/import_and_merge_tables.Rd

@@ -41,14 +41,14 @@ ou l'autre des tables.
 }
 \examples{
 \dontrun{
-# Créer une table dummy dans le schéma collectr de la base production
+# Créer une table source dans le schéma public de la base collectr
 create_dummy(host = "localhost",
              database = "collectr",
              schema = "public",
              table = "source",
              pk = "id",
              role = "runner")
-# Créer une table dummy dans le schéma collectr de la base production
+# Créer une table target dans le schéma public de la base collectr
 create_dummy(host = "localhost",
              database = "collectr",
              schema = "public",

man/insert_into_table.Rd

@@ -4,9 +4,11 @@
 \alias{insert_into_table}
 \title{Insère un dataframe dans une table existante}
 \usage{
-insert_into_table(database, schema, table, dataframe, role)
+insert_into_table(host, database, schema, table, dataframe, role)
 }
 \arguments{
+\item{host}{Hôte de la base de données PostgreSQL.}
+
 \item{database}{Nom de la base de données.}
 
 \item{schema}{Le schéma de la table dans la base de données.}
@@ -30,22 +32,27 @@ sont listées.
 }
 \examples{
 \dontrun{
-# Création d'un dataframe à partir d'un fichier XLSX
-data_ars_2022 <- collectr::import_xlsx(
-  filepath = "C:\\\\TEMP\\\\Nitrates_2022.xlsx",
-  sheet = 1,
-  row = 1)
-
-# Ajout d'un champs de géométrie
-data_ars_2022 <- data_ars_2022 |>
-  dplyr::select(-coord_x,-coord_y) |>
-  dplyr::mutate(eligible_ades = rep(NA, dplyr::n()))
-
+# Créer une dataframe source
+source <- data.frame(
+  id = 6:10,
+  name = c("Alice", "Bob", "Charlie", "David", "Eve"),
+  birthdate = c("1990-01-15", "1985-06-22", "1992-09-10", "1988-03-05", "1995-12-30"),
+  value = rnorm(5)
+)
+# Créer une table target dans le schéma public de la base collectr
+create_dummy(host = "localhost",
+             database = "collectr",
+             schema = "public",
+             table = "target",
+             pk = "id",
+             id_range = "1:5",
+             role = "runner")
 # Utilisation de la fonction insert_into_table()
-insert_into_table(database = "si_eau",
-                  schema = "nitrates",
-                  table = "nitrate_data_analyse_ars_test",
-                  dataframe = data_ars_2022,
-                  role = "admin")
+insert_into_table(host = "localhost",
+                  database = "collectr",
+                  schema = "public",
+                  table = "target",
+                  dataframe = source,
+                  role = "runner")
 }
 }

tests/testthat/test-insert_into_table.R

+test_that("insert_into_table works", {
+
+  Sys.setenv(user_runner="runner")
+  Sys.setenv(pwd_runner=Sys.getenv("BDD_RUNNER_PWD"))
+
+  # Création d'un dataframe fictif
+  source <- data.frame(
+    id = 6:10,
+    name = c("Alice", "Bob", "Charlie", "David", "Eve"),
+    birthdate = c("1990-01-15", "1985-06-22", "1992-09-10", "1988-03-05", "1995-12-30"),
+    value = rnorm(5)
+  )
+  # Créer une table target dans le schéma public de la base collectr
+  create_dummy(host = "localhost",
+               database = "collectr",
+               schema = "public",
+               table = "target",
+               pk = "id",
+               id_range = "1:5",
+               role = "runner")
+
+  expect_equal(object = insert_into_table(host = "localhost", database = "collectr",
+                                          schema = "public", table = "target",
+                                          dataframe = source, role = "runner"),
+               expected = 5)
+
+  expect_error(object = insert_into_table(host = "localhost", database = "collectr",
+                                          schema = "public", table = "ghost",
+                                          dataframe = source, role = "runner"),
+               regexp = "La table sp\u00e9cifi\u00e9e n\'existe pas dans la base de donn\u00e9es.")
+
+  # Création d'un dataframe avec une structure différente de la table
+  df <- data.frame(id = 1:5, name = letters[1:5], value = rnorm(5))
+
+  # Créer une table target dans le schéma public de la base collectr
+  create_dummy(host = "localhost",
+               database = "collectr",
+               schema = "public",
+               table = "target",
+               pk = "id",
+               id_range = "1:5",
+               role = "runner")
+
+  expect_false(insert_into_table(host = "localhost", database = "collectr",
+                                 schema = "public", table = "target",
+                                 dataframe = df, role = "runner"))
+})

vignettes/write-data.Rmd

@@ -59,23 +59,28 @@ archive_table(host = "localhost",
 
 ```{r examples-insert_into_table, eval=FALSE}
 #' \dontrun{
-# Création d'un dataframe à partir d'un fichier XLSX
-data_ars_2022 <- collectr::import_xlsx(
-  filepath = "C:\\TEMP\\Nitrates_2022.xlsx",
-  sheet = 1,
-  row = 1)
-
-# Ajout d'un champs de géométrie
-data_ars_2022 <- data_ars_2022 |>
-  dplyr::select(-coord_x,-coord_y) |>
-  dplyr::mutate(eligible_ades = rep(NA, dplyr::n()))
-
-# Utilisation de la fonction insert_into_table()
-insert_into_table(database = "si_eau",
-                  schema = "nitrates",
-                  table = "nitrate_data_analyse_ars_test",
-                  dataframe = data_ars_2022,
-                  role = "admin")
+# Créer une dataframe source
+ source <- data.frame(
+   id = 6:10,
+   name = c("Alice", "Bob", "Charlie", "David", "Eve"),
+   birthdate = c("1990-01-15", "1985-06-22", "1992-09-10", "1988-03-05", "1995-12-30"),
+   value = rnorm(5)
+ )
+ # Créer une table target dans le schéma public de la base collectr
+ create_dummy(host = "localhost",
+              database = "collectr",
+              schema = "public",
+              table = "target",
+              pk = "id",
+              id_range = "1:5",
+              role = "runner")
+ # Utilisation de la fonction insert_into_table()
+ insert_into_table(host = "localhost",
+                   database = "collectr",
+                   schema = "public",
+                   table = "target",
+                   dataframe = source,
+                   role = "runner")
 #' }
 ```