Brand

Ruby Driver for Apache Cassandra

Attention: Viewing documentation for version
(Earlier version)
Download

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

to_cql

Returns a cql representation of this table

Returns:
Type Details
String a cql representation of this table