API Reference Squirrelix v#0.5.2

Copy Markdown View Source

Modules

Elixir-native SQL query code generation for Mix projects.

Summary of a generated query-module check pass.

Summary of a generated query-module write pass.

Formatting helpers for structured Squirrelix errors.

Error returned when Squirrelix cannot connect to Postgres for inference.

Error returned when a generated file would overwrite human-written code.

Error returned when a file cannot be read.

Error returned when generated content cannot be written.

Error returned when a query result contains duplicate column names.

Error returned when a query metadata file cannot be evaluated to a metadata map.

Error returned when query inference references a column Postgres cannot find.

Error returned when query inference references a constraint Postgres cannot find.

Error returned when query inference references a table Postgres cannot find.

Error returned when no parameter and return metadata is available for a query.

Error returned when query metadata is missing a required field.

Error returned when an existing generated file differs from expected output.

Error returned when establishing a Postgres connection times out during --infer.

Error returned when Postgres rejects query inference for an unclassified reason.

Error returned when Postgres rejects query syntax during inference.

Error returned when a SQL filename cannot become an Elixir function name.

Error returned when a query result column name cannot become an Elixir identifier.

Error returned when a Postgres enum has no variants.

Error returned when a Postgres type has no Elixir mapping.

Behaviour for modules that infer SQL query parameters and returned columns.

Postgrex-backed query inferrer.

A parsed SQL query file.

Mix Tasks

Verifies generated query modules are up to date without writing files.

Generates Elixir query modules from SQL files in the current Mix project.