SqlMappingLike
An abstract mapping that is backed by a SQL database.
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- Known subtypes
- class SqlMapping[F]
- Self type
Members list
Type members
Classlikes
State required to assign table and column aliases.
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.
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- AliasState.type
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- Aliased.type
Trait representing an owner of an `SqlColumn
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)
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- Known subtypes
- trait SqlQueryclass SqlSelectclass SqlUniontrait TableExprclass DerivedTableRefclass SubqueryRefclass TableRefclass WithRefclass SqlJoin
Name of a SQL schema column and its associated codec, Scala type an defining
source position within an SqlMapping
.
Name of a SQL schema column and its associated codec, Scala type an defining
source position within an SqlMapping
.
Column
s 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
.
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
A pair of ColumnRef
s, representing a SQL join.
A pair of ColumnRef
s, representing a SQL join.
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- Join.type
Attributes
- Companion:
- trait
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- MappedQuery.type
Represents the mapping of a GraphQL query to an SQL query
Represents the mapping of a GraphQL query to an SQL query
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- object EmptyMappedQuery.typeclass NonEmptyMappedQuery
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass AbstractCursortrait Cursorclass Objecttrait Matchableclass Any
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Companion:
- trait
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- SqlColumn.type
Trait representing an SQL column
Trait representing an SQL column
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- class CountColumnclass DerivedColumnclass EmbeddedColumnclass NullColumnclass PartitionColumnclass SubqueryColumnclass TableColumn
Cursor positioned at a GraphQL result non-leaf
Common super type for mappings which have a programmatic discriminator, ie. interface and union mappings.
Common super type for mappings which have a programmatic discriminator, ie. interface and union mappings.
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- trait SqlInterfaceMappingclass DefaultInterfaceMappingtrait SqlUnionMappingclass DefaultUnionMapping
Discriminator for the branches of an interface/union
Discriminator for the branches of an interface/union
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait SqlFieldMappingtrait FieldMappingtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- trait
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- SqlInterfaceMapping.type
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait SqlDiscriminatedTypeclass ObjectMappingtrait TypeMappingtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
- Known subtypes
- class DefaultInterfaceMapping
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait SqlFieldMappingtrait FieldMappingtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait SqlFieldMappingtrait FieldMappingtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Companion:
- class
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- SqlObject.type
Attributes
- Companion:
- trait
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- SqlQuery.type
Representation of a SQL query in a context
Representation of a SQL query in a context
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- trait
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Self type
- SqlUnionMapping.type
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait SqlDiscriminatedTypeclass ObjectMappingtrait TypeMappingtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
- Known subtypes
- class DefaultUnionMapping
Attributes
- Companion:
- trait
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- Table.type
Representation of an SQL query result
Representation of an SQL query result
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
Attributes
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Companion:
- trait
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- TableExpr.type
Representation of a table expression
Representation of a table expression
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- Known subtypes
Attributes
- Companion:
- object
- Source:
- SqlMapping.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- SqlMapping.scala
- Graph
- Supertypes
- trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
- TableName.type
Inherited classlikes
Attributes
- Inherited from:
- CirceMappingLike
- Source:
- circemapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- CirceMappingLike
- Source:
- circemapping.scala
- Graph
- Supertypes
- trait CirceFieldMappingtrait FieldMappingtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Inherited from:
- CirceMappingLike
- Source:
- circemapping.scala
- Graph
- Supertypes
- Known subtypes
- class CirceFieldclass CursorFieldJson
Attributes
- Inherited from:
- CirceMappingLike
- Source:
- circemapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- CirceMappingLike
- Source:
- circemapping.scala
- Graph
- Supertypes
- trait CirceFieldMappingtrait FieldMappingtrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- Known subtypes
- trait CirceFieldMappingclass CirceFieldclass CursorFieldJsonclass CursorField[T]class Delegateclass PrimitiveFieldclass RootEffecttrait SqlFieldMappingclass SqlFieldclass SqlJsonclass SqlObject
Cursor positioned at a GraphQL result leaf
Cursor positioned at a GraphQL result leaf
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- Known subtypes
- trait SqlInterfaceMappingclass DefaultInterfaceMappingtrait SqlUnionMappingclass DefaultUnionMapping
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Root Cursor
focussed on the top level operation of a 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 in
Mapping` subtypes.
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- trait Serializabletrait Producttrait Equalsclass AbstractCursortrait Cursorclass Objecttrait Matchableclass Any
Root effects can perform an intial effect prior to computing the resulting
Cursor
and effective Query
.
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.
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
Typeclass for SQL fragments.
Typeclass for SQL fragments.
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
- Graph
- Supertypes
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
- Graph
- Supertypes
- Known subtypes
- trait LeafMapping[T]class ObjectMappingtrait SqlInterfaceMappingclass DefaultInterfaceMappingtrait SqlUnionMappingclass DefaultUnionMappingclass PrefixedMappingclass PrimitiveMapping
Types
Attributes
- Source:
- SqlMapping.scala
Inherited types
The type of a codec that reads and writes column values of type A
.
The type of a codec that reads and writes column values of type A
.
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
The type of an encoder that writes column values of type A
.
The type of an encoder that writes column values of type A
.
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
The type of a fragment of SQL together with any interpolated arguments.
The type of a fragment of SQL together with any interpolated arguments.
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Value members
Concrete methods
Returns the aliased column corresponding to the atomic field fieldName
in context
Returns the aliased column corresponding to the atomic field fieldName
in context
Attributes
- Source:
- SqlMapping.scala
Returns the aliased columns corresponding to term
in context
Returns the columns for leaf field fieldName
in context
Yields a Cursor
focused on the top level operation type of the query
Yields a Cursor
focused on the top level operation type of the query
Attributes
- Definition Classes
- Source:
- SqlMapping.scala
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?
Attributes
- Source:
- SqlMapping.scala
Does the supplied field correspond to a single, possibly structured, value?
Does the supplied field correspond to a single, possibly structured, value?
Attributes
- Source:
- SqlMapping.scala
Is term
in context
expressible in SQL?
Returns the key columns for the context type
Yields a Cursor
suitable for traversing the query result corresponding to
the fieldName
child of parent
.
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.
Attributes
- Definition Classes
- Source:
- SqlMapping.scala
Does the type of fieldName
in context
represent a list of subobjects?
Does the type of fieldName
in context
represent a list of subobjects?
Attributes
- Source:
- SqlMapping.scala
Returns the table for the type at context
Attributes
- Source:
- SqlMapping.scala
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.
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.
Attributes
- Source:
- SqlMapping.scala
Inherited methods
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Attributes
- Inherited from:
- CirceMappingLike
- Source:
- circemapping.scala
Attributes
- Inherited from:
- QueryExecutor
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
True if the supplied type is a leaf with respect to the GraphQL schema or mapping, false otherwise.
True if the supplied type is a leaf with respect to the GraphQL schema or mapping, false otherwise.
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Yields the RootEffect
, if any, associated with fieldName
.
Yields the RootEffect
, if any, associated with fieldName
.
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Extract an encoder from a codec.
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Concrete fields
Attributes
- Source:
- SqlMapping.scala
Inherited fields
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala
Implicits
Inherited implicits
Attributes
- Inherited from:
- CirceMappingLike
- Source:
- circemapping.scala
Attributes
- Inherited from:
- SqlModule
- Source:
- SqlModule.scala
Attributes
- Inherited from:
- Mapping
- Source:
- mapping.scala