Class/Object

com.outworkers.phantom.builder.query

AlterQuery

Related Docs: object AlterQuery | package query

Permalink

class AlterQuery[Table <: CassandraTable[Table, _], Record, Status <: ConsistencyBound, Chain <: WithBound] extends ExecutableStatement

Linear Supertypes
ExecutableStatement, CassandraOperations, SessionAugmenterImplicits, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AlterQuery
  2. ExecutableStatement
  3. CassandraOperations
  4. SessionAugmenterImplicits
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AlterQuery(table: Table, qb: CQLQuery, options: QueryOptions)

    Permalink

Type Members

  1. type Modifier = (Statement) ⇒ Statement

    Permalink
    Definition Classes
    ExecutableStatement
  2. implicit class RichSession extends SessionAugmenter

    Permalink
    Definition Classes
    SessionAugmenterImplicits

Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def add(definition: CQLQuery): AlterQuery[Table, Record, Status, Chain]

    Permalink
  5. final def add(column: String, columnType: String, static: Boolean = false): AlterQuery[Table, Record, Status, Chain]

    Permalink
  6. final def alter[RR](columnSelect: (Table) ⇒ AbstractColumn[RR], newType: String): AlterQuery[Table, Record, Status, Chain]

    Permalink
  7. final def and(clause: TablePropertyClause)(implicit ev: =:=[Chain, WithChainned]): AlterQuery[Table, Record, Status, WithChainned]

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. final def drop(column: String): AlterQuery[Table, Record, Status, Chain]

    Permalink

    Creates an ALTER drop query to drop the column from the schema definition.

    Creates an ALTER drop query to drop the column from the schema definition. It will produce the following type of queries, with the CQL serialization on the right hand side:

    MyTable.alter.drop(_.mycolumn) => ALTER TABLE MyTable DROP myColumn

    This is used mainly during the autodiffing of schemas, where column selectors are not available and we only deal with plain string diffs between table metadata collections.

    column

    The string name of the column to drop.

    returns

    A new alter query with the underlying builder containing a DROP clause.

  11. final def drop()(implicit keySpace: KeySpace): AlterQuery[Table, Record, Status, Chain]

    Permalink

    Creates an ALTER DROP query that drops an entire table.

    Creates an ALTER DROP query that drops an entire table. This is equivalent to table truncation followed by table removal from the keyspace metadata. This action is irreversible and you should exercise caution is using it.

    keySpace

    The implicit keyspace definition to use.

    returns

    An alter query with a DROP TABLE instruction encoded in the query string.

  12. final def drop[RR](columnSelect: (Table) ⇒ DropColumn[RR]): AlterQuery[Table, Record, Status, Chain]

    Permalink

    Creates an ALTER drop query to drop the column from the schema definition.

    Creates an ALTER drop query to drop the column from the schema definition. It will produce the following type of queries, with the CQL serialization on the right hand side:

    MyTable.alter.drop(_.mycolumn) => ALTER TABLE MyTable DROP myColumn
    RR

    The underlying type of the AbstractColumn.

    columnSelect

    A column selector higher order function derived from a table.

    returns

    A new alter query with the underlying builder containing a DROP clause.

  13. final def dropIfExists()(implicit keySpace: KeySpace): AlterQuery[Table, Record, Status, Chain]

    Permalink
  14. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def future(modifyStatement: Modifier)(implicit session: Session, executor: ExecutionContextExecutor): Future[ResultSet]

    Permalink

    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
  18. def future()(implicit session: Session, ec: ExecutionContextExecutor): Future[ResultSet]

    Permalink

    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
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def option(clause: TablePropertyClause)(implicit ev: =:=[Chain, WithUnchainned]): AlterQuery[Table, Record, Status, WithChainned]

    Permalink
  26. val options: QueryOptions

    Permalink
    Definition Classes
    AlterQueryExecutableStatement
  27. val qb: CQLQuery

    Permalink
    Definition Classes
    AlterQueryExecutableStatement
  28. def queryString: String

    Permalink
    Definition Classes
    ExecutableStatement
  29. final def rename[RR](select: (Table) ⇒ AbstractColumn[RR], newName: String): AlterQuery[Table, Record, Status, Chain]

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

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

    Permalink
    Attributes
    protected[this]
    Definition Classes
    CassandraOperations
  32. def statement()(implicit session: Session): Statement

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

    Permalink
    Definition Classes
    AnyRef
  34. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  35. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. final def with(clause: TablePropertyClause)(implicit ev: =:=[Chain, WithUnchainned]): AlterQuery[Table, Record, Status, WithChainned]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use option instead

Inherited from ExecutableStatement

Inherited from CassandraOperations

Inherited from SessionAugmenterImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped