SkunkMapping

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.

A pair of ColumnRefs, representing a SQL join.

Cursor positioned at a GraphQL result leaf

Represents the mapping of a GraphQL query to an SQL query

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 inMapping` subtypes.

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

Convenience methods are provided to cover the cases where only one of the query or the cursor are computed, and for where the computation is one-shot or a Stream. One-shot effects are used to perform initial effectful setup for a query or to perform the effect associated with a GraphQL mutation. Stream effects are used for GraphQL subscriptions.

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.

Trait representing an SQL column

Wraps an SqlColumn as a Term which can appear in a Predicate

Cursor positioned at a GraphQL result non-leaf

Common super type for mappings which have a programmatic discriminator, ie. interface and union mappings.

Discriminator for the branches of an interface/union

Typeclass for SQL fragments.

Representation of a SQL query in a context

Representation of an SQL query result

Representation of a table expression

Returns the aliased column corresponding to the atomic field fieldName in context

Returns the aliased columns corresponding to term in context

Returns the columns for leaf field fieldName in context

Returns the discriminator columns for the context type

Returns the discriminator for the type at context

Returns the Encoder for the given term in context

Is the context type mapped to an associative table?

Is fieldName in context computed?

Is fieldName in context Jsonb?

True if the supplied type is a leaf with respect to the GraphQL schema or mapping, false otherwise.

Does the supplied field correspond to a single, possibly structured, value?

Is term in contextexpressible in SQL?

Returns the key columns for the context type

Does the type of fieldName in context represent a list of subobjects?

Returns the table for the type at context

Yields the RootEffect, if any, associated with fieldName.

Operators which can be compiled to SQL are eliminated here, partly to avoid duplicating work programmatically, but also because the operation isn't necessarily idempotent and the result set doesn't necessarily contain the fields required for the filter predicates.