Carbonite.Migrations (Carbonite v0.1.0) View Source

Functions to setup Carbonite transaction logs in your migrations.

Link to this section Summary

Types

carbonite_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 transaction log from the database.

drop_trigger(table_name, opts \\ [])

Removes a change capture trigger from a table.

install_schema(opts \\ [])

Installs a Carbonite transaction log.

install_trigger(table_name, opts \\ [])

Installs a change capture trigger on a table.

Link to this section Types

carbonite_option()

Specs

carbonite_option() :: {:prefix, String.t()}

table_name()

Specs

table_name() :: String.t()

trigger_config_option()

Specs

trigger_config_option() :: {:excluded_columns, [String.t()]}

trigger_option()

Specs

trigger_option() ::
  {:table_prefix, String.t()} | {:carbonite_prefix, String.t()}

Link to this section Functions

configure_trigger(table_name, opts \\ [])

Specs

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

Alters a triggers configuration for a given table.

Options

table_prefix is the name of the schema the table lives in
carbonite_prefix is the schema of the transaction log, defaults to "carbonite_default"
excluded_columns is a list of columns to exclude from change captures

drop_schema(opts \\ [])

Specs

drop_schema([carbonite_option()]) :: :ok

Removes a Carbonite transaction log from the database.

Options

prefix defines the transaction log's schema, defaults to "carbonite_default"

drop_trigger(table_name, opts \\ [])

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 transaction log, defaults to "carbonite_default"

install_schema(opts \\ [])

Specs

install_schema([carbonite_option()]) :: :ok

Installs a Carbonite transaction log.

Options

prefix defines the transaction log's schema, defaults to "carbonite_default"

install_trigger(table_name, opts \\ [])

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 transaction log, defaults to "carbonite_default"
excluded_columns is a list of columns to exclude from change captures