Carbonite.Migrations (Carbonite v0.4.0) View Source
Functions to setup Carbonite audit trails in your migrations.
Link to this section Summary
Functions
Inserts an outbox record into the database.
Installs a change capture trigger on a table.
Rollback a migration.
Removes an outbox record.
Removes a change capture trigger from a table.
Allows to update a trigger configuration option for a given table.
Runs one of Carbonite's migrations.
Link to this section Types
Specs
Specs
outbox_name() :: String.t()
Specs
outbox_option() :: {:carbonite_prefix, prefix()}
Specs
patch() :: non_neg_integer()
Specs
prefix() :: binary()
Specs
Specs
trigger_config_key() :: :table_prefix | :primary_key_columns | :excluded_columns | :mode
Specs
Specs
up_option() :: {:carbonite_prefix, prefix()}
Link to this section Functions
Specs
create_outbox(outbox_name(), [outbox_option()]) :: :ok
Inserts an outbox record into the database.
Options
carbonite_prefixis the schema of the audit trail, defaults to"carbonite_default"
Specs
create_trigger(table_name(), [trigger_option()]) :: :ok
Installs a change capture trigger on a table.
Options
table_prefixis the name of the schema the table lives incarbonite_prefixis the schema of the audit trail, defaults to"carbonite_default"
Specs
down(patch(), [down_option()]) :: :ok
Rollback a migration.
Options
carbonite_prefixdefines the audit trail's schema, defaults to"carbonite_default"drop_schemacontrols whether the initial migration deletes the schema during rollback
Specs
drop_outbox(outbox_name(), [outbox_option()]) :: :ok
Removes an outbox record.
Options
carbonite_prefixis the schema of the audit trail, defaults to"carbonite_default"
Specs
drop_trigger(table_name(), [trigger_option()]) :: :ok
Removes a change capture trigger from a table.
Options
table_prefixis the name of the schema the table lives incarbonite_prefixis the schema of the audit trail, defaults to"carbonite_default"
put_trigger_config(table_name, key, value, opts \\ [])
View Source (since 0.4.0)Specs
put_trigger_config(table_name(), trigger_config_key(), any(), [trigger_option()]) :: :ok
Allows to update a trigger configuration option for a given table.
This function builds an SQL UPDATE statement that can be used within a database migration to
update a setting stored in Carbonite's triggers table without using the Carbonite.Trigger
schema or other application-level code that is prone to change over time. This helps to ensure
that your data migrations continue to function, regardless of future updates to Carbonite.
Configuration values
primary_key_columnsis a list of columns that form the primary key of the table(defaults to `["id"]`, set to `[]` to disable)excluded_columnsis a list of columns to exclude from change capturesfiltered_columnsis a list of columns that appear as '[FILTERED]' in the datamodeis either:captureor:ignoreand defines the default behaviour of the trigger
Example
Carbonite.Migrations.put_trigger_config("rabbits", :excluded_columns, ["name"])Options
table_prefixis the name of the schema the table lives incarbonite_prefixis the schema of the audit trail, defaults to"carbonite_default"
Specs
Runs one of Carbonite's migrations.
Migration patchlevels
Make sure that you run all migrations in your host application.
- Initial patch: 1
- Current patch: 2
Options
carbonite_prefixdefines the audit trail's schema, defaults to"carbonite_default"