API Reference scrypath v#0.3.4

Copy Markdown View Source

Modules

Runtime reflection helpers for searchable schemas declared with use Scrypath.

Internal backend behavior for Scrypath runtime adapters.

Internal runtime configuration helpers for Scrypath.

Internal projected search document used between Scrypath orchestration layers.

Merge helpers for Meilisearch facetDistribution JSON maps when building disjunctive facet counts.

Meilisearch-specific runtime entrypoints for Scrypath.

Decodes federated /multi-search responses into per-index raw maps suitable for building the public search result structs returned from Scrypath.search/3.

Builds Meilisearch /indexes/:uid/search JSON bodies from Scrypath.Query.

Normalizes search_many/2 entry tuples and shared runtime options.

Federated multi-search metadata mirrored from Meilisearch's federation object.

Narrow Oban helpers for composing Scrypath sync jobs into Ecto.Multi.

Opt-in enriched result from Scrypath.failed_sync_work/2 when reason_class_counts: true is passed in operator options.

Structured comparison of a schema's declared index contract against live Meilisearch index settings.

Dense per-class counts for failed sync work rows.

Report-first reconciliation returned by Scrypath.reconcile_sync/2.

Reindex visibility embedded in a reconcile report.

Explicit recovery action used by Scrypath operator APIs.

Stable operator state projected from backend tasks and queue jobs.

Read-only sync visibility returned by Scrypath.sync_status/2.

Document projection for schemas declared with use Scrypath.

Internal normalized search query struct used by the common search path and backend adapters.

Metadata-only schema declaration support for use Scrypath.

Facet counts and stats decoded from a Meilisearch search response.

One entry from Meilisearch facetDistribution: a facet value and its document count.

Mix Tasks

Lists Scrypath-owned failed-work entries for one searchable schema.

Compares a schema's declared index contract (fields, filterables, sortables, faceting, and declared Meilisearch settings families) against the live index via a single read-only Meilisearch get_settings call.

Shows a report-first reconcile view for one schema. Pass --action to apply one explicit recovery action from that report.

Retries one explicit failed-work entry by id using the existing Scrypath operator APIs.

Diffs declared-vs-applied Meilisearch settings for one Scrypath schema.

Applies a bounded live Meilisearch settings PATCH for one Scrypath schema.

Reads current applied Meilisearch settings for one Scrypath schema and prints them.

Shows pending, failed, and last-successful sync visibility for one searchable schema.

Runs a fixed set of @moduletag :integration suites against a real Meilisearch.

Runs the auth-free release-confidence verification flow.

Runs the automated release-alignment verification flow.

Runs the focused operator verification flow.

Runs the focused verification flow for backfill, reindex, Meilisearch integration, and operator-facing docs.

Runs the focused reliability verification flow.

Verifies that the file list inside the published Hex tarball for X.Y.Z matches the file list inside lib/ + guides/ + docs/ at git tag scrypath-vX.Y.Z.

Verifies the live publish contract for a released Scrypath version.

Verifies that git status is clean for all pathspecs that ship in the Hex tarball plus test/**.