class Cassandra::Table

Represents a cassandra table

See Also:

Inherits

ColumnContainer

Methods

clustering_order

Returns an array of order values (:asc or :desc) that apply to the clustering_columns array.

Returns:
Type Details
Array<Symbol> an array of order values (:asc or :desc) that apply to the clustering_columns array.

has_index?

(name)

Returns whether this table has a given index

Parameters:
Name Type Details
name String index name
Returns:
Type Details
Boolean whether this table has a given index

index

(name)

Returns an index or nil

Parameters:
Name Type Details
name String index name
Returns:
Type Details
(Index or nil) an index or nil

each_index

(&block) aliased as: indexes

Yield or enumerate each index bound to this table

Overloads:
each_index {|index| … }

Returns self

Yield Parameters:
Name Type Details
index Index current index
Returns:
Type Details
Table self
each_index

Returns a list of indexes

Returns:
Type Details
Array<Index> a list of indexes

has_trigger?

(name)

Returns whether this table has a given trigger

Parameters:
Name Type Details
name String trigger name
Returns:
Type Details
Boolean whether this table has a given trigger

trigger

(name)

Returns a trigger or nil

Parameters:
Name Type Details
name String trigger name
Returns:
Type Details
(Trigger or nil) a trigger or nil

each_trigger

(&block) aliased as: triggers

Yield or enumerate each trigger bound to this table

Overloads:
each_trigger {|trigger| … }

Returns self

Yield Parameters:
Name Type Details
trigger Index current trigger
Returns:
Type Details
Table self
each_trigger

Returns a list of triggers

Returns:
Type Details
Array<Trigger> a list of triggers

has_materialized_view?

(name)

Returns whether this table has a given materialized view

Parameters:
Name Type Details
name String materialized view name
Returns:
Type Details
Boolean whether this table has a given materialized view

materialized_view

(name)

Returns a materialized view or nil

Parameters:
Name Type Details
name String materialized view name
Returns:
Type Details
(MaterializedView or nil) a materialized view or nil

each_materialized_view

(&block) aliased as: materialized_views

Yield or enumerate each materialized view bound to this table

Overloads:
each_materialized_view {|materialized_view| … }

Returns self

Yield Parameters:
Name Type Details
materialized_view MaterializedView current materialized view
Returns:
Type Details
Table self
each_materialized_view

Returns a list of materialized views

Returns:
Type Details
Array<MaterializedView> a list of materialized views

to_cql

Returns a cql representation of this table

Returns:
Type Details
String a cql representation of this table