Packages

c

slick.lifted

ForeignKeyQuery

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
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 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 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
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toany2stringadd[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
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toArrowAssoc[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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  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 distinct: Query[E, U, Seq]

    Remove duplicate elements.

    Remove duplicate elements. When used on an ordered Query, there is no guarantee in which order duplicates are removed. This method is equivalent to distinctOn(identity).

    Definition Classes
    Query
  12. def distinctOn[F, T](f: (E) => F)(implicit shape: Shape[_ <: FlatShapeLevel, F, T, _]): Query[E, U, Seq]

    Remove duplicate elements which are the same in the given projection.

    Remove duplicate elements which are the same in the given projection. When used on an ordered Query, there is no guarantee in which order duplicates are removed.

    Definition Classes
    Query
  13. 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
  14. 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
  15. 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
  16. def encodeRef(path: Node): Query[E, U, Seq]

    Encode a reference into this Rep.

    Encode a reference into this Rep.

    Definition Classes
    Query → Rep
  17. def ensuring(cond: (ForeignKeyQuery[E, U]) => Boolean, msg: => Any): ForeignKeyQuery[E, U]
    Implicit
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toEnsuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (ForeignKeyQuery[E, U]) => Boolean): ForeignKeyQuery[E, U]
    Implicit
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toEnsuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: => Any): ForeignKeyQuery[E, U]
    Implicit
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toEnsuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): ForeignKeyQuery[E, U]
    Implicit
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toEnsuring[ForeignKeyQuery[E, U]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. def exists: Rep[Boolean]

    Test whether this query is non-empty.

    Test whether this query is non-empty.

    Definition Classes
    Query
  24. def filter[T](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 plain Booleans.

    Definition Classes
    Query
  25. def filterIf[T](p: Boolean)(f: (E) => T)(implicit arg0: CanBeQueryCondition[T]): Query[E, U, Seq]

    Applies the given filter function, if the boolean parameter p evaluates to true.

    Applies the given filter function, if the boolean parameter p evaluates to true. If not, the filter will not be part of the query.

    Definition Classes
    Query
  26. def filterNot[T](f: (E) => T)(implicit wt: CanBeQueryCondition[T]): Query[E, U, Seq]
    Definition Classes
    Query
  27. def filterNotIf[T](p: Boolean)(f: (E) => T)(implicit arg0: CanBeQueryCondition[T]): Query[E, U, Seq]

    Applies the given filterNot function, if the boolean parameter p evaluates to true.

    Applies the given filterNot function, if the boolean parameter p evaluates to true. If not, the filter will not be part of the query.

    Definition Classes
    Query
  28. def filterNotOpt[V, T](optValue: Option[V])(f: (E, V) => T)(implicit arg0: CanBeQueryCondition[T]): Query[E, U, Seq]

    Applies the given filterNot, if the Option value is defined.

    Applies the given filterNot, if the Option value is defined. If the value is None, the filter will not be part of the query.

    Definition Classes
    Query
  29. def filterOpt[V, T](optValue: Option[V])(f: (E, V) => T)(implicit arg0: CanBeQueryCondition[T]): Query[E, U, Seq]

    Applies the given filter, if the Option value is defined.

    Applies the given filter, if the Option value is defined. If the value is None, the filter will not be part of the query.

    Definition Classes
    Query
  30. val fks: IndexedSeq[ForeignKey]
  31. 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
  32. def forUpdate: Query[E, U, Seq]

    Specify part of a select statement for update and marked for row level locking

    Specify part of a select statement for update and marked for row level locking

    Definition Classes
    Query
  33. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  34. 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
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. 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
  38. 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
  39. 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
  40. 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
  41. def length: Rep[Int]

    The total number of elements (i.e.

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

    Definition Classes
    Query
  42. 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
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  46. def pack[R](implicit packing: Shape[_ <: FlatShapeLevel, E, _, R]): Query[R, U, Seq]
    Definition Classes
    Query
  47. final lazy val packed: Node
    Definition Classes
    Query
  48. val shaped: ShapedValue[_ <: E, U]
    Definition Classes
    WrappingQuery → Query
  49. def size: Rep[Int]

    The total number of elements (i.e.

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

    Definition Classes
    Query
  50. def sortBy[T](f: (E) => T)(implicit ev: (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
  51. 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
  52. def subquery: Query[E, U, Seq]

    Force a subquery to be created when using this Query as part of a larger Query.

    Force a subquery to be created when using this Query as part of a larger Query. This method should never be necessary for correctness. If a query works with an explicit .subquery call but fails without, this should be considered a bug in Slick. The method is exposed in the API to enable workarounds to be written in such cases.

    Definition Classes
    Query
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def take(num: Int): Query[E, U, Seq]

    Select the first num elements.

    Select the first num elements.

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

    Select the first num elements.

    Select the first num elements.

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

    Select the first num elements.

    Select the first num elements.

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

    Change the collection type to build when executing the query.

    Change the collection type to build when executing the query.

    Definition Classes
    Query
  58. val toNode: Node

    Get the Node for this Rep.

    Get the Node for this Rep.

    Definition Classes
    WrappingQuery → Rep
  59. def toString(): String
    Definition Classes
    Rep → AnyRef → Any
  60. 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
  61. 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
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. 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
  66. 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
  67. 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
  68. 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

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toStringFormat[ForeignKeyQuery[E, U]] 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): (ForeignKeyQuery[E, U], B)
    Implicit
    This member is added by an implicit conversion from ForeignKeyQuery[E, U] toArrowAssoc[ForeignKeyQuery[E, U]] 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 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 any2stringadd fromForeignKeyQuery[E, U] to any2stringadd[ForeignKeyQuery[E, U]]

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

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

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

Ungrouped