API Reference Loupe v0.11.0

modules

Modules

Entrypoint module for Ecto related function with Loupe. Ideally, this module should be completely decoupled from any Repo logic and leave that to the app's Repo

The context is the structure that goes through the query building process. It includes the user assigns which are passed down below in the ecto definition, but also includes a couple fields to make sure that query info are validated beforehand.

Behaviour for defining an Ecto definition. This behaviours defines what the query builder can use to build the query.

Error that occurs when to schema is provided but is expected

Error being raised where there is an error with operators

Module to implement various filter depending on field type. This is how we build query with Ecto depending on the kind of field we receive

Defines functions for querying using a composite field from a variant. This is invoked when you refer a field variant using : like

Defines functions for querying using a direct field. This is invoked when you refer a field directly (without path or variant)

Defines functions for querying using a field with a path. This is invoked when you refer a field plus a path for json fields

An error that occured in the lexer's step

An error that occured in the parser's step

Loupe's compiler entrypoint.

Extracted AST structure query.

Live view component that renders the entities. It also support nesting preloading of the relations though events.

Module that is meant to be implemented to control how the component renders

Filters a stream with Loupe's ast. Schema will likely have no impact on the way this filtering is being done

Behaviour to implement comparator. It could be useful to implement your own comparator to alter how fields are getting compared.

Context to work with Stream filtering

Default comparator that does strict comparison.