Update CHANGELOG and README

fljdin · fljdin · commit f6fffc2709af · 2023-09-16T22:23:13.000+02:00
Improves the description of execute_statements() function
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,26 +5,30 @@
 - Add `mssql_migrator` to the README.
 
 - Add support for migrating partial indexes using a new `where_clause` column
-  in the `indexes` foreign table.  
+  in the `indexes` foreign table.
   Patch by Florent Jardin.
 
-- Factor out `db_migrate_indexes` from `db_migrate_constraints`.  
+- Factor out `db_migrate_indexes` from `db_migrate_constraints`.
   Patch by Florent Jardin.
 
 - Add a regression test suite based on pgTAP.
   Patch by Florent Jardin.
 
+- Add low-level function `execute_statements()` used by others methods to
+  populate `log_migrate` table on failed statements.
+  Patch by Florent Jardin
+
 ## Bugfixes: ##
 
-- Call the translation function on expressions in the partitioning key.  
+- Call the translation function on expressions in the partitioning key.
   Patch by Florent Jardin.
 
-- Call the translation function on index expressions.  
+- Call the translation function on index expressions.
   Patch by Florent Jardin.
 
 # Version 1.0.0, released 2023-02-08 #
 
 ## Enhancements: ##
 
-- Add support for migrating partitioned tables.  
+- Add support for migrating partitioned tables.
   Patch by Florent Jardin.
diff --git a/README.md b/README.md
@@ -903,19 +903,22 @@ Parameters:
 
 - `operation` (type `text`, required): arbitrary operation description
 
-- `schema` (type `name`, required): schema of the statement related object
+- `schema` (type `name`, required): schema of the statements related object
 
 - `object_name` (type `name`, required): name of the relation concerned by the
-  statement
+  statements
 
 - `statements` (type `text[]`, required): statements to execute in the same
   subtransaction
 
 - `pgstage_schema` (type `name`, default `pgsql_stage`): name of the Postgres
   staging schema where the `migrate_log` table has been created
 
-This function executes a SQL statement with logging errors into `migrate_log`
-table and returns `false` on failure.
+This function iterates through an array of SQL statements and executes them
+inside a subtransaction. If one fails, it raises a detailed warning and inserts
+the failed statement and its context into `migrate_log` table and all previous
+successful statements in the subtransaction are rollbacked. 
+Returns `false` on failure.
 
 Plugin API
 ==========
diff --git a/db_migrator--1.1.0.sql b/db_migrator--1.1.0.sql
@@ -135,7 +135,7 @@ BEGIN
          IF subpartition_count > 0 THEN
             LOOP
                /* create the subpartition */
-               statements := statements || 
+               statements := statements ||
                   format(
                      'CREATE TABLE %1$I.%3$I PARTITION OF %1$I.%2$I %4$s',
                      v_schema, v_partition, v_subpartition,
@@ -181,12 +181,12 @@ BEGIN
 
    /* move the data if desired */
    IF with_data THEN
-      statements := statements || 
+      statements := statements ||
          format('INSERT INTO %I.%I SELECT * FROM %I.%I', schema, table_name, schema, ft);
    END IF;
 
    /* drop the foreign table */
-   statements := statements || 
+   statements := statements ||
       format('DROP FOREIGN TABLE %I.%I', schema, ft);
 
    IF NOT execute_statements(
