ExESDB.UmbrellaHelper (ex_esdb v0.11.0)

Helper module for starting ExESDB with umbrella configuration patterns.

This module provides functions to start ExESDB with app-specific configurations when used in umbrella applications.

Summary

Functions

Start ExESDB with configuration from a specific OTP app.

Configure ExESDB to use the specified OTP app for configuration.

Start ExESDB with configuration from a specific OTP app.

Functions

child_spec(otp_app)

Start ExESDB with configuration from a specific OTP app.

This function configures ExESDB to read its configuration from the specified OTP app instead of the global :ex_esdb application.

Parameters

  • otp_app - The OTP application name to read configuration from

Examples

# In your reckon app's application.ex:
def start(_type, _args) do
  children = [
    # Other children...
    ExESDB.UmbrellaHelper.child_spec(:reckon_accounts)
  ]

  Supervisor.start_link(children, strategy: :one_for_one)
end

configure(otp_app)

Configure ExESDB to use the specified OTP app for configuration.

This function sets up ExESDB to use app-specific configuration by setting the :otp_app configuration key.

start_link(otp_app)

Start ExESDB with configuration from a specific OTP app.

This is a convenience function that directly starts the ExESDB system with the specified OTP app configuration.