Class: Cequel::Schema::Keyspace Deprecated
- Inherits:
-
Object
- Object
- Cequel::Schema::Keyspace
- Defined in:
- lib/cequel/schema/keyspace.rb
Overview
These methods will be exposed directly on Metal::Keyspace in a future version of Cequel
Provides read/write access to the schema for a keyspace and the tables it contains
Instance Method Summary collapse
-
#alter_table(name) { ... } ⇒ void
Make changes to an existing table in the keyspace.
-
#create!(options = {}) ⇒ void
Create this keyspace in the database.
-
#create_table(name) { ... } ⇒ void
Create a table in the keyspace.
-
#drop! ⇒ void
Drop this keyspace from the database.
-
#drop_table(name) ⇒ void
Drop this table from the keyspace.
-
#initialize(keyspace) ⇒ Keyspace
constructor
private
A new instance of Keyspace.
-
#read_table(name) ⇒ Table
Object representation of the table schema as it currently exists in the database.
-
#sync_table(name) { ... } ⇒ void
(also: #synchronize_table)
Create or update a table to match a given schema structure.
-
#truncate_table(name) ⇒ void
Remove all data from this table.
Constructor Details
#initialize(keyspace) ⇒ Keyspace
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of Keyspace.
18 19 20 |
# File 'lib/cequel/schema/keyspace.rb', line 18 def initialize(keyspace) @keyspace = keyspace end |
Instance Method Details
#alter_table(name) { ... } ⇒ void
This method returns an undefined value.
Make changes to an existing table in the keyspace
119 120 121 122 123 |
# File 'lib/cequel/schema/keyspace.rb', line 119 def alter_table(name, &block) updater = TableUpdater.apply(keyspace, name) do |updater| UpdateTableDSL.apply(updater, &block) end end |
#create!(options = {}) ⇒ void
This method returns an undefined value.
Create this keyspace in the database
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/cequel/schema/keyspace.rb', line 36 def create!( = {}) = Metal::Keyspace.new(keyspace.configuration.except(:keyspace)) = .symbolize_keys [:class] ||= 'SimpleStrategy' if [:class] == 'SimpleStrategy' [:replication_factor] ||= 1 end = .map do |name, value| "'#{name}': #{Cequel::Type.quote(value)}" end .execute(<<-CQL) CREATE KEYSPACE #{keyspace.name} WITH REPLICATION = {#{.join(', ')}} CQL end |
#create_table(name) { ... } ⇒ void
This method returns an undefined value.
Create a table in the keyspace
97 98 99 100 101 |
# File 'lib/cequel/schema/keyspace.rb', line 97 def create_table(name, &block) table = Table.new(name) CreateTableDSL.apply(table, &block) TableWriter.apply(keyspace, table) end |
#drop! ⇒ void
This method returns an undefined value.
Drop this keyspace from the database
63 64 65 |
# File 'lib/cequel/schema/keyspace.rb', line 63 def drop! keyspace.execute("DROP KEYSPACE #{keyspace.name}") end |
#drop_table(name) ⇒ void
This method returns an undefined value.
Drop this table from the keyspace
144 145 146 |
# File 'lib/cequel/schema/keyspace.rb', line 144 def drop_table(name) keyspace.execute("DROP TABLE #{name}") end |
#read_table(name) ⇒ Table
Returns object representation of the table schema as it currently exists in the database.
72 73 74 |
# File 'lib/cequel/schema/keyspace.rb', line 72 def read_table(name) TableReader.read(keyspace, name) end |
#sync_table(name) { ... } ⇒ void Also known as: synchronize_table
This method returns an undefined value.
Create or update a table to match a given schema structure. The desired schema structure is defined by the directives given in the block; this is then compared to the existing table in the database (if it is defined at all), and then the table is created or altered accordingly.
161 162 163 164 165 166 |
# File 'lib/cequel/schema/keyspace.rb', line 161 def sync_table(name, &block) existing = read_table(name) updated = Table.new(name) CreateTableDSL.apply(updated, &block) TableSynchronizer.apply(keyspace, existing, updated) end |
#truncate_table(name) ⇒ void
This method returns an undefined value.
Remove all data from this table. Truncating a table can be much slower than simply iterating over its keys and issuing ‘DELETE` statements, particularly if the table does not have many rows. Truncating is equivalent to dropping a table and then recreating it
134 135 136 |
# File 'lib/cequel/schema/keyspace.rb', line 134 def truncate_table(name) keyspace.execute("TRUNCATE #{name}") end |