slick.lifted

ForeignKeyQuery

Related Doc: package lifted

class ForeignKeyQuery[E <: AbstractTable[_], U] extends WrappingQuery[E, U, Seq] with Constraint

A query that selects data linked by a foreign key.

Source
Constraint.scala
Linear Supertypes
Constraint, WrappingQuery[E, U, Seq], Query[E, U, Seq], QueryBase[Seq[U]], Rep[Seq[U]], AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ForeignKeyQuery
  2. Constraint
  3. WrappingQuery
  4. Query
  5. QueryBase
  6. Rep
  7. AnyRef
  8. Any
Implicitly
  1. by CollectionsHaveToParArray
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ForeignKeyQuery(nodeDelegate: Node, base: ShapedValue[_ <: E, U], fks: IndexedSeq[ForeignKey], targetBaseQuery: Query[E, U, Seq], generator: AnonSymbol, aliasedValue: E)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def &(other: ForeignKeyQuery[E, U]): ForeignKeyQuery[E, U]

    Combine the constraints of this ForeignKeyQuery with another one with the same target table, leading to a single instance of the target table which satisfies the constraints of both.

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to any2stringadd[ForeignKeyQuery[E, U]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  5. def ++[O >: E, R, D[_]](other: Query[O, U, D]): Query[O, U, Seq]

    Return a new query containing the elements from both operands.

    Return a new query containing the elements from both operands. Duplicate elements are preserved.

    Definition Classes
    Query
  6. def ->[B](y: B): (ForeignKeyQuery[E, U], B)

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to ArrowAssoc[ForeignKeyQuery[E, U]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def countDistinct: Rep[Int]

    The number of distinct elements of the query.

    The number of distinct elements of the query.

    Definition Classes
    Query
  11. def drop(num: Int): Query[E, U, Seq]

    Select all elements except the first num ones.

    Select all elements except the first num ones.

    Definition Classes
    Query
  12. def drop(num: Long): Query[E, U, Seq]

    Select all elements except the first num ones.

    Select all elements except the first num ones.

    Definition Classes
    Query
  13. def drop(num: ConstColumn[Long]): Query[E, U, Seq]

    Select all elements except the first num ones.

    Select all elements except the first num ones.

    Definition Classes
    Query
  14. def encodeRef(path: Node): Query[E, U, Seq]

    Encode a reference into this Rep.

    Encode a reference into this Rep.

    Definition Classes
    QueryRep
  15. def ensuring(cond: (ForeignKeyQuery[E, U]) ⇒ Boolean, msg: ⇒ Any): ForeignKeyQuery[E, U]

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to Ensuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (ForeignKeyQuery[E, U]) ⇒ Boolean): ForeignKeyQuery[E, U]

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to Ensuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): ForeignKeyQuery[E, U]

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to Ensuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): ForeignKeyQuery[E, U]

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to Ensuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  21. def exists: Rep[Boolean]

    Test whether this query is non-empty.

    Test whether this query is non-empty.

    Definition Classes
    Query
  22. def filter[T <: Rep[_]](f: (E) ⇒ T)(implicit wt: CanBeQueryCondition[T]): Query[E, U, Seq]

    Select all elements of this query which satisfy a predicate.

    Select all elements of this query which satisfy a predicate. Unlike withFilter, this method only allows Rep-valued predicates, so it guards against the accidental use use plain Booleans.

    Definition Classes
    Query
  23. def filterNot[T <: Rep[_]](f: (E) ⇒ T)(implicit wt: CanBeQueryCondition[T]): Query[E, U, Seq]

    Definition Classes
    Query
  24. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. val fks: IndexedSeq[ForeignKey]

  26. def flatMap[F, T, D[_]](f: (E) ⇒ Query[F, T, D]): Query[F, T, Seq]

    Build a new query by applying a function to all elements of this query and using the elements of the resulting queries.

    Build a new query by applying a function to all elements of this query and using the elements of the resulting queries. This corresponds to an implicit inner join in SQL.

    Definition Classes
    Query
  27. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to StringFormat[ForeignKeyQuery[E, U]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  28. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  29. def groupBy[K, T, G, P](f: (E) ⇒ K)(implicit kshape: Shape[_ <: FlatShapeLevel, K, T, G], vshape: Shape[_ <: FlatShapeLevel, E, _, P]): Query[(G, Query[P, U, Seq]), (T, Query[P, U, Seq]), Seq]

    Partition this query into a query of pairs of a key and a nested query containing the elements for the key, according to some discriminator function.

    Partition this query into a query of pairs of a key and a nested query containing the elements for the key, according to some discriminator function.

    Definition Classes
    Query
  30. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  31. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  32. def join[E2, U2, D[_]](q2: Query[E2, U2, D]): BaseJoinQuery[E, E2, U, U2, Seq, E, E2]

    Join two queries with a cross join or inner join.

    Join two queries with a cross join or inner join. An optional join predicate can be specified later by calling on.

    Definition Classes
    Query
  33. def joinFull[E1 >: E, E2, U2, D[_], O1, U1, O2](q2: Query[E2, _, D])(implicit ol1: OptionLift[E1, O1], sh1: Shape[FlatShapeLevel, O1, U1, _], ol2: OptionLift[E2, O2], sh2: Shape[FlatShapeLevel, O2, U2, _]): BaseJoinQuery[O1, O2, U1, U2, Seq, E, E2]

    Join two queries with a full outer join.

    Join two queries with a full outer join. An optional join predicate can be specified later by calling on. Both sides of the join are lifted to an Option. If at least one element on either side matches the other side, all matching elements are returned as Some, otherwise a single None row is returned.

    Definition Classes
    Query
  34. def joinLeft[E2, U2, D[_], O2](q2: Query[E2, _, D])(implicit ol: OptionLift[E2, O2], sh: Shape[FlatShapeLevel, O2, U2, _]): BaseJoinQuery[E, O2, U, U2, Seq, E, E2]

    Join two queries with a left outer join.

    Join two queries with a left outer join. An optional join predicate can be specified later by calling on. The right side of the join is lifted to an Option. If at least one element on the right matches, all matching elements are returned as Some, otherwise a single None row is returned.

    Definition Classes
    Query
  35. def joinRight[E1 >: E, E2, U2, D[_], O1, U1](q2: Query[E2, U2, D])(implicit ol: OptionLift[E1, O1], sh: Shape[FlatShapeLevel, O1, U1, _]): BaseJoinQuery[O1, E2, U1, U2, Seq, E, E2]

    Join two queries with a right outer join.

    Join two queries with a right outer join. An optional join predicate can be specified later by calling on. The left side of the join is lifted to an Option. If at least one element on the left matches, all matching elements are returned as Some, otherwise a single None row is returned.

    Definition Classes
    Query
  36. def length: Rep[Int]

    The total number of elements (i.e.

    The total number of elements (i.e. rows).

    Definition Classes
    Query
  37. def map[F, G, T](f: (E) ⇒ F)(implicit shape: Shape[_ <: FlatShapeLevel, F, T, G]): Query[G, T, Seq]

    Build a new query by applying a function to all elements of this query.

    Build a new query by applying a function to all elements of this query.

    Definition Classes
    Query
  38. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  39. final def notify(): Unit

    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  41. def pack[R](implicit packing: Shape[_ <: FlatShapeLevel, E, _, R]): Query[R, U, Seq]

    Definition Classes
    Query
  42. final lazy val packed: Node

    Definition Classes
    Query
  43. val shaped: ShapedValue[_ <: E, U]

    Definition Classes
    WrappingQueryQuery
  44. def size: Rep[Int]

    The total number of elements (i.e.

    The total number of elements (i.e. rows).

    Definition Classes
    Query
  45. def sortBy[T](f: (E) ⇒ T)(implicit arg0: (T) ⇒ Ordered): Query[E, U, Seq]

    Sort this query according to a function which extracts the ordering criteria from the query's elements.

    Sort this query according to a function which extracts the ordering criteria from the query's elements.

    Definition Classes
    Query
  46. def sorted(implicit ev: (E) ⇒ Ordered): Query[E, U, Seq]

    Sort this query according to a the ordering of its elements.

    Sort this query according to a the ordering of its elements.

    Definition Classes
    Query
  47. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  48. def take(num: Int): Query[E, U, Seq]

    Select the first num elements.

    Select the first num elements.

    Definition Classes
    Query
  49. def take(num: Long): Query[E, U, Seq]

    Select the first num elements.

    Select the first num elements.

    Definition Classes
    Query
  50. def take(num: ConstColumn[Long]): Query[E, U, Seq]

    Select the first num elements.

    Select the first num elements.

    Definition Classes
    Query
  51. def to[D[_]](implicit ctc: TypedCollectionTypeConstructor[D]): Query[E, U, D]

    Definition Classes
    Query
  52. val toNode: Node

    Get the Node for this Rep.

    Get the Node for this Rep.

    Definition Classes
    WrappingQueryRep
  53. def toParArray: ParArray[T]

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to CollectionsHaveToParArray[ForeignKeyQuery[E, U], T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (ForeignKeyQuery[E, U]) ⇒ GenTraversableOnce[T] is in scope.
    Definition Classes
    CollectionsHaveToParArray
  54. def toString(): String

    Definition Classes
    Rep → AnyRef → Any
  55. def union[O >: E, R, D[_]](other: Query[O, U, D]): Query[O, U, Seq]

    Return a new query containing the elements from both operands.

    Return a new query containing the elements from both operands. Duplicate elements are eliminated from the result.

    Definition Classes
    Query
  56. def unionAll[O >: E, R, D[_]](other: Query[O, U, D]): Query[O, U, Seq]

    Return a new query containing the elements from both operands.

    Return a new query containing the elements from both operands. Duplicate elements are preserved.

    Definition Classes
    Query
  57. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. def withFilter[T](f: (E) ⇒ T)(implicit arg0: CanBeQueryCondition[T]): Query[E, U, Seq]

    Select all elements of this query which satisfy a predicate.

    Select all elements of this query which satisfy a predicate. This method is used when desugaring for-comprehensions over queries. There is no reason to call it directly because it is the same as filter.

    Definition Classes
    Query
  61. def zip[E2, U2, D[_]](q2: Query[E2, U2, D]): Query[(E, E2), (U, U2), Seq]

    Return a query formed from this query and another query by combining corresponding elements in pairs.

    Return a query formed from this query and another query by combining corresponding elements in pairs.

    Definition Classes
    Query
  62. def zipWith[E2, U2, F, G, T, D[_]](q2: Query[E2, U2, D], f: (E, E2) ⇒ F)(implicit shape: Shape[_ <: FlatShapeLevel, F, T, G]): Query[G, T, Seq]

    Return a query formed from this query and another query by combining corresponding elements with the specified function.

    Return a query formed from this query and another query by combining corresponding elements with the specified function.

    Definition Classes
    Query
  63. def zipWithIndex: BaseJoinQuery[E, Rep[Long], U, Long, Seq, E, Rep[Long]]

    Zip this query with its indices (starting at 0).

    Zip this query with its indices (starting at 0).

    Definition Classes
    Query
  64. def [B](y: B): (ForeignKeyQuery[E, U], B)

    Implicit information
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] to ArrowAssoc[ForeignKeyQuery[E, U]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def innerJoin[E2, U2, D[_]](q2: Query[E2, U2, D]): BaseJoinQuery[E, E2, U, U2, Seq, E, E2]

    Join two queries with a cross / inner join.

    Join two queries with a cross / inner join. An optional join predicate can be specified later by calling on.

    Definition Classes
    Query
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0) Use join instead of joinInner

  2. def join[E2, U2, D[_]](q2: Query[E2, U2, D], jt: JoinType): BaseJoinQuery[E, E2, U, U2, Seq, E, E2]

    Join two queries.

    Join two queries. An optional join predicate can be specified later by calling on.

    Definition Classes
    Query
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0) Use join (without explicit JoinType), joinLeft, joinRight or joinOuter instead

  3. def leftJoin[E2, U2, D[_]](q2: Query[E2, U2, D]): BaseJoinQuery[E, E2, U, U2, Seq, E, E2]

    Join two queries with a left outer join.

    Join two queries with a left outer join. An optional join predicate can be specified later by calling on.

    Definition Classes
    Query
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0) Use joinLeft (with correct Option types) instead of leftJoin

  4. def outerJoin[E2, U2, D[_]](q2: Query[E2, U2, D]): BaseJoinQuery[E, E2, U, U2, Seq, E, E2]

    Join two queries with a full outer join.

    Join two queries with a full outer join. An optional join predicate can be specified later by calling on.

    Definition Classes
    Query
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0) Use joinFull (with correct Option types) instead of outerJoin

  5. def rightJoin[E2, U2, D[_]](q2: Query[E2, U2, D]): BaseJoinQuery[E, E2, U, U2, Seq, E, E2]

    Join two queries with a right outer join.

    Join two queries with a right outer join. An optional join predicate can be specified later by calling on.

    Definition Classes
    Query
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0) Use joinRight (with correct Option types) instead of rightJoin

  6. def where[T <: Rep[_]](f: (E) ⇒ T)(implicit arg0: CanBeQueryCondition[T]): Query[E, U, Seq]

    Select all elements of this query which satisfy a predicate.

    Select all elements of this query which satisfy a predicate. Unlike withFilter, this method only allows Column-valued predicates, so it guards against the accidental use use plain Booleans.

    Definition Classes
    Query
    Annotations
    @deprecated
    Deprecated

    (Since version 2.1) Use filter instead of where

Inherited from Constraint

Inherited from WrappingQuery[E, U, Seq]

Inherited from Query[E, U, Seq]

Inherited from QueryBase[Seq[U]]

Inherited from Rep[Seq[U]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion CollectionsHaveToParArray from ForeignKeyQuery[E, U] to CollectionsHaveToParArray[ForeignKeyQuery[E, U], T]

Inherited by implicit conversion any2stringadd from ForeignKeyQuery[E, U] to any2stringadd[ForeignKeyQuery[E, U]]

Inherited by implicit conversion StringFormat from ForeignKeyQuery[E, U] to StringFormat[ForeignKeyQuery[E, U]]

Inherited by implicit conversion Ensuring from ForeignKeyQuery[E, U] to Ensuring[ForeignKeyQuery[E, U]]

Inherited by implicit conversion ArrowAssoc from ForeignKeyQuery[E, U] to ArrowAssoc[ForeignKeyQuery[E, U]]

Ungrouped