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 |
---|---|---|
schema TEXT,
sequence TEXT,
group TEXT,
[ mark TEXT ]
|
1 INT |
|
schema TEXT,
sequences.array TEXT[],
group TEXT,
[ mark TEXT ]
|
#.sequences INT |
|
schema TEXT,
sequences.to.include.filter
TEXT,
sequences.to.exclude.filter
TEXT,
group TEXT,
[ mark TEXT ]
|
#.sequences INT |
|
schema TEXT,
table TEXT,
group TEXT,
[ properties JSONB ]
[ mark TEXT ]
|
1 INT |
|
schema TEXT,
tables.array TEXT[],
group TEXT,
[ properties JSONB ]
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
group TEXT,
[ properties JSONB ]
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
table TEXT
|
(log.schema TEXT, log.table TEXT) |
|
schema TEXT,
table TEXT,
properties JSONB,
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
tables.array TEXT[],
properties JSONB,
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
properties JSONB,
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
sequence TEXT,
new.group TEXT,
[ mark TEXT ]
|
1 INT |
|
schema TEXT,
sequences.array TEXT[],
new.group TEXT,
[ mark TEXT ]
|
#.sequences INT |
|
schema TEXT,
sequences.to.include.filter
TEXT,
sequences.to.exclude.filter
TEXT,
new.group TEXT,
[ mark TEXT ]
|
#.sequences INT |
|
schema TEXT,
table TEXT,
new.group TEXT,
[ mark TEXT ]
|
1 INT |
|
schema TEXT,
tables.array TEXT[],
new.group TEXT,
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
new.group TEXT,
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
sequence TEXT,
[ mark TEXT ]
|
1 INT |
|
schema TEXT,
sequences.array TEXT[],
[ mark TEXT ]
|
#.sequences INT |
|
schema TEXT,
sequences.to.include.filter
TEXT,
sequences.to.exclude.filter
TEXT,
[ mark TEXT ]
|
#.sequences INT |
|
schema TEXT,
table TEXT,
[ mark TEXT ]
|
1 INT |
|
schema TEXT,
tables.array TEXT[],
[ mark TEXT ]
|
#.tables INT |
|
schema TEXT,
tables.to.include.filter
TEXT,
tables.to.exclude.filter
TEXT,
[ mark TEXT ]
|
#.tables INT |
Groups level functions
Functions |
Input parameters |
Output data |
---|---|---|
group TEXT,
comment TEXT
|
||
group TEXT,
mark TEXT,
comment TEXT
|
||
group TEXT,
end.rollback.mark TEXT
|
#.tables.and.seq INT |
|
group TEXT,
[is.rollbackable BOOLEAN]
|
1 INT |
|
group TEXT,
mark TEXT
|
#.deleted.marks INT |
|
group TEXT,
mark TEXT
|
1 INT |
|
group TEXT,
start.mark TEXT,
end.mark TEXT
|
SETOF emaj_detailed_log_stat_type |
|
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT
|
SETOF emaj_detailed_log_stat_type |
|
group TEXT
|
#.tables.and.seq INT |
|
group TEXT,
start.mark TEXT,
end.mark TEXT,
options.list TEXT
tables.seq.array TEXT[]
output.directory TEXT,
|
msg.#.files BIGINT |
|
group TEXT,
mark TEXT,
is.logged BOOLEAN
|
duration INTERVAL |
|
groups.array TEXT[],
mark TEXT,
is.logged BOOLEAN
|
duration INTERVAL |
|
group TEXT
|
#.tables.and.seq INT |
|
group TEXT
|
#.tables.and.seq INT |
|
group TEXT
|
#.erased.traces INT |
|
group TEXT,
start.mark TEXT,
end.mark TEXT,
options.list TEXT
tables.seq.array TEXT[]
|
msg.#.statements BIGINT |
|
group TEXT,
start.mark TEXT,
end.mark TEXT,
options.list TEXT
tables.seq.array TEXT[]
output.directory TEXT,
|
msg.#.statements BIGINT |
|
group TEXT,
start.mark TEXT,
end.mark TEXT,
output.file.path TEXT,
[tables.seq.array TEXT[]]
|
#.gen.statements BIGINT |
|
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT,
output.file.path TEXT,
[tables.seq.array TEXT[]]
|
#.gen.statements BIGINT |
|
group TEXT,
date.time TIMESTAMPTZ
|
mark TEXT |
|
group TEXT,
mark TEXT
|
mark TEXT |
|
group TEXT,
start.mark TEXT,
end.mark TEXT
|
SETOF emaj_log_stat_type |
|
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT
|
SETOF emaj_log_stat_type |
|
group TEXT,
mark TEXT,
[is.alter.group.allowed
BOOLEAN]
[comment TEXT]
|
SETOF (severity TEXT, message TEXT) |
|
groups.array TEXT[],
mark TEXT,
[is.alter.group.allowed
BOOLEAN]
[comment TEXT]
|
SETOF (severity TEXT, message TEXT) |
|
group TEXT
|
0/1 INT |
|
group TEXT,
mark TEXT
|
0/1 INT |
|
group TEXT,
mark TEXT,
new.name TEXT
|
||
group TEXT
|
#.tables.and.seq INT |
|
group TEXT,
mark TEXT,
[is_alter_group_allowed
BOOLEAN]
[comment TEXT]
|
SETOF (severity TEXT, message TEXT) |
|
groups.array TEXT[],
mark TEXT,
[is_alter_group_allowed
BOOLEAN]
[comment TEXT]
|
SETOF (severity TEXT, message TEXT) |
|
group TEXT,
start.mark TEXT,
end.mark TEXT
|
SETOF emaj_sequence_stat_type |
|
groups.array TEXT[],
start.mark TEXT,
end.mark TEXT
|
SETOF emaj_sequence_stat_type |
|
group TEXT,
[mark TEXT]
|
#.tables.and.seq INT |
|
groups.array TEXT[],
[mark TEXT]
|
#.tables.and.seq INT |
|
group TEXT,
directory TEXT,
copy.options TEXT
|
#.tables.and.seq INT |
|
group TEXT,
[mark TEXT],
[reset.log BOOLEAN]
|
#.tables.and.seq INT |
|
groups.array TEXT[],
[mark TEXT],
[reset.log BOOLEAN]
|
#.tables.and.seq INT |
|
group TEXT,
[mark TEXT]
|
#.tables.and.seq INT |
|
groups.array TEXT[],
[mark TEXT]
|
#.tables.and.seq INT |
|
group TEXT
|
0/1 INT |
|
group TEXT,
mark TEXT
|
0/1 INT |
General purpose functions
Functions |
Input parameters |
Output data |
---|---|---|
#.rollback INT |
||
rollback.id INT,
comment TEXT
|
||
#.triggers INT |
||
#.triggers INT |
||
NULL,
[groups.array TEXT[]]
|
configuration JSON |
|
file.path TEXT,
[groups.array TEXT[]]
|
#.groups INT |
|
parameters JSON |
||
file.path TEXT |
#.parameters INT |
|
SETOF emaj_consolidable_rollback_type |
||
emaj_get_version (V) |
version TEXT |
|
groups JSON,
[groups.array TEXT[]],
[alter.logging.groups
BOOLEAN],
[mark TEXT]
|
#.groups INT |
|
file.path TEXT,
[groups.array TEXT[]],
[alter.logging.groups
BOOLEAN],
[mark TEXT]
|
#.groups INT |
|
parameters JSON,
[delete.conf BOOLEAN)]
|
#.parameters INT |
|
file.path TEXT,
[delete.conf BOOLEAN)]
|
#.parameters INT |
|
retention.delay INTERVAL |
||
SETOF emaj_rollback_activity_type |
||
emaj_verify_all (V) |
SETOF TEXT |