API

sqlalchemy_postgresql_audit.enable()

Enable the advanced inspector and enables sqlalchemy and alembic event listeners.

sqlalchemy_postgresql_audit.set_session_vars(connectable, **kwargs)

Wrapper to set session settings.

This must be set in a transaction in order for these settings to be present.

Typical use cases would be a username coming from a web request, or a request UUID or a script name.

Parameters:

• connectable – A connectable that we can execute on.
• kwargs – key/value pairs of values to set.

Returns:

None

sqlalchemy_postgresql_audit.install_audit_triggers(metadata, engine=None)

Installs all audit triggers.

This can be used after calling metadata.create_all() to create all the procedures and triggers.

Parameters:

• metadata – A sqlalchemy.sql.schema.MetaData
• engine – A sqlalchemy.engine.Engine or None

Returns:

None or a str for the DDL needed to install all audit triggers.

sqlalchemy_postgresql_audit.uninstall_audit_triggers(metadata, engine=None)

Uninstalls all audit triggers.

This can be used to remove all audit triggers.

Parameters:

• metadata – A sqlalchemy.sql.schema.MetaData
• engine – A sqlalchemy.engine.Engine or None

Returns:

None or a str for the DDL needed to uninstall all audit triggers.