E-Maj functions list

The E-Maj functions that are available to users can be grouped into 3 categories. They are listed below, in alphabetic order.

They are all callable by roles having emaj_adm privileges. The charts also specifys those callable by emaj_viewer roles (sign (V) behind the function name).

Tables or sequences level functions

Functions

Input parameters

Output data

emaj_assign_sequence
schema TEXT,
sequence TEXT,
group TEXT,
[ mark TEXT ]

1 INT

emaj_assign_sequences
schema TEXT,
sequences.array TEXT[],
group TEXT,
[ mark TEXT ]

#.sequences INT

emaj_assign_sequences
schema TEXT,
sequences.to.include.filter
TEXT,
sequences.to.exclude.filter
TEXT,
group TEXT,
[ mark TEXT ]

#.sequences INT

emaj_assign_table
schema TEXT,
table TEXT,
group TEXT,
[ properties JSONB ]
[ mark TEXT ]

1 INT

emaj_assign_tables
schema TEXT,
tables.array TEXT[],
group TEXT,
[ properties JSONB ]
[ mark TEXT ]

#.tables INT

emaj_assign_tables
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
group TEXT,
[ properties JSONB ]
[ mark TEXT ]

#.tables INT

emaj_get_current_log_table (V)
schema TEXT,
table TEXT

(log.schema TEXT, log.table TEXT)

emaj_modify_table
schema TEXT,
table TEXT,
properties JSONB,
[ mark TEXT ]

#.tables INT

emaj_modify_tables
schema TEXT,
tables.array TEXT[],
properties JSONB,
[ mark TEXT ]

#.tables INT

emaj_modify_tables
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
properties JSONB,
[ mark TEXT ]

#.tables INT

emaj_move_sequence
schema TEXT,
sequence TEXT,
new.group TEXT,
[ mark TEXT ]

1 INT

emaj_move_sequences
schema TEXT,
sequences.array TEXT[],
new.group TEXT,
[ mark TEXT ]

#.sequences INT

emaj_move_sequences
schema TEXT,
sequences.to.include.filter
TEXT,
sequences.to.exclude.filter
TEXT,
new.group TEXT,
[ mark TEXT ]

#.sequences INT

emaj_move_table
schema TEXT,
table TEXT,
new.group TEXT,
[ mark TEXT ]

1 INT

emaj_move_tables
schema TEXT,
tables.array TEXT[],
new.group TEXT,
[ mark TEXT ]

#.tables INT

emaj_move_tables
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
new.group TEXT,
[ mark TEXT ]

#.tables INT

emaj_remove_sequence
schema TEXT,
sequence TEXT,
[ mark TEXT ]

1 INT

emaj_remove_sequences
schema TEXT,
sequences.array TEXT[],
[ mark TEXT ]

#.sequences INT

emaj_remove_sequences
schema TEXT,
sequences.to.include.filter
TEXT,
sequences.to.exclude.filter
TEXT,
[ mark TEXT ]

#.sequences INT

emaj_remove_table
schema TEXT,
table TEXT,
[ mark TEXT ]

1 INT

emaj_remove_tables
schema TEXT,
tables.array TEXT[],
[ mark TEXT ]

#.tables INT

emaj_remove_tables
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
[ mark TEXT ]

#.tables INT

Groups level functions

Functions

Input parameters

Output data

emaj_comment_group
group TEXT,
comment TEXT

emaj_comment_mark_group
group TEXT,
mark TEXT,
comment TEXT

emaj_consolidate_rollback_group
group TEXT,
end.rollback.mark TEXT

#.tables.and.seq INT

emaj_create_group
group TEXT,
[is.rollbackable BOOLEAN]

1 INT

emaj_delete_before_mark_group
group TEXT,
mark TEXT

#.deleted.marks INT

emaj_delete_mark_group
group TEXT,
mark TEXT

1 INT

emaj_detailed_log_stat_group (V)
group TEXT,
start.mark TEXT,
end.mark TEXT

SETOF emaj_detailed_log_stat_type

emaj_detailed_log_stat_groups (V)
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT

SETOF emaj_detailed_log_stat_type

emaj_drop_group
group TEXT

#.tables.and.seq INT

emaj_dump_changes_group
group TEXT,
start.mark TEXT,
end.mark TEXT,
options.list TEXT
tables.seq.array TEXT[]
output.directory TEXT,

msg.#.files BIGINT

emaj_estimate_rollback_group (V)
group TEXT,
mark TEXT,
is.logged BOOLEAN

duration INTERVAL

emaj_estimate_rollback_groups (V)
groups.array TEXT[],
mark TEXT,
is.logged BOOLEAN

duration INTERVAL

emaj_force_drop_group
group TEXT

#.tables.and.seq INT

emaj_force_stop_group
group TEXT

#.tables.and.seq INT

emaj_forget_group
group TEXT

#.erased.traces INT

