Carbonite v0.2.0

Carbonite.Migrations (Carbonite v0.2.0) View Source

Functions to setup Carbonite audit trails in your migrations.

Link to this section Summary

Types

column_name()
prefix()
schema_option()
table_name()
trigger_config_option()
trigger_option()

Functions

configure_trigger(table_name, opts \\ [])

Alters a triggers configuration for a given table.

drop_schema(opts \\ [])

Removes a Carbonite audit trail from the database.

drop_trigger(table_name, opts \\ [])

Removes a change capture trigger from a table.

install_schema(opts \\ [])

Installs a Carbonite audit trail.

install_trigger(table_name, opts \\ [])

Installs a change capture trigger on a table.

Link to this section Types

Link to this type

column_name()

View Source

Specs

column_name() :: binary()
Link to this type

prefix()

View Source

Specs

prefix() :: binary() | atom()
Link to this type

schema_option()

View Source

Specs

schema_option() :: {:carbonite_prefix, prefix()}
Link to this type

table_name()

View Source

Specs

table_name() :: binary() | atom()
Link to this type

trigger_config_option()

View Source

Specs

trigger_config_option() ::
  {:primary_key_columns, [column_name()]}
  | {:excluded_columns, [column_name()]}
  | {:mode, :capture | :ignore}
Link to this type

trigger_option()

View Source

Specs

trigger_option() :: {:table_prefix, prefix()} | {:carbonite_prefix, prefix()}

Link to this section Functions

Link to this function

configure_trigger(table_name, opts \\ [])

View Source

Specs

configure_trigger(table_name(), [trigger_option() | trigger_config_option()]) ::
  :ok

Alters a triggers configuration for a given table.

You need to specify all desired options each time you call this function, as the previous configuration will be replaced.

Options

  • table_prefix is the name of the schema the table lives in
  • carbonite_prefix is the schema of the audit trail, defaults to "carbonite_default"
  • primary_key_columns is a list of columns that form the primary key of the table
                      (defaults to `["id"]`, set to `[]` to disable)
  • excluded_columns is a list of columns to exclude from change captures
  • filtered_columns is a list of columns that appear as '[FILTERED]' in the data
  • mode is either :capture or :ignore and defines the default behaviour of the trigger
Link to this function

drop_schema(opts \\ [])

View Source

Specs

drop_schema([schema_option()]) :: :ok

Removes a Carbonite audit trail from the database.

Options

  • prefix defines the audit trail's schema, defaults to "carbonite_default"
Link to this function

drop_trigger(table_name, opts \\ [])

View Source

Specs

drop_trigger(table_name(), [trigger_option()]) :: :ok

Removes a change capture trigger from a table.

Options

  • table_prefix is the name of the schema the table lives in
  • carbonite_prefix is the schema of the audit trail, defaults to "carbonite_default"
Link to this function

install_schema(opts \\ [])

View Source

Specs

install_schema([schema_option()]) :: :ok

Installs a Carbonite audit trail.

Options

  • carbonite_prefix defines the audit trail's schema, defaults to "carbonite_default"
Link to this function

install_trigger(table_name, opts \\ [])

View Source

Specs

install_trigger(table_name(), [trigger_option() | trigger_config_option()]) ::
  :ok

Installs a change capture trigger on a table.

Options

  • table_prefix is the name of the schema the table lives in
  • carbonite_prefix is the schema of the audit trail, defaults to "carbonite_default"
  • primary_key_columns is a list of columns that form the primary key of the table
                      (defaults to `["id"]`, set to `[]` to disable)
  • excluded_columns is a list of columns to exclude from change captures
  • filtered_columns is a list of columns that appear as '[FILTERED]' in the data