Skip to content

Latest commit

 

History

History
372 lines (364 loc) · 44 KB

functionsList.rst

File metadata and controls

372 lines (364 loc) · 44 KB
Raw

Liste des fonctions E-Maj

Les fonctions E-Maj disponibles pour les utilisateurs peuvent être regroupées en trois catégories. Elles sont listées ci-dessous par ordre alphabétique.

Toutes ces fonctions sont appelables par les rôles disposant des privilèges emaj_adm. Les tableaux précisent celles qui sont également appelables par les rôles emaj_viewer (marque (V) derrière le nom de la fonction).

Fonctions de niveau tables et séquences

Fonctions Paramètres en entrée Données restituées
:ref:`emaj_assign_sequence <assign_table_sequence>`
schéma TEXT,
séquence TEXT,
groupe TEXT,
[ marque TEXT ]
 1 INT
:ref:`emaj_assign_sequences <assign_table_sequence>`
schéma TEXT,
tableau.séquences TEXT[],
groupe TEXT,
[ marque TEXT ]
 nb.séquences INT
:ref:`emaj_assign_sequences <assign_table_sequence>`
schéma TEXT,
filtre.séquences.à.inclure
TEXT,
filtre.séquences.à.exclure
TEXT,
groupe TEXT,
[ marque TEXT ]
 nb.séquences INT
:ref:`emaj_assign_table <assign_table_sequence>`
schéma TEXT,
table TEXT,
groupe TEXT,
[ propriétés JSONB ]
[ marque TEXT ]
 1 INT
:ref:`emaj_assign_tables <assign_table_sequence>`
schéma TEXT,
tableau.tables TEXT[],
groupe TEXT,
[ propriétés JSONB ]
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_assign_tables <assign_table_sequence>`
schéma TEXT,
filtre.tables.à.inclure
TEXT,
filtre.tables.à.exclure
TEXT,
groupe TEXT,
[ propriétés JSONB ]
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_get_current_log_table <emaj_get_current_log_table>` (V)
schéma TEXT,
table TEXT
 (schéma.log TEXT, table.log TEXT)
