Elixir-native SQL query code generation for Mix projects.

Squirrelix discovers .sql files under conventional Elixir source roots (lib/, test/, dev/), then generates sibling sql.ex modules with @spec-annotated functions that execute through Postgrex.

Supported public API

Pre-1.0, the supported programmatic surface is intentionally small:

• generate/3 / check/3 — primary entry points
• Mix tasks mix squirrelix.gen and mix squirrelix.check
• Return summaries Squirrelix.CodegenSummary / Squirrelix.CodegenCheckSummary
• Documented Squirrelix.Error.* structs (and Squirrelix.Error.format/1)
• Squirrelix.Postgres.inferrer/1 and Squirrelix.Inference.Inferrer (plus Squirrelix.Query as the Inferrer callback argument)

Other modules under Squirrelix.* are internal (@moduledoc false) and may change without notice. See Configuration for the full inventory.

Guides

• Getting Started — installation, layout, first query
• Writing Queries — one query per file, comments, naming
• Types — Postgres to Elixir type mapping
• Configuration — inference, metadata, connection, CI

See also README.md for a full overview.

Query sources

Generation and checking accept a query source in one of two forms:

• A metadata map — keys are query file paths, values are keyword lists with :params and :returns. Load from squirr_elix.exs or pass a map to generate/3 and check/3.

• An inferrer — a (query -> {:ok, keyword()} | {:error, struct()}) function or a module implementing Squirrelix.Inference.Inferrer. The Mix task uses this mode with --infer to ask Postgres for column and parameter types.

Generated code uses stdlib types in @spec output: String.t() for Postgres enums, term() for JSON/JSONB columns, map() with required/1 for row shapes, and plain maps at runtime rather than Gleam records or custom enum ADTs.