Packages

c

slick.ast

Comprehension

final case class Comprehension(sym: TermSymbol, from: Node, select: Node, where: Option[Node] = None, groupBy: Option[Node] = None, orderBy: ConstArray[(Node, Ordering)] = ConstArray.empty, having: Option[Node] = None, distinct: Option[Node] = None, fetch: Option[Node] = None, offset: Option[Node] = None, forUpdate: Boolean = false) extends DefNode with Product with Serializable

A SQL comprehension

Source
Comprehension.scala
Linear Supertypes
Serializable, Product, Equals, DefNode, Node, Dumpable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Comprehension
  2. Serializable
  3. Product
  4. Equals
  5. DefNode
  6. Node
  7. Dumpable
  8. AnyRef
  9. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Comprehension(sym: TermSymbol, from: Node, select: Node, where: Option[Node] = None, groupBy: Option[Node] = None, orderBy: ConstArray[(Node, Ordering)] = ConstArray.empty, having: Option[Node] = None, distinct: Option[Node] = None, fetch: Option[Node] = None, offset: Option[Node] = None, forUpdate: Boolean = false)

Type Members

  1. type Self = Comprehension
    Definition Classes
    ComprehensionNode

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Comprehension toany2stringadd[Comprehension] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Comprehension, B)
    Implicit
    This member is added by an implicit conversion from Comprehension toArrowAssoc[Comprehension] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def :@(newType: Type): Self

    Return this Node with a Type assigned (if no other type has been seen for it yet) or a typed copy.

    Return this Node with a Type assigned (if no other type has been seen for it yet) or a typed copy.

    Definition Classes
    Node
  6. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def buildCopy: Self

    Build a copy of this node with the current children.

    Build a copy of this node with the current children.

    Attributes
    protected[this]
    Definition Classes
    Node
  9. def childNames: Seq[String]

    Names for the child nodes to show in AST dumps.

    Names for the child nodes to show in AST dumps. Defaults to a numbered sequence starting at 0 but can be overridden by subclasses to produce more suitable names.

    Definition Classes
    ComprehensionNode
  10. lazy val children: ConstArray[Node]

    All child nodes of this node.

    All child nodes of this node. Must be implemented by subclasses.

    Definition Classes
    ComprehensionNode
  11. def childrenForeach[R](f: (Node) => R): Unit

    Apply a side-effecting function to all direct children from left to right.

    Apply a side-effecting function to all direct children from left to right. Note that

    n.childrenForeach(f)

    is equivalent to

    n.children.foreach(f)

    but can be implemented more efficiently in Node subclasses.

    Definition Classes
    Node
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  13. val distinct: Option[Node]
  14. def ensuring(cond: (Comprehension) => Boolean, msg: => Any): Comprehension
    Implicit
    This member is added by an implicit conversion from Comprehension toEnsuring[Comprehension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (Comprehension) => Boolean): Comprehension
    Implicit
    This member is added by an implicit conversion from Comprehension toEnsuring[Comprehension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: => Any): Comprehension
    Implicit
    This member is added by an implicit conversion from Comprehension toEnsuring[Comprehension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): Comprehension
    Implicit
    This member is added by an implicit conversion from Comprehension toEnsuring[Comprehension] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. val fetch: Option[Node]
  20. val forUpdate: Boolean
  21. val from: Node
  22. def generators: ConstArray[(TermSymbol, Node)]
    Definition Classes
    ComprehensionDefNode
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def getDumpInfo: DumpInfo

    Return the name, main info, attribute info and named children

    Return the name, main info, attribute info and named children

    Definition Classes
    NodeDumpable
  25. val groupBy: Option[Node]
  26. def hasType: Boolean

    Check if this node has a type without marking the type as seen.

    Check if this node has a type without marking the type as seen.

    Definition Classes
    Node
  27. val having: Option[Node]
  28. final def infer(scope: Scope = Map.empty, typeChildren: Boolean = false): Self

    Rebuild this node and all children with their computed type.

    Rebuild this node and all children with their computed type. If this node already has a type, the children are only type-checked again if typeChildren is true. if retype is also true, the existing type of this node is replaced. If this node does not yet have a type, the types of all children are computed first.

    Definition Classes
    Node
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def mapChildren(f: (Node) => Node, keepType: Boolean = false): Self

    Apply a mapping function to all children of this node and recreate the node with the new children.

    Apply a mapping function to all children of this node and recreate the node with the new children. If all new children are identical to the old ones, this node is returned. If keepType is true, the type of this node is kept even when the children have changed.

    Definition Classes
    Node
  31. final def mapScopedChildren(f: (Option[TermSymbol], Node) => Node): Self with DefNode
    Definition Classes
    DefNode
  32. final def mapSymbols(f: (TermSymbol) => TermSymbol): Node
    Definition Classes
    DefNode
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def nodeType: Type

    The current type of this node.

    The current type of this node.

    Definition Classes
    Node
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. val offset: Option[Node]
  38. val orderBy: ConstArray[(Node, Ordering)]
  39. def peekType: Type

    Get the current type of this node for debug output without marking it as seen.

    Get the current type of this node for debug output without marking it as seen.

    Attributes
    protected[this]
    Definition Classes
    Node
  40. def productElementNames: Iterator[String]
    Definition Classes
    Product
  41. def rebuild(ch: ConstArray[Node]): Comprehension

    Rebuild this node with a new list of children.

    Rebuild this node with a new list of children. Implementations of this method must not reuse the current node. This method always returns a fresh copy.

    Attributes
    protected[this]
    Definition Classes
    ComprehensionNode
  42. def rebuildWithSymbols(gen: ConstArray[TermSymbol]): Comprehension
    Attributes
    protected[this]
    Definition Classes
    ComprehensionDefNode
  43. val select: Node
  44. val sym: TermSymbol
  45. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  46. final def toString(): String
    Definition Classes
    Node → AnyRef → Any
  47. final def untyped: Self

    Return this Node with no Type assigned (if it has not yet been observed) or an untyped copy.

    Return this Node with no Type assigned (if it has not yet been observed) or an untyped copy.

    Definition Classes
    Node
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. val where: Option[Node]
  52. final def withChildren(ch2: ConstArray[Node]): Self

    Rebuild this node with new child nodes unless all children are identical to the current ones, in which case this node is returned.

    Rebuild this node with new child nodes unless all children are identical to the current ones, in which case this node is returned.

    Definition Classes
    Node
  53. def withInferredType(scope: Scope, typeChildren: Boolean): Self
    Definition Classes
    ComprehensionNode

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Comprehension toStringFormat[Comprehension] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (Comprehension, B)
    Implicit
    This member is added by an implicit conversion from Comprehension toArrowAssoc[Comprehension] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DefNode

Inherited from Node

Inherited from Dumpable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromComprehension to any2stringadd[Comprehension]

Inherited by implicit conversion StringFormat fromComprehension to StringFormat[Comprehension]

Inherited by implicit conversion Ensuring fromComprehension to Ensuring[Comprehension]

Inherited by implicit conversion ArrowAssoc fromComprehension to ArrowAssoc[Comprehension]

Ungrouped