SqlMapping

State required to assign table and column aliases.

Used when rendering an SqlQuery as a Fragment. Table aliases are assigned as needed for recursive queries. Column aliases are assigned to disambiguate collections of columns generated by subqueries and unions.

Trait representing an owner of an SqlColumn

ColumnOwners are tables, SQL queries and subqueries, common table expressions and the like. Most, but not all have a name (SqlSelect, SqlUnion and SqlJoin being unnamed examples)

Name of a SQL schema column and its associated codec, Scala type an defining source position within an SqlMapping.

Columns are considered equal if their table and column names are equal.

Note that ColumnRef primarily play a role in mappings. During compilation they will be used to construct SqlColumns.

Root Cursor focussed on the top level operation of a query

Construction of mapping-specific cursors is handled by delegation to mkCursorForField which is typically overridden in Mapping subtypes.

Root effects can perform an intial effect prior to computing the resulting Cursor and effective Query.

These effects are used to perform initial effectful setup for a query or to perform the effect associated with a GraphQL mutation. Convenience methods are provided to cover the cases where only one of the query or the cursor are computed.

If only the query is computed the default root cursor for the mapping will be used. If only the cursor is computed the client query (after elaboration) is used unmodified ... in this case results of the performed effect can only be passed to the result construction stage via the environment associated with the returned cursor.

Root streams can perform an intial effect prior to emitting the resulting cursors and effective queries.

Stream effects are used for GraphQL subscriptions. Convenience methods are provided to cover the cases where only one of the query or the cursor are computed

If only the query is computed the default root cursor for the mapping will be used. If only the cursor is computed the client query (after elaboration) is used unmodified ... in this case results of the performed effect can only be passed to the result construction stage via the environment associated with the returned cursor.

Combine and execute multiple queries.

Each query is interpreted in the context of the Cursor it is paired with. The result list is aligned with the argument query list. For each query at most one stage will be run and the corresponding result may contain deferred components.

Errors are aggregated across all the argument queries and are accumulated on the Left of the result.

This method is typically called at the end of a stage to evaluate deferred subqueries in the result of that stage. These will be grouped by and passed jointly to the responsible mapping in the next stage using this method. Maappongs which are able to benefit from combining queries may do so by overriding this method to implement their specific combinging logic.

Compile and run a single GraphQL query or mutation.

Yields a JSON response containing the result of the query or mutation.

Compile and run a GraphQL subscription.

Yields a stream of JSON responses containing the results of the subscription.

Yields a Cursor suitable for traversing the query result corresponding to the fieldName child of parent.

This method is typically overridden in and delegated to by Mapping subtypes.