API Reference PhoenixMountable v#0.2.1

Copy Markdown View Source

Modules

Build libraries that mount into a Phoenix app.

How a mountable library's CSS and JavaScript reach the browser.

Assets read, concatenated and gzipped at compile time, and served from memory under content-hashed URLs.

The host's own asset pipeline.

A directory of built files served under the mount.

Data migrations, kept apart from schema changes and run in batches.

Runs a library's deferred backfills in the running app.

The macros of a definition module: options/1, routes/1 and pipeline/2.

Tags for a library's own root layout, usable from any template engine.

Building blocks for a mountable library's Igniter installer.

Edits of the host's assets/js/app.js and assets/css/app.css, for a library whose components render in the host's own pages (a button in its header, a palette, a picker) and need a LiveView hook and a style sheet there. PhoenixMountable.Igniter.add_hook/4 and PhoenixMountable.Igniter.add_css_imports/3 apply them.

A mountable library's installer, declared in one use

Components for a library's root layout, and a ready-made root layout.

One version of a mountable library's schema.

Raised when a library's migration cannot run in the database's current state: a backfill it needs has not finished, it must run outside a transaction, or a version cannot be rolled back.

Versioned migrations for a mountable library's tables in the host's database.

What a library's migration version receives.

Writes the host's migration for installing or upgrading a library.

Raised when a host's database is behind the schema a mountable library needs.

Table rebuilds for SQLite, whose ALTER TABLE cannot change a column.

Checks for a library's migrations, run against a real database in the library's own test suite.

One mounted instance of a mountable library.

Paths relative to the mount: the ~m sigil.

PubSub topics scoped to a mount.

Runs a process once per cluster.

Starts the processes of every mount of a host router when the host boots.

Telemetry events emitted by PhoenixMountable.

Helpers for testing a mountable library.

A host app for a mountable library's tests.

Mix Tasks

Checks every library using PhoenixMountable.Migrations against the database, for CI.

Generates the host migration that installs or upgrades a library's tables.

Runs a library's deferred backfills to completion.