:ref:`emaj_modify_table <modify_table>`
schéma TEXT,
table TEXT,
propriétés JSONB,
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_modify_tables <modify_table>`
schéma TEXT,
tableau.tables TEXT[],
propriétés JSONB,
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_modify_tables <modify_table>`
schéma TEXT,
filtre.tables.à.inclure
TEXT,
filtre.tables.à.exclure
TEXT,
propriétés JSONB,
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_move_sequence <move_table_sequence>`
schéma TEXT,
séquence TEXT,
nouveau.groupe TEXT,
[ marque TEXT ]
 1 INT
:ref:`emaj_move_sequences <move_table_sequence>`
schéma TEXT,
tableau.séquences TEXT[],
nouveau.groupe TEXT,
[ marque TEXT ]
 nb.séquences INT
:ref:`emaj_move_sequences <move_table_sequence>`
schéma TEXT,
filtre.séquences.à.inclure
TEXT,
filtre.séquences.à.exclure
TEXT,
nouveau.groupe TEXT,
[ marque TEXT ]
 nb.séquences INT
:ref:`emaj_move_table <move_table_sequence>`
schéma TEXT,
table TEXT,
nouveau.groupe TEXT,
[ marque TEXT ]
 1 INT
:ref:`emaj_move_tables <move_table_sequence>`
schéma TEXT,
tableau.tables TEXT[],
nouveau.groupe TEXT,
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_move_tables <move_table_sequence>`
schéma TEXT,
filtre.tables.à.inclure
TEXT,
filtre.tables.à.exclure
TEXT,
nouveau.groupe TEXT,
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_remove_sequence <remove_table_sequence>`
schéma TEXT,
séquence TEXT,
[ marque TEXT ]
 1 INT
:ref:`emaj_remove_sequences <remove_table_sequence>`
schéma TEXT,
tableau.séquences TEXT[],
[ marque TEXT ]
 nb.séquences INT
:ref:`emaj_remove_sequences <remove_table_sequence>`
schéma TEXT,
filtre.séquences.à.inclure
TEXT,
filtre.séquences.à.exclure
TEXT,
[ marque TEXT ]
 nb.séquences INT
:ref:`emaj_remove_table <remove_table_sequence>`
schéma TEXT,
table TEXT,
[ marque TEXT ]
 1 INT
:ref:`emaj_remove_tables <remove_table_sequence>`
schéma TEXT,
tableau.tables TEXT[],
[ marque TEXT ]
 nb.tables INT
:ref:`emaj_remove_tables <remove_table_sequence>`
schéma TEXT,
filtre.tables.à.inclure
TEXT,
filtre.tables.à.exclure
TEXT,
[ marque TEXT ]
 nb.tables INT

Fonctions de niveau groupe de tables

Fonctions Paramètres en entrée Données restituées
:ref:`emaj_comment_group <emaj_comment_group>`
groupe TEXT,
commentaire TEXT
  
:ref:`emaj_comment_mark_group <emaj_comment_mark_group>`
groupe TEXT,
marque TEXT,
commentaire TEXT
  
:ref:`emaj_consolidate_rollback_group <emaj_consolidate_rollback_group>`
groupe TEXT,
marque.fin.rollback TEXT
 nb.tables.et.seq INT
:ref:`emaj_create_group <emaj_create_group>`
groupe TEXT,
[est.rollbackable BOOLEAN]
 1 INT
:ref:`emaj_delete_before_mark_group <emaj_delete_before_mark_group>`
groupe TEXT,
marque TEXT
 nb.marques.supprimées INT
:ref:`emaj_delete_mark_group <emaj_delete_mark_group>`
groupe TEXT,
marque TEXT
 1 INT
:ref:`emaj_detailed_log_stat_group <emaj_detailed_log_stat_group>` (V)
groupe TEXT,
marque.début TEXT,
marque.fin TEXT
 SETOF emaj_detailed_log_stat_type
:doc:`emaj_detailed_log_stat_groups <multiGroupsFunctions>` (V)
tableau.groupes TEXT[],
marque.début TEXT,
marque.fin TEXT
 SETOF emaj_detailed_log_stat_type
:ref:`emaj_drop_group <emaj_drop_group>`
groupe TEXT
 nb.tables.et.seq INT
:ref:`emaj_dump_changes_group <emaj_dump_changes_group>`
groupe TEXT,
marque.début TEXT,
marque.fin TEXT,
liste.options TEXT,
tableau.tables.seq TEXT[],
répertoire TEXT
 msg.nb.fichiers INT
:ref:`emaj_estimate_rollback_group <emaj_estimate_rollback_group>` (V)
groupe TEXT,
marque TEXT,
est.tracé BOOLEAN
 durée INTERVAL
:doc:`emaj_estimate_rollback_groups <multiGroupsFunctions>` (V)
tableau.groupes TEXT[],
marque TEXT,
est.tracé BOOLEAN
 durée INTERVAL
:ref:`emaj_force_drop_group <emaj_force_drop_group>`
groupe TEXT
 nb.tables.et.seq INT
:ref:`emaj_force_stop_group <emaj_force_stop_group>`
groupe TEXT
 nb.tables.et.seq INT
:ref:`emaj_gen_sql_dump_changes_group <emaj_gen_sql_dump_changes_group>`
groupe TEXT,
marque.début TEXT,
marque.fin TEXT,
liste.options TEXT,
tableau.tables.seq TEXT[]
 msg.nb.requêtes INT
:ref:`emaj_gen_sql_dump_changes_group <emaj_gen_sql_dump_changes_group>`
groupe TEXT,
marque.début TEXT,
marque.fin TEXT,
liste.options TEXT,
tableau.tables.seq TEXT[],
fichier.sortie TEXT
 msg.nb.requêtes INT
:ref:`emaj_gen_sql_group <emaj_gen_sql_group>`
groupe TEXT,
marque.début TEXT,
marque.fin TEXT,
fichier.sortie TEXT,
[tableau.tables.seq TEXT[]]
 nb.req.générées BIGINT
:doc:`emaj_gen_sql_groups <multiGroupsFunctions>`
tableau.groupes TEXT[],
marque.début TEXT,
marque.fin TEXT,
fichier.sortie TEXT,
[tableau.tables.seq TEXT[]]
 nb.req.générées BIGINT
:ref:`emaj_get_previous_mark_group <emaj_get_previous_mark_group>` (V)
groupe TEXT,
date.heure TIMESTAMPTZ
 marque TEXT
:ref:`emaj_get_previous_mark_group <emaj_get_previous_mark_group>` (V)
groupe TEXT,
marque TEXT
 marque TEXT
:ref:`emaj_log_stat_group <emaj_log_stat_group>` (V)
groupe TEXT,
marque.début TEXT,
marque.fin TEXT
 SETOF emaj_log_stat_type
:doc:`emaj_log_stat_groups <multiGroupsFunctions>` (V)
tableau.groupes TEXT[],
marque.début TEXT,
marque.fin TEXT
 SETOF emaj_log_stat_type
:ref:`emaj_logged_rollback_group <emaj_logged_rollback_group>`
groupe TEXT,
marque TEXT,
[est.modif.groupe.autorisée
BOOLEAN]
[commentaire TEXT]
 SETOF (sévérité TEXT, message TEXT)
:doc:`emaj_logged_rollback_groups <multiGroupsFunctions>`
tableau.groupes TEXT[],
marque TEXT,
[est.modif.groupe.autorisée
BOOLEAN]
[commentaire TEXT]
 SETOF (sévérité TEXT, message TEXT)
:ref:`emaj_protect_group <emaj_protect_group>`
groupe TEXT
 0/1 INT
:ref:`emaj_protect_mark_group <emaj_protect_mark_group>`
groupe TEXT,
marque TEXT
 0/1 INT
:ref:`emaj_rename_mark_group <emaj_rename_mark_group>`
groupe TEXT,
marque TEXT,
nouveau.nom TEXT
  
:ref:`emaj_reset_group <emaj_reset_group>`
groupe TEXT
 nb.tables.et.seq INT
:ref:`emaj_rollback_group <emaj_rollback_group>`
groupe TEXT,
marque TEXT,
[est_modif_groupe_autorisé
BOOLEAN]
[commentaire TEXT]
 SETOF (sévérité TEXT, message TEXT)
:doc:`emaj_rollback_groups <multiGroupsFunctions>`
tableau.groupes TEXT[],
marque TEXT,
[est_modif_groupe_autorisé
BOOLEAN]
[commentaire TEXT]
 SETOF (sévérité TEXT, message TEXT)
:ref:`emaj_sequence_stat_group <emaj_sequence_stat_group>` (V)
groupe TEXT,
marque.début TEXT,
marque.fin TEXT
 SETOF emaj_sequence_stat_type
:doc:`emaj_sequence_stat_groups <multiGroupsFunctions>` (V)
tableau.groupes TEXT[],
marque.début TEXT,
marque.fin TEXT
 SETOF emaj_sequence_stat_type
:ref:`emaj_set_mark_group <emaj_set_mark_group>`
groupe TEXT,
[marque TEXT]
 nb.tables.et.seq INT
:doc:`emaj_set_mark_groups <multiGroupsFunctions>`
tableau.groupes TEXT[],
[marque TEXT]
 nb.tables.et.seq INT
:ref:`emaj_snap_group <emaj_snap_group>`
groupe TEXT,
répertoire TEXT,
options.copy TEXT
 nb.tables.et.seq INT
:ref:`emaj_start_group <emaj_start_group>`
groupe TEXT,
[marque TEXT],
[reset.log BOOLEAN]
 nb.tables.et.seq INT
:doc:`emaj_start_groups <multiGroupsFunctions>`
tableau.groupes TEXT[],
[marque TEXT],
[reset.log BOOLEAN]
 nb.tables.et.seq INT
:ref:`emaj_stop_group <emaj_stop_group>`
groupe TEXT,
[marque TEXT]
 nb.tables.et.seq INT
:doc:`emaj_stop_groups <multiGroupsFunctions>`
tableau.groupes TEXT[],
[marque TEXT]
 nb.tables.et.seq INT
:ref:`emaj_unprotect_group <emaj_unprotect_group>`
groupe TEXT
 0/1 INT
:ref:`emaj_unprotect_mark_group <emaj_unprotect_mark_group>`
groupe TEXT,
marque TEXT
 0/1 INT

Fonctions de niveau général

Fonctions Paramètres en entrée Données restituées
:ref:`emaj_cleanup_rollback_state <emaj_cleanup_rollback_state>`   nb.rollback INT
:ref:`emaj_comment_rollback <emaj_comment_rollback>`
id.rollback INT,
commentaire TEXT
  
:ref:`emaj_disable_protection_by_event_triggers <emaj_disable_protection_by_event_triggers>`   nb.triggers INT
:ref:`emaj_enable_protection_by_event_triggers <emaj_enable_protection_by_event_triggers>`   nb.triggers INT
:ref:`emaj_export_groups_configuration <export_groups_conf>`
NULL,
[tableau.groupes TEXT[]]
 configuration JSON
:ref:`emaj_export_groups_configuration <export_groups_conf>`
fichier TEXT,
[tableau.groupes TEXT[]]
 nb.groupes INT
:ref:`emaj_export_parameters_configuration <export_param_conf>`   paramètres JSON
:ref:`emaj_export_parameters_configuration <export_param_conf>` fichier TEXT nb.paramètres INT
:ref:`emaj_get_consolidable_rollbacks <emaj_get_consolidable_rollbacks>` (V)   SETOF emaj_consolidable_rollback_type
:ref:`emaj_import_groups_configuration <import_groups_conf>`
groupes JSON,
[tableau.groupes TEXT[]],
[traiter.groupes.démarrés
BOOLEAN],
[marque TEXT]
 nb.groupes INT
:ref:`emaj_import_groups_configuration <import_groups_conf>`
fichier TEXT,
[tableau.groupes TEXT[]],
[traiter.groupes.démarrés
BOOLEAN],
[marque TEXT]
 nb.groupes INT
:ref:`emaj_import_parameters_configuration <import_param_conf>`
paramètres JSON,
[suppression.conf BOOLEAN)]
 nb.paramètres INT
:ref:`emaj_import_parameters_configuration <import_param_conf>`
fichier TEXT,
[suppression.conf BOOLEAN)]
 nb.paramètres INT
:ref:`emaj_purge_histories <emaj_purge_histories>` délai.rétention INTERVAL  
:ref:`emaj_rollback_activity <emaj_rollback_activity>` (V)   SETOF emaj_rollback_activity_type
:ref:`emaj_verify_all <emaj_verify_all>` (V)   SETOF TEXT