com.outworkers.phantom

dsl

package dsl

Linear Supertypes
DefaultImports, DefaultSASIOps, DeleteImplicits, KeySpaceConstruction, TopologyStrategies, UsingClauseOperations, Operators, SelectImplicits, CreateImplicits, TablePropertyClauses, CompressionStrategies, CompactionStrategies, ImplicitMechanism, ModifyMechanism, ScalaQueryContext, QueryContext[Promise, Future, Duration], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. dsl
  2. DefaultImports
  3. DefaultSASIOps
  4. DeleteImplicits
  5. KeySpaceConstruction
  6. TopologyStrategies
  7. UsingClauseOperations
  8. Operators
  9. SelectImplicits
  10. CreateImplicits
  11. TablePropertyClauses
  12. CompressionStrategies
  13. CompactionStrategies
  14. ImplicitMechanism
  15. ModifyMechanism
  16. ScalaQueryContext
  17. QueryContext
  18. AnyRef
  19. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Analyzer[M <: Mode] = builder.query.sasi.Analyzer[M]

    Definition Classes
    DefaultImports
  2. type Ascending = keys.Ascending

    Definition Classes
    DefaultImports
  3. implicit class BatchOps[Status <: ConsistencyBound] extends AnyRef

    Definition Classes
    QueryContext
  4. type CassandraConnection = connectors.CassandraConnection

    Definition Classes
    DefaultImports
  5. type CassandraTable[Owner <: CassandraTable[Owner, Record], Record] = phantom.CassandraTable[Owner, Record]

    Definition Classes
    DefaultImports
  6. implicit class CassandraTableStoreMethods[T <: CassandraTable[T, R], R] extends AnyRef

    Definition Classes
    QueryContext
  7. type ClusteringOrder = keys.ClusteringOrder

    Definition Classes
    DefaultImports
  8. implicit class CounterOperations[Owner <: CassandraTable[Owner, Record], Record] extends AnyRef

    Definition Classes
    DefaultImports
  9. implicit class CreateQueryOps[Table <: CassandraTable[Table, Record], Record, Consistency <: ConsistencyBound] extends MultiQueryInterface[Seq, F]

    Definition Classes
    QueryContext
  10. type CustomIndex[M <: Mode] = keys.SASIIndex[M]

    Definition Classes
    DefaultImports
  11. type Database[DB <: Database[DB]] = database.Database[DB]

    Definition Classes
    DefaultImports
  12. implicit class DatabaseOperation[DB <: Database[DB]] extends DbOps[P, F, DB, Timeout]

    Definition Classes
    QueryContext
  13. type DatabaseProvider[DB <: Database[DB]] = database.DatabaseProvider[DB]

    Definition Classes
    DefaultImports
  14. sealed class DateTieredCompactionStrategy extends CompactionProperties[DateTieredCompactionStrategy]

    Definition Classes
    CompactionStrategies
  15. type DateTime = org.joda.time.DateTime

    Definition Classes
    DefaultImports
  16. implicit class DateTimeAugmenter extends AnyRef

    Definition Classes
    DefaultImports
  17. class DeflateCompressor extends CompressionStrategy[DeflateCompressor]

    Definition Classes
    CompressionStrategies
  18. type Descending = keys.Descending

    Definition Classes
    DefaultImports
  19. type Entries = keys.Entries

    Definition Classes
    DefaultImports
  20. implicit class ExecutablePrepareQueryOps extends QueryInterface[F]

    Definition Classes
    QueryContext
  21. implicit class ExecutablePreparedSelect[Table <: CassandraTable[Table, _], R, Limit <: LimitBound] extends ResultQueryInterface[F, Table, R, Limit]

    Definition Classes
    QueryContext
  22. implicit final class ExecuteQueries[M[X] <: TraversableOnce[X]] extends AnyVal

  23. type Index = keys.Index

    Definition Classes
    DefaultImports
  24. type IteratorResult[R] = builder.query.execution.IteratorResult[R]

    Definition Classes
    DefaultImports
  25. type KeySpace = connectors.KeySpace

    Definition Classes
    DefaultImports
  26. implicit class KeySpaceAugmenter extends AnyRef

    Used when creating a ContactPoint to allow users to provide a single KeySpace derived query.

  27. type KeySpaceDef = connectors.CassandraConnection

    Definition Classes
    DefaultImports
  28. type Keys = keys.Keys

    Definition Classes
    DefaultImports
  29. class LZ4Compressor extends CompressionStrategy[LZ4Compressor]

    Definition Classes
    CompressionStrategies
  30. sealed class LeveledCompactionStrategy extends CompactionProperties[LeveledCompactionStrategy]

    Definition Classes
    CompactionStrategies
  31. implicit class ListLikeModifyColumn[Owner <: CassandraTable[Owner, Record], Record, RR] extends AnyRef

    Definition Classes
    DefaultImports
  32. type ListResult[R] = builder.query.execution.ListResult[R]

    Definition Classes
    DefaultImports
  33. type LocalDate = org.joda.time.LocalDate

    Definition Classes
    DefaultImports
  34. implicit class MapKeyConditionals[T <: CassandraTable[T, R], R, K, V] extends AnyRef

    Definition used to cast an index map column with keys indexed to a query-able definition.

  35. implicit class MapLikeModifyColumn[Owner <: CassandraTable[Owner, Record], Record, A, B] extends AnyRef

    Definition Classes
    DefaultImports
  36. sealed class NetworkTopologyStrategy extends ReplicationStrategy[NetworkTopologyStrategy]

    Definition Classes
    TopologyStrategies
  37. type NonTokenizingAnalyzer[M <: Mode] = builder.query.sasi.Analyzer.NonTokenizingAnalyzer[M]

    Definition Classes
    DefaultImports
  38. type PartitionKey = keys.PartitionKey

    Definition Classes
    DefaultImports
  39. implicit class PartitionTokenHelper[T] extends AnyRef

    Definition Classes
    DefaultImports
  40. type PrimaryKey = keys.PrimaryKey

    Definition Classes
    DefaultImports
  41. type Primitive[RR] = builder.primitives.Primitive[RR]

    Definition Classes
    DefaultImports
  42. implicit class QueryCollectionOps[M[X] <: TraversableOnce[X]] extends AnyRef

    Definition Classes
    QueryContext
  43. type QueryNotExecuted = ops.QueryNotExecuted

    Definition Classes
    QueryContext
  44. type RecordResult[R] = builder.query.execution.RecordResult[R]

    Definition Classes
    DefaultImports
  45. type ResultSet = phantom.ResultSet

    Definition Classes
    DefaultImports
  46. implicit class RichNumber extends AnyRef

    Definition Classes
    DefaultImports
  47. type RootConnector = connectors.RootConnector

    Definition Classes
    DefaultImports
  48. implicit class RootQueryOps[Table <: CassandraTable[Table, _], Record, Status <: ConsistencyBound] extends AnyRef

    Definition Classes
    QueryContext
  49. implicit class RootSelectBlockOps[Table <: CassandraTable[Table, _], Record] extends ResultQueryInterface[F, Table, Record, Unlimited]

    Definition Classes
    QueryContext
  50. type Row = phantom.Row

    Definition Classes
    DefaultImports
  51. type SASIIndex[M <: Mode] = keys.SASIIndex[M]

    Definition Classes
    DefaultImports
  52. implicit class SelectColumnOptional[Owner <: CassandraTable[Owner, Record], Record, T] extends SelectColumn[Option[T]]

    Definition Classes
    DefaultImports
  53. implicit class SelectColumnRequired[Owner <: CassandraTable[Owner, Record], Record, T] extends SelectColumn[T]

    Definition Classes
    DefaultImports
  54. implicit class SelectOps[Table <: CassandraTable[Table, _], Record, Limit <: LimitBound, Order <: OrderBound, Status <: ConsistencyBound, Chain <: WhereBound, PS <: HList] extends SelectQueryOps[Nothing, F, Table, Record, Limit, Order, Status, Chain, PS]

    Definition Classes
    QueryContext
  55. type Session = datastax.driver.core.Session

    Definition Classes
    DefaultImports
  56. implicit class SetConditionals[T <: CassandraTable[T, R], R, RR] extends AnyRef

    Definition Classes
    DefaultImports
  57. implicit class SetLikeModifyColumn[Owner <: CassandraTable[Owner, Record], Record, RR] extends AnyRef

    Definition Classes
    DefaultImports
  58. sealed class SimpleStrategy extends ReplicationStrategy[SimpleStrategy]

    Definition Classes
    TopologyStrategies
  59. sealed class SizeTieredCompactionStrategy extends CompactionProperties[SizeTieredCompactionStrategy]

    Definition Classes
    CompactionStrategies
  60. class SnappyCompressor extends CompressionStrategy[SnappyCompressor]

    Definition Classes
    CompressionStrategies
  61. type StandardAnalyzer[M <: Mode] = builder.query.sasi.Analyzer.StandardAnalyzer[M]

    Definition Classes
    DefaultImports
  62. type StaticColumn = keys.StaticColumn

    Definition Classes
    DefaultImports
  63. type Table[Owner <: Table[Owner, Record], Record] = phantom.Table[Owner, Record]

    Definition Classes
    DefaultImports
  64. sealed class TimeWindowCompactionStrategy extends CompactionProperties[TimeWindowCompactionStrategy]

    Definition Classes
    CompactionStrategies
  65. type UUID = java.util.UUID

    Definition Classes
    DefaultImports
  66. implicit class UUIDAugmenter extends AnyRef

    Definition Classes
    DefaultImports
  67. implicit class VersionAugmenter extends AnyRef

    Augments Cassandra VersionNumber descriptors to support simple comparison of versions.

Abstract Value Members

  1. abstract def blockAwait[T](f: F[T], timeout: Timeout): T

    An abstract implementation for blockingly waiting for future completion.

    An abstract implementation for blockingly waiting for future completion. We need this for synchronously prepared statements and other instances and a mechanism to abstract over the various future backends.

    T

    the type of the underlying future.

    f

    The underlying future to wait for.

    timeout

    The amount of time to wait for.

    returns

    The underlying value if the future is successfully completed, or an error thrown otherwise.

    Definition Classes
    QueryContext

Concrete Value Members

  1. object ? extends PrepareMark

    Definition Classes
    DefaultImports
  2. val Analyzer: builder.query.sasi.Analyzer.type

    Definition Classes
    DefaultImports
  3. object Batch extends Batcher with Product with Serializable

    Definition Classes
    DefaultImports
  4. val Cache: CachingStrategies

    Definition Classes
    CreateImplicits
  5. object Caching extends CachingStrategies

    Definition Classes
    TablePropertyClauses
  6. object ConsistencyLevel

    Definition Classes
    DefaultImports
  7. val ContactPoint: connectors.ContactPoint.type

    Definition Classes
    DefaultImports
  8. val ContactPoints: connectors.ContactPoints.type

    Definition Classes
    DefaultImports
  9. object DateTieredCompactionStrategy extends DateTieredCompactionStrategy with Product with Serializable

    Definition Classes
    CompactionStrategies
  10. object DeflateCompressor extends DeflateCompressor

    Definition Classes
    CompressionStrategies
  11. val KeySpace: connectors.KeySpace.type

    Definition Classes
    DefaultImports
  12. object LZ4Compressor extends LZ4Compressor

    Definition Classes
    CompressionStrategies
  13. object LeveledCompactionStrategy extends LeveledCompactionStrategy with Product with Serializable

    Definition Classes
    CompactionStrategies
  14. val Mode: builder.query.sasi.Mode.type

    Definition Classes
    DefaultImports
  15. object NetworkTopologyStrategy extends NetworkTopologyStrategy

    Definition Classes
    TopologyStrategies
  16. val Primitive: builder.primitives.Primitive.type

    Definition Classes
    DefaultImports
  17. object SimpleStrategy extends SimpleStrategy

    Definition Classes
    TopologyStrategies
  18. object SizeTieredCompactionStrategy extends SizeTieredCompactionStrategy with Product with Serializable

    Definition Classes
    CompactionStrategies
  19. object SnappyCompressor extends SnappyCompressor

    Definition Classes
    CompressionStrategies
  20. object Storage

    Definition Classes
    TablePropertyClauses
  21. object TimeWindowCompactionStrategy extends TimeWindowCompactionStrategy with Product with Serializable

    Definition Classes
    CompactionStrategies
  22. val Version: DefaultVersions.type

    Definition Classes
    DefaultImports
  23. implicit val adapter: GuavaAdapter[F]

    Definition Classes
    QueryContext
  24. def apply[T <: phantom.CassandraTable[T, _], R](root: RootCreateQuery[T, R])(implicit keySpace: connectors.KeySpace): Default[T, R]

    Definition Classes
    CreateImplicits
  25. implicit def assignmentUpdateOps[T <: phantom.CassandraTable[T, _], R, L <: LimitBound, O <: OrderBound, S <: ConsistencyBound, Chain <: WhereBound, PS <: HList, MP <: HList](query: AssignmentsQuery[T, R, L, O, S, Chain, PS, MP]): UpdateIncompleteQueryOps[P, F]

    Definition Classes
    QueryContext
  26. object avg extends AvgCqlFunction

    Definition Classes
    Operators
  27. final val bloom_filter_fp_chance: BloomFilterFpChanceBuilder

    Definition Classes
    TablePropertyClauses
  28. final val caching: CachingBuilder

    Definition Classes
    TablePropertyClauses
  29. implicit def columnClauseToDeleteCondition(col: AbstractColumn[_]): Condition

    Definition Classes
    DeleteImplicits
  30. implicit final def columnToCasCompareColumn[RR](col: AbstractColumn[RR])(implicit ev: <:!<[col.type, Indexed]): CasConditionalOperators[RR]

    Definition Classes
    ImplicitMechanism
    Annotations
    @implicitNotFound( ... )
  31. implicit final def columnToDropColumn[T](col: AbstractColumn[T])(implicit ev: <:!<[col.type, Undroppable]): DropColumn[T]

    Definition Classes
    ImplicitMechanism
    Annotations
    @implicitNotFound( ... )
  32. implicit def columnToModifyColumn[RR](col: AbstractColumn[RR])(implicit ev: <:!<[col.type, Unmodifiable], ev2: <:!<[col.type, CollectionValueDefinition[RR]]): ModifyColumn[RR]

    Definition Classes
    ModifyMechanism
    Annotations
    @implicitNotFound( ... )
  33. implicit def columnUpdateClauseToDeleteCondition(clause: MapKeyUpdateClause[_, _]): Condition

    Definition Classes
    DeleteImplicits
  34. final val comment: CommentClauseBuilder

    Definition Classes
    TablePropertyClauses
  35. final val compaction: CompactionBuilder

    Table creation clause allowing specification of CQL compaction strategies.

    Table creation clause allowing specification of CQL compaction strategies.

    • SizeTieredCompactionStrategy
    • LeveledCompactionStrategy
    • DateTieredCompactionStrategy
    import com.outworkers.phantom.dsl._
    
    SomeTable.create.`with`(compaction eqs SnappyCompressor)
    Definition Classes
    TablePropertyClauses
  36. final val compression: CompressionBuilder

    Helper object used to specify the compression strategy for a table.

    Helper object used to specify the compression strategy for a table. According to the Cassandra specification, the available strategies are:

    • SnappyCompressor
    • LZ4Compressor
    • DeflateCompressor

    A simple way to define a strategy is by using the {{eqs}} method.

    import com.outworkers.phantom.dsl._
    
    SomeTable.create.with(compression eqs SnappyCompressor)

    Using a compression strategy also allows using the API methods of controlling compressor behaviour:

    import com.outworkers.phantom.dsl._
    import com.twitter.conversions.storage._
    
    SomeTable.create.`with`(compression eqs SnappyCompressor.chunk_length_kb(50.kilobytes))
    Definition Classes
    TablePropertyClauses
  37. implicit def conditionalUpdateOps[T <: phantom.CassandraTable[T, _], R, L <: LimitBound, O <: OrderBound, S <: ConsistencyBound, Chain <: WhereBound, PS <: HList, MP <: HList](query: ConditionalQuery[T, R, L, O, S, Chain, PS, MP]): UpdateIncompleteQueryOps[P, F]

    Definition Classes
    QueryContext
  38. object contains

    Definition Classes
    DefaultSASIOps
  39. implicit val context: ExecutionContextExecutor

    Definition Classes
    DefaultImports
  40. object count extends CountCqlFunction

    Definition Classes
    Operators
  41. def cql(str: String, options: QueryOptions = QueryOptions.empty): QueryInterface[Future]

    Method that allows executing a simple query straight from text, by-passing the entire mapping layer but leveraging the execution layer.

    Method that allows executing a simple query straight from text, by-passing the entire mapping layer but leveraging the execution layer.

    str

    The input CQLQuery to execute.

    options

    The QueryOptions to pass alongside the query.

    returns

    A future wrapping a database result set.

  42. def cql(str: CQLQuery, options: QueryOptions): QueryInterface[Future]

    Method that allows executing a simple query straight from text, by-passing the entire mapping layer but leveraging the execution layer.

    Method that allows executing a simple query straight from text, by-passing the entire mapping layer but leveraging the execution layer.

    str

    The input CQLQuery to execute.

    options

    The QueryOptions to pass alongside the query.

    returns

    A future wrapping a database result set.

  43. object dateOf extends DateOfCqlFunction

    Definition Classes
    Operators
  44. final val dclocal_read_repair_chance: DcLocalReadRepairChanceBuilder

    Definition Classes
    TablePropertyClauses
  45. final val default_time_to_live: TimeToLiveBuilder

    Definition Classes
    TablePropertyClauses
  46. val durable_writes: AnyRef { def eqs(clause: Boolean): com.outworkers.phantom.builder.serializers.BuilderClause }

    Definition Classes
    TopologyStrategies
  47. def executeStatements[M[X] <: TraversableOnce[X]](col: QueryCollection[M]): ExecutableStatements[F, M]

    Definition Classes
    QueryContext
  48. implicit val futureMonad: FutureMonad[Future]

  49. final val gc_grace_seconds: GcGraceSecondsBuilder

    Definition Classes
    TablePropertyClauses
  50. object ignoreNulls extends Condition

    Definition Classes
    UsingClauseOperations
  51. implicit def keyspaceToKeyspaceQuery(k: KeySpace): RootSerializer

    Used as a secondary option when creating a ContactPoint to allow users to provide a single KeySpace derived query.

    Used as a secondary option when creating a ContactPoint to allow users to provide a single KeySpace derived query. When users want to provide a single argument to the ContactPoint#keySpace method, they can use the following syntax to generate a full keyspace initialisation query. The KeySpace will implicitly convert to a RootSerializer.

    KeySpace("test").ifNotExists
    Definition Classes
    DefaultImports
  52. implicit def mapColumnDefinitionToEntriesQueryColumn[K, V](cond: MapKeyUpdateClause[K, V])(implicit arg0: builder.primitives.Primitive[K], arg1: builder.primitives.Primitive[V]): MapEntriesConditionals[K, V]

    Definition used to cast a comparison clause to Map entry lookup based on a secondary index.

    Definition used to cast a comparison clause to Map entry lookup based on a secondary index.

    K

    The type of the key inside the MapColumn.

    V

    The type of the value held inside the MapColumn.

    cond

    The column update clause generated from MapColumn.apply(keyValue)

    returns

    A MapEntriesConditionals query that allows secondary index operators on map entries.

    Definition Classes
    ImplicitMechanism
  53. implicit def mapColumnToQueryColumn[T <: phantom.CassandraTable[T, R], R, K, V](col: AbstractMapColumn[T, R, K, V] with keys.Index)(implicit ev: <:!<[col, keys.Keys]): MapConditionals[T, R, K, V]

    Definition used to cast an index map column with values indexed to a query-able definition.

    Definition used to cast an index map column with values indexed to a query-able definition. This will allow users to use "CONTAINS" clauses to search for matches based on map values.

    T

    The Cassandra table inner type.

    R

    The record type of the table.

    K

    The type of the key held in the map.

    V

    The type of the value held in the map.

    col

    The map column to cast to a Map column secondary index query.

    returns

    A MapConditionals class with CONTAINS support.

    Definition Classes
    ImplicitMechanism
  54. object max extends MaxCqlFunction

    Definition Classes
    Operators
  55. object maxTimeuuid extends MaxTimeUUID

    Definition Classes
    Operators
  56. object min extends MinCqlFunction

    Definition Classes
    Operators
  57. object minTimeuuid extends MinTimeUUID

    Definition Classes
    Operators
  58. object now extends NowCqlFunction

    Definition Classes
    Operators
  59. implicit def optionalColumnToModifyColumn[Table <: phantom.CassandraTable[Table, Rec], Rec, RR](col: OptionalColumn[Table, Rec, RR])(implicit ev: <:!<[col.type, Unmodifiable], ev2: <:!<[col.type, CollectionValueDefinition[RR]]): ModifyColumnOptional[RR]

    Definition Classes
    ModifyMechanism
    Annotations
    @implicitNotFound( ... )
  60. implicit def orderingColumn[RR](col: AbstractColumn[RR] with keys.PrimaryKey): OrderingColumn[RR]

    Definition Classes
    ImplicitMechanism
  61. object prefix

    Definition Classes
    DefaultSASIOps
  62. implicit val promiseInterface: PromiseInterface[P, F]

    Definition Classes
    QueryContext
  63. final val read_repair_chance: ReadRepairChanceBuilder

    Definition Classes
    TablePropertyClauses
  64. final val replicate_on_write: ReplicateOnWriteBuilder

    Definition Classes
    TablePropertyClauses
  65. val replication: AnyRef { def eqs(strategy: com.outworkers.phantom.builder.serializers.ReplicationStrategy[_]): com.outworkers.phantom.builder.serializers.BuilderClause }

    Definition Classes
    TopologyStrategies
  66. implicit def rootCreateQueryToCreateQuery[T <: phantom.CassandraTable[T, _], R](root: RootCreateQuery[T, R])(implicit keySpace: connectors.KeySpace): Default[T, R]

    Definition Classes
    CreateImplicits
  67. implicit final def rootSelectBlockToSelectQuery[T <: phantom.CassandraTable[T, _], R](root: RootSelectBlock[T, R])(implicit keySpace: connectors.KeySpace): Default[T, R]

    Definition Classes
    SelectImplicits
    Annotations
    @implicitNotFound( ... )
  68. implicit def rootSerializerToKeySpaceSerializer(serializer: RootSerializer): KeySpaceSerializer

    Definition Classes
    KeySpaceConstruction
  69. implicit def sasiGenericOps[RR](col: AbstractColumn[RR] with keys.SASIIndex[_ <: Mode])(implicit arg0: builder.primitives.Primitive[RR]): QueryColumn[RR]

    Definition Classes
    ImplicitMechanism
  70. implicit def sasiTextOps[M <: Mode](col: AbstractColumn[String] with keys.SASIIndex[M])(implicit ev: builder.primitives.Primitive[String]): SASITextOps[M]

    Definition Classes
    ImplicitMechanism
  71. object suffix

    Definition Classes
    DefaultSASIOps
  72. object sum extends SumCqlFunction

    Definition Classes
    Operators
  73. object token extends TokenCqlFunction

    Definition Classes
    Operators
  74. object ttl extends TTLOfFunction

    Definition Classes
    Operators
  75. object unixTimestampOf extends UnixTimestampOfCqlFunction

    Definition Classes
    Operators
  76. implicit def updateOps[T <: phantom.CassandraTable[T, _], R, L <: LimitBound, O <: OrderBound, S <: ConsistencyBound, Chain <: WhereBound, PS <: HList](query: UpdateQuery[T, R, L, O, S, Chain, PS]): UpdateIncompleteQueryOps[P, F]

    Definition Classes
    QueryContext
  77. object writetime extends WritetimeCqlFunction

    Definition Classes
    Operators

Inherited from DefaultImports

Inherited from DefaultSASIOps

Inherited from DeleteImplicits

Inherited from KeySpaceConstruction

Inherited from TopologyStrategies

Inherited from UsingClauseOperations

Inherited from Operators

Inherited from SelectImplicits

Inherited from CreateImplicits

Inherited from TablePropertyClauses

Inherited from CompressionStrategies

Inherited from CompactionStrategies

Inherited from ImplicitMechanism

Inherited from ModifyMechanism

Inherited from ScalaQueryContext

Inherited from QueryContext[Promise, Future, Duration]

Inherited from AnyRef

Inherited from Any

Ungrouped