API Reference ecto_sparkles v#0.4.0

Copy Markdown View Source

Modules

Some helpers to sparkle on top of Ecto

Runs ecto migrations automatically on startup (add this to your app's supervision tree)

A behaviour implemented by our data migrations (generally backfills).

Configuration for a DataMigration behaviour module, used by the DataMigration.Runner.

Runs a DataMigration

A custom Ecto type for handling the serialization of arbitrary data types stored as binary data in the database. Requires the underlying DB field to be a binary.

A custom Ecto type for handling the serialization of arbitrary data types stored as JSON data in the database. Requires the underlying DB field to be a map / JSONB field.

Log Ecto queries, and output warnings for slow or possible n+1 queries

Accumulates repeated SELECT shapes per Proces or unit of work (LiveView mount/params/event, HTTP request, Oban job) for N+1 detection.

Span-end reporting for EctoSparkles.NPlus1Detector: attaches telemetry handlers on Phoenix LiveView/router and Oban span endings that flush the per-process query counts at the end of each unit of work and log ONE consolidated warning per span for shapes repeated ≥ the threshold (config :ecto_sparkles, :n_plus_1_threshold, default 3).

Provides functions for sanitising input on Ecto.Changeset string fields.