API Reference mscmp_syst_db v#0.1.0

A database management Component for developing and managing database-per-tenant oriented systems. To achieve this we wrap and extend the popular Ecto and EctoSql libraries with a specialized templated (EEx) migrations system and add additional, opinionated abstractions encapsulating the tenant model as it relates to development, data access, and runtime concerns.

Provides basic OTP related features for Datastores.

Provides basic OTP related features for Datastore Contexts.

Defines the common functions which should be implemented for all custom DbTypes implemented in MscmpSystDb.

An Elixir representation of the PostgreSQL daterange data type.

An Elixir representation of the PostgreSQL tstzrange data type.

An Elixir representation of the PostgreSQL numrange data type.

An Elixir representation of the PostgreSQL inet and cidr data types.

An Elixir representation of the PostgreSQL int8range data type.

An Elixir representation of the PostgreSQL interval data type.

Defines the common functions which should be implemented for all database range types.

Provides common attributes for use by most application Ecto Schema instances.

Defines public types for use with the MscmpSystDb module.

The comparison operators for both the lower and upper bounds of a range type.

A struct for reporting the runtime state of Datastore Contexts.

A struct defining an application level security context which maps to a specific database role.

A struct defining the connection parameters to use to connect to a Datastore backing database.

Provides the definition of a database server which can back application instances.

Defines errors and related metadata for MscmpSystDb component errors.

Builds database sources into their respective migrations according to build plans.

Drops a previously loaded development supporting Datastore.

Loads the identified Datastore "type" into a testing/development oriented database server.