Autres fonctions de gestion des groupes
Réinitialisation des tables de log d’un groupe
En standard, et sauf indication contraire, les tables de log sont vidées lors du démarrage du groupe de tables auquel elles appartiennent. En cas de besoin, il est néanmoins possible de réinitialiser ces tables de log avec la commande SQL suivante
SELECT emaj.emaj_reset_group('<nom.du.groupe>');
La fonction retourne le nombre de tables et de séquences contenues dans le groupe.
Pour réinitialiser les tables de log d’un groupe, ce dernier doit bien sûr être à l’état inactif (« IDLE »).
Commentaires sur les groupes
Il est possible de positionner un commentaire sur un groupe quelconque. Pour se faire, il suffit d’exécuter la requête suivante
SELECT emaj.emaj_comment_group('<nom.du.groupe>', '<commentaire>');
La fonction ne retourne aucune donnée.
Pour modifier un commentaire, il suffit d’exécuter à nouveau la fonction pour le même groupe de tables, avec le nouveau commentaire.
Pour supprimer un commentaire, il suffit d’exécuter la fonction avec une valeur NULL pour le paramètre commentaire.
Les commentaires sont stockés dans la colonne group_comment de la table emaj.emaj_group qui décrit les groupes.
Protection d’un groupe de tables contre les rollbacks
Il peut être utile à certains moments de se protéger contre des rollbacks intempestifs de groupes de tables, en particulier sur des bases de données de production. Deux fonctions répondent à ce besoin.
La fonction emaj_protect_group() pose une protection sur un groupe de tables.
SELECT emaj.emaj_protect_group('<nom.du.groupe>');
La fonction retourne l’entier 1 si le groupe de tables n’était pas déjà protégé, ou 0 s’il était déjà protégé.
Une fois le groupe de tables protégé, toute tentative de rollback, tracé ou non, sera refusée.
Un groupe de tables de type « audit-seul » ou dans un état « inactif » ne peut être protégé.
Au démarrage d’un groupe de tables, ce dernier n’est pas protégé. Lorsqu’il est arrêté, un groupe de tables protégé contre les rollbacks perd automatiquement sa protection.
La fonction emaj_unprotect_group() ôte une protection existante sur un groupe de tables.
SELECT emaj.emaj_unprotect_group('<nom.du.groupe>');
La fonction retourne l’entier 1 si le groupe de table était protégé au préalable, ou 0 s’il n’était pas déjà protégé.
Un groupe de tables de type « audit-seul » ne peut être déprotégé.
Une fois la protection d’un groupe de tables ôtée, il devient à nouveau possible d’effectuer tous types de rollback sur le groupe.
Un mécanisme de protection au niveau des marques complète ce dispositif.
Arrêt forcé d’un groupe de tables
Il peut arriver qu’un groupe de tables endommagé ne puisse pas être arrêté. C’est par exemple le cas si une table applicative du groupe de tables a été supprimée par inadvertance alors que ce dernier était actif. Si les fonctions usuelles emaj_stop_group() ou emaj_stop_groups() retournent une erreur, il est possible de forcer l’arrêt d’une groupe de tables à l’aide de la fonction emaj_force_stop_group().
SELECT emaj.emaj_force_stop_group('<nom.du.groupe>');
La fonction retourne le nombre de tables et de séquences contenues dans le groupe.
Cette fonction emaj_force_stop_group() effectue le même traitement que la fonction emaj_stop_group(), Elle présente néanmoins les différences suivantes :
elle gère les éventuelles absences des tables et triggers E-Maj à désactiver, des messages de type « Warning » étant générés dans ces cas,
elle ne pose PAS de marque d’arrêt.
Une fois la fonction exécutée, le groupe de tables est en état « IDLE ». Il peut alors être supprimé avec la fonction emaj_drop_group().
Il est recommandé de n’utiliser cette fonction qu’en cas de réel besoin.
Suppression forcée d’un groupe de tables
Il peut arriver qu’un groupe de tables endommagé ne puisse pas être arrêté. Mais n’étant pas arrêté, il est impossible de le supprimer. Pour néanmoins pouvoir supprimer un groupe de tables en état actif, une fonction spéciale est disponible.
SELECT emaj.emaj_force_drop_group('<nom.du.groupe>');
La fonction retourne le nombre de tables et de séquences contenues dans le groupe.
Cette fonction emaj_force_drop_group() effectue le même traitement que la fonction emaj_drop_group(), mais sans contrôler l’état du groupe au préalable. Il est recommandé de n’utiliser cette fonction qu’en cas de réel besoin.
Note
Depuis la création de la fonction emaj_force_stop_group(), cette fonction emaj_force_drop_group() devient en principe inutile. Elle est susceptible de disparaître dans une future version d’E-Maj.
Exporter et importer des configurations de groupes de tables
Un jeu de fonctions permet d’exporter et d’importer des configurations de groupes de tables. Elles peuvent être utiles pour déployer un jeu standardisé de configuration de groupes de tables sur plusieurs bases de données ou lors de changements de version E-Maj par désinstallation et réinstallation complète de l’extension.
Export d’une configuration de groupes de tables
Deux versions de la fonction emaj_export_groups_configuration() exportent sous forme de structure JSON une description d’un ou plusieurs groupes de tables.
On peut écrire dans un fichier une configuration de groupes de tables par :
SELECT emaj_export_groups_configuration('<chemin.fichier>', <tableau.noms.groupes>);
Le chemin du fichier doit être accessible en écriture par l’instance PostgreSQL.
Le seconde paramètre, optionnel, liste sous forme d’un tableau les groupes de tables dont on souhaite exporter la configuration. Si le paramètre est absent ou valorisé à NULL, tous les groupes de tables existants sont exportés.
La fonction retourne le nombre de groupes de tables exportés.
Si le chemin du fichier n’est pas renseigné (i.e. est valorisé à NULL), la fonction retourne directement la structure JSON contenant la configuration des groupes de tables. Cette structure ressemble à ceci :
{
"_comment": "Generated on database <db> with E-Maj version <version> at <date_heure>",
"tables_groups": [
{
"group": "ggg",
"is_rollbackable": true|false,
"comment": "ccc",
"tables": [
{
"schema": "sss",
"table": "ttt",
"priority": ppp,
"log_data_tablespace": "lll",
"log_index_tablespace": "lll",
"ignored_triggers": [ "tg1", "tg2", ... ]
},
{
...
}
],
"sequences": [
{
"schema": "sss",
"sequence": "sss",
},
{
...
}
],
},
...
]
}
Import d’une configuration de groupes de tables
Deux versions de la fonction emaj_import_groups_configuration() importent des groupes de tables décrits sous la forme de structure JSON.
On peut charger une configuration de groupes de tables à partir d’un fichier par :
SELECT emaj_import_groups_configuration('<chemin.fichier>' [,<tableau.noms.groupes> [,<modifier.groupes.démarrés> [,<marque> ]]]);
Le fichier doit être accessible par l’instance PostgreSQL.
Le fichier doit contenir une structure JSON ayant un attribut nommé « tables-groups » de type tableau, et contenant des sous-structures décrivant chaque groupe de tables, tels que décrits ci-dessus pour l’exportation de configurations de groupes de tables.
La fonction peut directement charger un fichier généré par la fonction emaj_export_groups_configuration().
Le second paramètre est de type tableau et est optionnel. Il indique la liste des groupes de tables que l’on veut importer. Par défaut, tous les groupes de tables décrits dans le fichier sont importés.
Si un groupe de tables à importer n’existe pas, il est créé et ses tables et séquences lui sont assignées.
Si un groupe de tables à importer existe déjà, sa configuration est ajustée pour refléter la configuration cible. Des tables et séquences peuvent être ajoutées ou retirées, et des attributs peuvent être modifiés. Dans le cas où le groupe de tables est démarré, l’ajustement de sa configuration n’est possible que si le troisième paramètre, de type booléen, est explicitement positionné à TRUE.
Le quatrième paramètre définit la marque à poser sur les groupes de tables actifs. Par défaut la marque générée est « IMPORT_% », où le caractère “%” représente l’heure courante, au format « hh.mn.ss.mmmm ».
La fonction retourne le nombre de groupes de tables importés.
Dans une variante de la fonction, le premier paramètre en entrée contient directement la structure JSON des groupes de tables à charger
SELECT emaj_import_groups_configuration('<structure.JSON>'[,<tableau.noms.groupes> [,<modifier.groupes.démarrés> [,<marque> ]]]);
Effacer les traces de suppression d’un groupe de tables
Lorsqu’un groupe de tables est supprimé, des données sur sa vie antérieure (créations, suppressions, démarrages et arrêts) sont conservées dans deux tables d’historiques, avec une même rétention que les autres données historiques. Mais en cas de suppression d’un groupe de tables qui a été créé par erreur, il peut s’avérer utile d’effacer immédiatement ces traces, afin de ne pas polluer ces historiques. Pour ce faire, une fonction spéciale est disponible :
SELECT emaj.emaj_forget_group('<nom.du.groupe>');
Le groupe de tables ne doit plus exister.
La fonction retourne le nombre de traces supprimées.