emaj_gen_sql_dump_changes_group (V)
group TEXT,
start.mark TEXT,
end.mark TEXT,
options.list TEXT
tables.seq.array TEXT[]

msg.#.statements BIGINT

emaj_gen_sql_dump_changes_group
group TEXT,
start.mark TEXT,
end.mark TEXT,
options.list TEXT
tables.seq.array TEXT[]
output.directory TEXT,

msg.#.statements BIGINT

emaj_gen_sql_group
group TEXT,
start.mark TEXT,
end.mark TEXT,
output.file.path TEXT,
[tables.seq.array TEXT[]]

#.gen.statements BIGINT

emaj_gen_sql_groups
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT,
output.file.path TEXT,
[tables.seq.array TEXT[]]

#.gen.statements BIGINT

emaj_get_previous_mark_group (V)
group TEXT,
date.time TIMESTAMPTZ

mark TEXT

emaj_get_previous_mark_group (V)
group TEXT,
mark TEXT

mark TEXT

emaj_log_stat_group (V)
group TEXT,
start.mark TEXT,
end.mark TEXT

SETOF emaj_log_stat_type

emaj_log_stat_groups (V)
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT

SETOF emaj_log_stat_type

emaj_logged_rollback_group
group TEXT,
mark TEXT,
[is.alter.group.allowed
BOOLEAN]
[comment TEXT]

SETOF (severity TEXT, message TEXT)

emaj_logged_rollback_groups
groups.array TEXT[],
mark TEXT,
[is.alter.group.allowed
BOOLEAN]
[comment TEXT]

SETOF (severity TEXT, message TEXT)

emaj_protect_group
group TEXT

0/1 INT

emaj_protect_mark_group
group TEXT,
mark TEXT

0/1 INT

emaj_rename_mark_group
group TEXT,
mark TEXT,
new.name TEXT

emaj_reset_group
group TEXT

#.tables.and.seq INT

emaj_rollback_group
group TEXT,
mark TEXT,
[is_alter_group_allowed
BOOLEAN]
[comment TEXT]

SETOF (severity TEXT, message TEXT)

emaj_rollback_groups
groups.array TEXT[],
mark TEXT,
[is_alter_group_allowed
BOOLEAN]
[comment TEXT]

SETOF (severity TEXT, message TEXT)

emaj_sequence_stat_group (V)
group TEXT,
start.mark TEXT,
end.mark TEXT

SETOF emaj_sequence_stat_type

emaj_sequence_stat_groups (V)
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT

SETOF emaj_sequence_stat_type

emaj_set_mark_group
group TEXT,
[mark TEXT]

#.tables.and.seq INT

emaj_set_mark_groups
groups.array TEXT[],
[mark TEXT]

#.tables.and.seq INT

emaj_snap_group
group TEXT,
directory TEXT,
copy.options TEXT

#.tables.and.seq INT

emaj_start_group
group TEXT,
[mark TEXT],
[reset.log BOOLEAN]

#.tables.and.seq INT

emaj_start_groups
groups.array TEXT[],
[mark TEXT],
[reset.log BOOLEAN]

#.tables.and.seq INT

emaj_stop_group
group TEXT,
[mark TEXT]

#.tables.and.seq INT

emaj_stop_groups
groups.array TEXT[],
[mark TEXT]

#.tables.and.seq INT

emaj_unprotect_group
group TEXT

0/1 INT

emaj_unprotect_mark_group
group TEXT,
mark TEXT

0/1 INT

General purpose functions

Functions

Input parameters

Output data

emaj_cleanup_rollback_state

#.rollback INT

emaj_comment_rollback
rollback.id INT,
comment TEXT

emaj_disable_protection_by_event_triggers

#.triggers INT

emaj_enable_protection_by_event_triggers

#.triggers INT

emaj_export_groups_configuration
NULL,
[groups.array TEXT[]]

configuration JSON

emaj_export_groups_configuration
file.path TEXT,
[groups.array TEXT[]]

#.groups INT

emaj_export_parameters_configuration

parameters JSON

emaj_export_parameters_configuration

file.path TEXT

#.parameters INT

emaj_get_consolidable_rollbacks (V)

SETOF emaj_consolidable_rollback_type

emaj_get_version (V)

version TEXT

emaj_import_groups_configuration
groups JSON,
[groups.array TEXT[]],
[alter.logging.groups
BOOLEAN],
[mark TEXT]

#.groups INT

emaj_import_groups_configuration
file.path TEXT,
[groups.array TEXT[]],
[alter.logging.groups
BOOLEAN],
[mark TEXT]

#.groups INT

emaj_import_parameters_configuration
parameters JSON,
[delete.conf BOOLEAN)]

#.parameters INT

emaj_import_parameters_configuration
file.path TEXT,
[delete.conf BOOLEAN)]

#.parameters INT

emaj_purge_histories

retention.delay INTERVAL

emaj_rollback_activity (V)

SETOF emaj_rollback_activity_type

emaj_verify_all (V)

SETOF TEXT