SelectQuery

Instance Constructors

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

type Modifier = (Statement) ⇒ Statement

Definition Classes
ExecutableStatement
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
SelectQuery → Query
implicit class RichSession extends SessionAugmenter

Definition Classes
SessionAugmenterImplicits

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def aggregate[Inner]()(implicit session: Session, ev: =:=[Limit, Unlimited], opt: <:<[Record, Option[Inner]], ec: ExecutionContextExecutor): Future[Option[Inner]]

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.

Annotations
@implicitNotFound( ... )
def allowFiltering(): SelectQuery[Table, Record, Limit, Order, Status, Chain, PS]
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.

Definition Classes
SelectQuery → Query
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
SelectQuery → Query
val count: Boolean

Attributes
protected[com.outworkers.phantom]
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
SelectQuery → Query
def directMapper(results: Iterator[Row]): List[Record]

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

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

Definition Classes
AnyRef → Any
def fetch(modifyStatement: Modifier)(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
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
def fetchRecord(modifyStatement: Modifier)(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
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
val filteringPart: FilteringPart

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flattenedOption[Inner](row: Option[Row])(implicit ev: <:<[Record, Option[Inner]]): Option[Inner]

Attributes
protected[this]
Definition Classes
RootExecutableQuery
def fromRow(row: Row): Record

Definition Classes
SelectQuery → ExecutableQuery → RootExecutableQuery
def future(modifyStatement: Modifier)(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
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
final def getClass(): Class[_]

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

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

Definition Classes
AnyRef → Any
val init: CQLQuery
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
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
def iterator(modifier: Modifier)(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
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
def lazyEval(f: Future[ResultSet])(implicit ex: ExecutionContextExecutor): Future[IteratorResult[Record]]

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

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

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
SelectQuery → ExecutableQuery
Annotations
@implicitNotFound( ... )
val options: QueryOptions

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

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

Attributes
protected[com.outworkers.phantom]
def paginateRecord(modifier: Modifier)(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
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
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
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
def prepare[Rev <: HList]()(implicit session: Session, keySpace: KeySpace, ev: =:!=[PS, HNil], rev: Aux[PS, Rev]): PreparedSelectBlock[Table, Record, Limit, Rev]
val qb: CQLQuery

Definition Classes
SelectQuery → Query → ExecutableStatement
def queryString: String

Definition Classes
ExecutableStatement
val rowFunc: (Row) ⇒ Record

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

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

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

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

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

Definition Classes
AnyRef
val table: Table

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

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

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

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

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
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.

Definition Classes
SelectQuery → Query
val wherePart: WherePart

Attributes
protected[com.outworkers.phantom]

Related Docs: object SelectQuery | package query

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]

Instance Constructors

Type Members

type Modifier = (Statement) ⇒ Statement

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

implicit class RichSession extends SessionAugmenter

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def aggregate[Inner]()(implicit session: Session, ev: =:=[Limit, Unlimited], opt: <:<[Record, Option[Inner]], ec: ExecutionContextExecutor): Future[Option[Inner]]

def allowFiltering(): SelectQuery[Table, Record, Limit, Order, Status, Chain, PS]

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]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def consistencyLevel_=(level: ConsistencyLevel)(implicit ev: =:=[Status, Unspecified], session: Session): SelectQuery[Table, Record, Limit, Order, Specified, Chain, PS]

val count: Boolean

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]

def directMapper(results: Iterator[Row]): List[Record]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fetch(modifyStatement: Modifier)(implicit session: Session, ec: ExecutionContextExecutor): Future[List[Record]]

def fetch()(implicit session: Session, ec: ExecutionContextExecutor): Future[List[Record]]

def fetchRecord(modifyStatement: Modifier)(implicit session: Session, ec: ExecutionContextExecutor): Future[ListResult[Record]]

def fetchRecord()(implicit session: Session, ec: ExecutionContextExecutor): Future[ListResult[Record]]

val filteringPart: FilteringPart

def finalize(): Unit

def flattenedOption[Inner](row: Option[Row])(implicit ev: <:<[Record, Option[Inner]]): Option[Inner]

def fromRow(row: Row): Record

def future(modifyStatement: Modifier)(implicit session: Session, executor: ExecutionContextExecutor): Future[ResultSet]

def future()(implicit session: Session, ec: ExecutionContextExecutor): Future[ResultSet]

final def getClass(): Class[_]

def greedyEval(f: Future[ResultSet])(implicit ex: ExecutionContextExecutor): Future[ListResult[Record]]

def hashCode(): Int

val init: CQLQuery

final def isInstanceOf[T0]: Boolean

def iterator(state: Option[PagingState])(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

def iterator(state: PagingState)(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

def iterator(modifier: Modifier)(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

def iterator()(implicit session: Session, ec: ExecutionContextExecutor): Future[IteratorResult[Record]]

def lazyEval(f: Future[ResultSet])(implicit ex: ExecutionContextExecutor): Future[IteratorResult[Record]]

def limit(limit: Int)(implicit ev: =:=[Limit, Unlimited]): QueryType[Table, Record, Limited, Order, Status, Chain, PS]

final def limit(ps: PrepareMark)(implicit ev: =:=[Limit, Unlimited]): QueryType[Table, Record, Limited, Order, Status, Chain, ::[Int, PS]]

val limitedPart: LimitedPart

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

val options: QueryOptions

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

val orderPart: OrderPart

def paginateRecord(modifier: Modifier)(implicit session: Session, ec: ExecutionContextExecutor, cbf: CanBuildFrom[Nothing, Record, List[Record]]): Future[ListResult[Record]]

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

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

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

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

val qb: CQLQuery

def queryString: String

val rowFunc: (Row) ⇒ Record

def scalaQueryStringExecuteToFuture(st: Statement)(implicit session: Session, executor: ExecutionContextExecutor): Future[ResultSet]

def scalaQueryStringToPromise(st: Statement)(implicit session: Session, executor: ExecutionContextExecutor): Promise[ResultSet]

def singleResult(row: Option[Row]): Option[Record]

def statement()(implicit session: Session): Statement

final def synchronized[T0](arg0: ⇒ T0): T0

val table: Table

def toString(): String

def ttl(duration: FiniteDuration): QueryType[Table, Record, Limit, Order, Status, Chain, PS]

def ttl(seconds: Long): QueryType[Table, Record, Limit, Order, Status, Chain, PS]

def using(clause: Condition): SelectQuery[Table, Record, Limit, Order, Status, Chainned, PS]

val usingPart: UsingPart

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

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]

val wherePart: WherePart

Inherited from ExecutableQuery[Table, Record, Limit]

Inherited from RootExecutableQuery[Record]

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