com.outworkers.phantom.builder.query

SelectQuery

class SelectQuery[Table <: CassandraTable[Table, _], Record, Limit <: LimitBound, Order <: OrderBound, Status <: ConsistencyBound, Chain <: WhereBound, PS <: HList] extends Query[Table, Record, Limit, Order, Status, Chain, PS] with ExecutableQuery[Table, Record, Limit]

Linear Supertypes
ExecutableQuery[Table, Record, Limit], RootExecutableQuery[Record], Query[Table, Record, Limit, Order, Status, Chain, PS], ExecutableStatement, CassandraOperations, SessionAugmenterImplicits, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SelectQuery
  2. ExecutableQuery
  3. RootExecutableQuery
  4. Query
  5. ExecutableStatement
  6. CassandraOperations
  7. SessionAugmenterImplicits
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SelectQuery(table: Table, rowFunc: (Row) ⇒ Record, init: CQLQuery, wherePart: WherePart = WherePart.empty, orderPart: OrderPart = OrderPart.empty, limitedPart: LimitedPart = LimitedPart.empty, filteringPart: FilteringPart = FilteringPart.empty, usingPart: UsingPart = UsingPart.empty, count: Boolean = false, options: QueryOptions = QueryOptions.empty)

Type Members

  1. type Modifier = (Statement) ⇒ Statement

    Definition Classes
    ExecutableStatement
  2. type QueryType[T <: CassandraTable[T, _], R, L <: LimitBound, O <: OrderBound, S <: ConsistencyBound, C <: WhereBound, P <: HList] = SelectQuery[T, R, L, O, S, C, P]

    Attributes
    protected[this]
    Definition Classes
    SelectQueryQuery
  3. implicit class RichSession extends SessionAugmenter

    Definition Classes
    SessionAugmenterImplicits

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def allowFiltering(): SelectQuery[Table, Record, Limit, Order, Status, Chain, PS]

  7. def and[RR, HL <: HList, Out <: HList](condition: (Table) ⇒ QueryCondition[HL])(implicit ev: =:=[Chain, Chainned], prepend: shapeless.ops.hlist.Prepend.Aux[HL, PS, Out]): QueryType[Table, Record, Limit, Order, Status, Chainned, Out]

    The where method of a select query.

    The where method of a select query.

    condition

    A where clause condition restricted by path dependant types.

    ev

    An evidence request guaranteeing the user cannot chain multiple where clauses on the same query.

    returns

    Definition Classes
    SelectQueryQuery
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def consistencyLevel_=(level: ConsistencyLevel)(implicit ev: =:=[Status, Unspecified], session: Session): SelectQuery[Table, Record, Limit, Order, Specified, Chain, PS]

    Definition Classes
    SelectQueryQuery
  11. val count: Boolean

    Attributes
    protected[com.outworkers.phantom]
  12. def create[T <: CassandraTable[T, _], R, L <: LimitBound, O <: OrderBound, S <: ConsistencyBound, C <: WhereBound, P <: HList](t: T, q: CQLQuery, r: (Row) ⇒ R, part: UsingPart, opts: QueryOptions): QueryType[T, R, L, O, S, C, P]

    Attributes
    protected[this]
    Definition Classes
    SelectQueryQuery
  13. def directMapper(results: Iterator[Row]): List[Record]

    Attributes
    protected[this]
    Definition Classes
    RootExecutableQuery
  14. def directMapper(results: List[Row])(implicit cbf: CanBuildFrom[Nothing, Record, List[Record]]): List[Record]

    Attributes
    protected[this]
    Definition Classes
    RootExecutableQuery
  15. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  17. def fetch(modifyStatement: (Statement) ⇒ Statement)(implicit session: Session, ec: ExecutionContextExecutor): Future[List[Record]]

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  18. def fetch()(implicit session: Session, ec: ExecutionContextExecutor): Future[List[Record]]

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  19. def fetchRecord(modifyStatement: (Statement) ⇒ Statement)(implicit session: Session, ec: ExecutionContextExecutor): Future[ListResult[Record]]

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  20. def fetchRecord()(implicit session: Session, ec: ExecutionContextExecutor): Future[ListResult[Record]]

    Returns a parsed sequence of [R]ows This is not suitable for big results set as it will attempt to fetch the entire result set as a List, circumventing pagination settings.

    Returns a parsed sequence of [R]ows This is not suitable for big results set as it will attempt to fetch the entire result set as a List, circumventing pagination settings.

    Use paginateRecord() or other means if you like to deal with bigger result sets.

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  21. val filteringPart: FilteringPart

    Attributes
    protected[com.outworkers.phantom]
  22. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def fromRow(row: Row): Record

    Definition Classes
    SelectQueryExecutableQuery → RootExecutableQuery
  24. def future(modifyStatement: (Statement) ⇒ Statement)(implicit session: Session, executor: ExecutionContextExecutor): Future[ResultSet]

    This will convert the underlying call to Cassandra done with Google Guava ListenableFuture to a consumable Scala Future that will be completed once the operation is completed on the database end.

    This will convert the underlying call to Cassandra done with Google Guava ListenableFuture to a consumable Scala Future that will be completed once the operation is completed on the database end.

    The execution context of the transformation is provided by phantom via com.outworkers.phantom.Manager.scalaExecutor and it is recommended to use com.outworkers.phantom.dsl.context for operations that chain database calls.

    modifyStatement

    The function allowing to modify underlying Statement

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    executor

    The implicit Scala executor.

    returns

    An asynchronous Scala future wrapping the Datastax result set.

    Definition Classes
    ExecutableStatement
  25. def future()(implicit session: Session, ec: ExecutionContextExecutor): Future[ResultSet]

    Default asynchronous query execution method.

    Default asynchronous query execution method. This will convert the underlying call to Cassandra done with Google Guava ListenableFuture to a consumable Scala Future that will be completed once the operation is completed on the database end.

    The execution context of the transformation is provided by phantom via com.outworkers.phantom.Manager.scalaExecutor and it is recommended to use com.outworkers.phantom.dsl.context for operations that chain database calls.

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    An asynchronous Scala future wrapping the Datastax result set.

    Definition Classes
    ExecutableStatement
  26. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  27. def greedyEval(f: Future[ResultSet])(implicit ex: ExecutionContextExecutor): Future[ListResult[Record]]

    Attributes
    protected[this]
    Definition Classes
    ExecutableQuery
  28. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  29. val init: CQLQuery

  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  31. def iterator(state: Option[PagingState])(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  32. def iterator(state: PagingState)(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

    Returns a parsed sequence of [R]ows.

    Returns a parsed sequence of [R]ows. This will only fetch the amount of records defined in the fetchSize setting. It will allow pagination of the inner result set as a scala.collection.immutable.List.

    It will greedy evaluate the records inside a single fetch size batch as it returns a list as opposed to an iterator. For a non greedy variant of the size method use iterator().

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  33. def iterator(modifier: (Statement) ⇒ Statement)(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

    Returns a parsed iterator of [R]ows lazily evaluated.

    Returns a parsed iterator of [R]ows lazily evaluated. This will respect the fetch size setting of a query, meaning you will need to provide a paging state to fetch records beyond the regular fetch size.

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping scala iterator of mapped results.

    Definition Classes
    ExecutableQuery
  34. def iterator()(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

    Returns a parsed iterator of [R]ows lazily evaluated.

    Returns a parsed iterator of [R]ows lazily evaluated. This will respect the fetch size setting of a query, meaning you will need to provide a paging state to fetch records beyond the regular fetch size.

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping scala iterator of mapped results.

    Definition Classes
    ExecutableQuery
  35. def lazyEval(f: Future[ResultSet])(implicit ex: ExecutionContextExecutor): Future[IteratorResult[Record]]

    Attributes
    protected[this]
    Definition Classes
    ExecutableQuery
  36. def limit(limit: Int)(implicit ev: =:=[Limit, Unlimited]): QueryType[Table, Record, Limited, Order, Status, Chain, PS]

    Definition Classes
    SelectQueryQuery
    Annotations
    @implicitNotFound( ... )
  37. final def limit(ps: PrepareMark)(implicit ev: =:=[Limit, Unlimited]): QueryType[Table, Record, Limited, Order, Status, Chain, ::[Int, PS]]

    Annotations
    @implicitNotFound( ... )
  38. val limitedPart: LimitedPart

    Attributes
    protected[com.outworkers.phantom]
  39. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  42. def one()(implicit session: Session, ev: =:=[Limit, Unlimited], ec: ExecutionContextExecutor): Future[Option[Record]]

    Returns the first row from the select ignoring everything else

    Returns the first row from the select ignoring everything else

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ev

    The implicit limit for the query.

    ec

    The implicit Scala execution context.

    returns

    A Scala future guaranteed to contain a single result wrapped as an Option.

    Definition Classes
    SelectQueryExecutableQuery
    Annotations
    @implicitNotFound( ... )
  43. val options: QueryOptions

    Definition Classes
    SelectQueryQueryExecutableStatement
  44. final def orderBy(clauses: (Table) ⇒ Condition*)(implicit ev: =:=[Order, Unordered]): SelectQuery[Table, Record, Limit, Ordered, Status, Chain, PS]

    Annotations
    @implicitNotFound( ... )
  45. val orderPart: OrderPart

    Attributes
    protected[com.outworkers.phantom]
  46. def paginateRecord(modifier: (Statement) ⇒ Statement)(implicit session: Session, ec: ExecutionContextExecutor, cbf: CanBuildFrom[Nothing, Record, List[Record]]): Future[ListResult[Record]]

    Returns a parsed sequence of [R]ows.

    Returns a parsed sequence of [R]ows. This will only fetch the amount of records defined in the fetchSize setting. It will allow pagination of the inner result set as a scala.collection.immutable.List.

    It will greedy evaluate the records inside a single fetch size batch as it returns a list as opposed to an iterator. For a non greedy variant of the size method use iterator().

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  47. def paginateRecord(state: Option[PagingState])(implicit session: Session, ec: ExecutionContextExecutor, cbf: CanBuildFrom[Nothing, Record, List[Record]]): Future[ListResult[Record]]

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    Returns a parsed sequence of [R]ows This is not suitable for big results set

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  48. def paginateRecord(state: PagingState)(implicit session: Session, ec: ExecutionContextExecutor, cbf: CanBuildFrom[Nothing, Record, Iterator[Record]]): Future[ListResult[Record]]

    Returns a parsed sequence of [R]ows.

    Returns a parsed sequence of [R]ows. This will only fetch the amount of records defined in the fetchSize setting. It will allow pagination of the inner result set as a scala.collection.immutable.List.

    It will greedy evaluate the records inside a single fetch size batch as it returns a list as opposed to an iterator. For a non greedy variant of the size method use iterator().

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  49. def paginateRecord()(implicit session: Session, ec: ExecutionContextExecutor, cbf: CanBuildFrom[Nothing, Record, List[Record]]): Future[ListResult[Record]]

    Returns a parsed sequence of [R]ows but paginates the results using paging state.

    Returns a parsed sequence of [R]ows but paginates the results using paging state. This will not consume or return the entire set of available results, it will instead return an amount of records equal to the fetch size setting.

    session

    The implicit session provided by a com.outworkers.phantom.connectors.Connector.

    ec

    The implicit Scala execution context.

    returns

    A Scala future wrapping a list of mapped results.

    Definition Classes
    ExecutableQuery
  50. def prepare[Rev <: HList]()(implicit session: Session, keySpace: KeySpace, ev: =:!=[PS, HNil], rev: Aux[PS, Rev]): PreparedSelectBlock[Table, Record, Limit, Rev]

  51. def preparedStatementToPromise(st: String)(implicit session: Session, executor: ExecutionContextExecutor): Promise[PreparedStatement]

    Attributes
    protected[this]
    Definition Classes
    CassandraOperations
  52. val qb: CQLQuery

    Definition Classes
    SelectQueryQueryExecutableStatement
  53. def queryString: String

    Definition Classes
    ExecutableStatement
  54. val rowFunc: (Row) ⇒ Record

    Attributes
    protected[com.outworkers.phantom]
  55. def scalaQueryStringExecuteToFuture(st: Statement)(implicit session: Session, executor: ExecutionContextExecutor): Future[ResultSet]

    Attributes
    protected[this]
    Definition Classes
    CassandraOperations
  56. def scalaQueryStringToPromise(st: Statement)(implicit session: Session, executor: ExecutionContextExecutor): Promise[ResultSet]

    Attributes
    protected[this]
    Definition Classes
    CassandraOperations
  57. def singleResult(row: Row): Option[Record]

    Attributes
    protected[this]
    Definition Classes
    RootExecutableQuery
  58. def statement()(implicit session: Session): Statement

    Definition Classes
    ExecutableStatement
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  60. val table: Table

    Attributes
    protected[com.outworkers.phantom]
  61. def toString(): String

    Definition Classes
    AnyRef → Any
  62. def ttl(duration: FiniteDuration): QueryType[Table, Record, Limit, Order, Status, Chain, PS]

    Definition Classes
    Query
  63. def ttl(seconds: Long): QueryType[Table, Record, Limit, Order, Status, Chain, PS]

    Definition Classes
    Query
  64. def using(clause: Condition): SelectQuery[Table, Record, Limit, Order, Status, Chainned, PS]

  65. val usingPart: UsingPart

    Attributes
    protected[com.outworkers.phantom]
  66. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. def where[RR, HL <: HList, Out <: HList](condition: (Table) ⇒ QueryCondition[HL])(implicit ev: =:=[Chain, Unchainned], prepend: shapeless.ops.hlist.Prepend.Aux[HL, PS, Out]): QueryType[Table, Record, Limit, Order, Status, Chainned, Out]

    The where method of a select query.

    The where method of a select query.

    condition

    A where clause condition restricted by path dependant types.

    ev

    An evidence request guaranteeing the user cannot chain multiple where clauses on the same query.

    returns

    Definition Classes
    SelectQueryQuery
  70. val wherePart: WherePart

    Attributes
    protected[com.outworkers.phantom]

Inherited from ExecutableQuery[Table, Record, Limit]

Inherited from RootExecutableQuery[Record]

Inherited from Query[Table, Record, Limit, Order, Status, Chain, PS]

Inherited from ExecutableStatement

Inherited from CassandraOperations

Inherited from SessionAugmenterImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped