Module: Cequel::Record::Schema::ClassMethods

Extended by:

Util::Forwardable

Defined in:

lib/cequel/record/schema.rb

Overview

Methods available on Cequel::Record class singletons to introspect and modify the schema defined in the database

Since:

• 1.0.0

Instance Attribute Summary

• #clustering_columns ⇒ Array<ClusteringColumn> readonly

  Clustering columns defined on the table.

• #column_names ⇒ Array<Symbol> readonly

  The names of all columns.

• #columns ⇒ Array<Column> readonly

  All columns defined on the table.

• #key_column_names ⇒ Array<Symbol> readonly

  Names of all key columns (partition + clustering).

• #key_columns ⇒ Array<Column> readonly

  All key columns (partition + clustering).

• #partition_key_column_names ⇒ Array<Symbol> readonly

  Names of partition key columns.

• #partition_key_columns ⇒ Array<PartitionKey> readonly

  Partition key columns defined on the table.

Instance Method Summary

• #compact_storage? ⇒ Boolean

  ‘true` if this table uses compact storage.

• #read_schema ⇒ Schema::Table

  Read the current state of this record’s table in Cassandra from the database.

• #reflect_on_column(name) ⇒ Column

  Column defined on table with given name.

• #synchronize_schema ⇒ void

  Read the current schema assigned to this record’s table from Cassandra, and make any necessary modifications (including creating the table for the first time) so that it matches the schema defined in the record definition.

• #table_schema ⇒ Schema::Table

  The schema as defined by the columns specified in the class definition.

Methods included from Util::Forwardable

delegate

Instance Attribute Details

#clustering_columns ⇒ Array<ClusteringColumn> (readonly)

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

#column_names ⇒ Array<Symbol> (readonly)

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

#columns ⇒ Array<Column> (readonly)

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

#key_column_names ⇒ Array<Symbol> (readonly)

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

#key_columns ⇒ Array<Column> (readonly)

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

#partition_key_column_names ⇒ Array<Symbol> (readonly)

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

#partition_key_columns ⇒ Array<PartitionKey> (readonly)

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

Instance Method Details

#compact_storage? ⇒ Boolean

# File 'lib/cequel/record/schema.rb', line 63

def_delegators :table_schema, :columns, :column_names, :key_columns,
:key_column_names, :partition_key_columns,
:partition_key_column_names, :clustering_columns,
:compact_storage?

#read_schema ⇒ Schema::Table

Read the current state of this record’s table in Cassandra from the database.

Since:

• 1.0.0

# File 'lib/cequel/record/schema.rb', line 94

def read_schema
  fail MissingTableNameError unless table_name

  connection.schema.read_table(table_name)
end

#reflect_on_column(name) ⇒ Column

# File 'lib/cequel/record/schema.rb', line 71

def_delegator :table_schema, :column, :reflect_on_column

#synchronize_schema ⇒ void

This method returns an undefined value.

Read the current schema assigned to this record’s table from Cassandra, and make any necessary modifications (including creating the table for the first time) so that it matches the schema defined in the record definition

Since:

• 1.0.0

# File 'lib/cequel/record/schema.rb', line 82

def synchronize_schema
  Cequel::Schema::TableSynchronizer
    .apply(connection, read_schema, table_schema)
end

#table_schema ⇒ Schema::Table

Returns the schema as defined by the columns specified in the class definition.

Since:

• 1.0.0

# File 'lib/cequel/record/schema.rb', line 104

def table_schema
  @table_schema ||= Cequel::Schema::Table.new(table_name)
end