Class: Cequel::Metal::Keyspace

Inherits:
Object
  • Object
show all
Extended by:
Util::Forwardable
Includes:
Logging, MonitorMixin
Defined in:
lib/cequel/metal/keyspace.rb

Overview

Handle to a Cassandra keyspace (database). Keyspace objects are factories for DataSet instances and provide a handle to a Schema::Keyspace instance.

Since:

  • 1.0.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::Forwardable

delegate

Methods included from Logging

#slowlog=

Constructor Details

#initialize(configuration = {}) ⇒ 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.

Parameters:

  • configuration (Options) (defaults to: {})

Options Hash (configuration):

  • :host (String) — default: '127.0.0.1'

    hostname of single Cassandra instance to connect to

  • :port (Integer) — default: 9042

    port on which to connect to all specified hosts

  • :max_retries (Integer)

    maximum number of retries on connection failure

  • :hosts (Array<String>)

    list of Cassandra instances to connect to (hostnames only)

  • :username (String)

    user to auth with (leave blank for no auth)

  • :password (String)

    password to auth with (leave blank for no auth)

  • :keyspace (String)

    name of keyspace to connect to

  • :ssl (Boolean)

    enable/disable ssl/tls support

  • :server_cert (String)

    path to ssl server certificate

  • :client_cert (String)

    path to ssl client certificate

  • :private_key (String)

    path to ssl client private key

See Also:

Since:

  • 1.0.0


94
95
96
97
# File 'lib/cequel/metal/keyspace.rb', line 94

def initialize(configuration={})
  configure(configuration)
  @lock = Monitor.new
end

Instance Attribute Details

#configurationHash (readonly)

Returns configuration options for this keyspace.

Returns:

  • (Hash)

    configuration options for this keyspace

Since:

  • 1.0.0


17
18
19
# File 'lib/cequel/metal/keyspace.rb', line 17

def configuration
  @configuration
end

#credentialsHash (readonly)

Returns credentials for connect to cassandra.

Returns:

  • (Hash)

    credentials for connect to cassandra

Since:

  • 1.0.0


32
33
34
# File 'lib/cequel/metal/keyspace.rb', line 32

def credentials
  @credentials
end

#default_consistencySymbol

Returns the default consistency for queries in this keyspace.

Returns:

  • (Symbol)

    the default consistency for queries in this keyspace

Since:

  • 1.1.0


240
241
242
# File 'lib/cequel/metal/keyspace.rb', line 240

def default_consistency
  @default_consistency || :quorum
end

#hostsArray<String> (readonly)

Returns list of hosts to connect to.

Returns:

  • (Array<String>)

    list of hosts to connect to

Since:

  • 1.0.0


21
22
23
# File 'lib/cequel/metal/keyspace.rb', line 21

def hosts
  @hosts
end

#max_retriesObject (readonly)

Returns Integer maximum number of retries to reconnect to Cassandra.

Returns:

  • Integer maximum number of retries to reconnect to Cassandra

Since:

  • 1.0.0


25
26
27
# File 'lib/cequel/metal/keyspace.rb', line 25

def max_retries
  @max_retries
end

#nameString (readonly)

Returns name of the keyspace.

Returns:

  • (String)

    name of the keyspace

Since:

  • 1.0.0


19
20
21
# File 'lib/cequel/metal/keyspace.rb', line 19

def name
  @name
end

#portObject (readonly)

Returns Integer port to connect to Cassandra nodes on.

Returns:

  • Integer port to connect to Cassandra nodes on

Since:

  • 1.0.0


23
24
25
# File 'lib/cequel/metal/keyspace.rb', line 23

def port
  @port
end

#retry_delayObject (readonly)

Returns Float delay between retries to reconnect to Cassandra.

Returns:

  • Float delay between retries to reconnect to Cassandra

Since:

  • 1.0.0


27
28
29
# File 'lib/cequel/metal/keyspace.rb', line 27

def retry_delay
  @retry_delay
end

#ssl_configHash (readonly)

Returns SSL Configuration options.

Returns:

  • (Hash)

    SSL Configuration options

Since:

  • 1.0.0


34
35
36
# File 'lib/cequel/metal/keyspace.rb', line 34

def ssl_config
  @ssl_config
end

Class Method Details

.sanitize(statement, bind_vars) ⇒ String

Combine a statement with bind vars into a fully-fledged CQL query. This will no longer be needed once the CQL driver supports bound values natively.

Parameters:

  • statement (String)

    CQL statement with ? placeholders for bind vars

  • bind_vars (Array)

    bind variables corresponding to ? in the statement

Returns:

  • (String)

    CQL statement with quoted values in place of bind variables

Since:

  • 1.0.0


77
78
79
80
# File 'lib/cequel/metal/keyspace.rb', line 77

def self.sanitize(statement, bind_vars)
  each_bind_var = bind_vars.each
  statement.gsub('?') { Type.quote(each_bind_var.next) }
end

Instance Method Details

#[](table_name) ⇒ DataSet

Returns data set encapsulating table.

Parameters:

  • table_name (Symbol)

    the name of the table

Returns:

  • (DataSet)

    data set encapsulating table

Since:

  • 1.0.0


158
159
160
# File 'lib/cequel/metal/keyspace.rb', line 158

def [](table_name)
  DataSet.new(table_name.to_sym, self)
end

#batch { ... } ⇒ Object

Note:

If this method is created while already in a batch of the same type (logged or unlogged), this method is a no-op.

Execute write operations in a batch. Any inserts, updates, and deletes inside this method's block will be executed inside a CQL BATCH operation.

Examples:

Perform inserts in a batch

DB.batch do
  DB[:posts].insert(:id => 1, :title => 'One')
  DB[:posts].insert(:id => 2, :title => 'Two')
end

Parameters:

  • options (Hash)

Yields:

  • context within which all write operations will be batched

Returns:

  • return value of block

Raises:

  • (ArgumentError)

    if attempting to start a logged batch while already in an unlogged batch, or vice versa.


63
# File 'lib/cequel/metal/keyspace.rb', line 63

def_delegator :batch_manager, :batch

#clear_active_connections!void

This method returns an undefined value.

Clears all active connections

Since:

  • 1.0.0


223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/cequel/metal/keyspace.rb', line 223

def clear_active_connections!
  if defined? @client
    remove_instance_variable(:@client)
  end
  if defined? @client_without_keyspace
    remove_instance_variable(:@client_without_keyspace)
  end
  if defined? @cluster
    @cluster.close
    remove_instance_variable(:@cluster)
  end
end

#clientCql::Client::Client

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 the low-level client provided by the adapter.

Returns:

  • (Cql::Client::Client)

    the low-level client provided by the adapter

Since:

  • 1.0.0


167
168
169
170
171
# File 'lib/cequel/metal/keyspace.rb', line 167

def client
  synchronize do
    @client ||= cluster.connect(name)
  end
end

#configure(configuration = {}) ⇒ void

This method returns an undefined value.

Configure this keyspace from a hash of options

Parameters:

  • configuration (Options) (defaults to: {})

    configuration options

  • configuartion (Hash)

    a customizable set of options

Options Hash (configuration):

  • :host (String) — default: '127.0.0.1'

    hostname of single Cassandra instance to connect to

  • :port (Integer) — default: 9042

    port on which to connect to all specified hosts

  • :max_retries (Integer)

    maximum number of retries on connection failure

  • :hosts (Array<String>)

    list of Cassandra instances to connect to (hostnames only)

  • :username (String)

    user to auth with (leave blank for no auth)

  • :password (String)

    password to auth with (leave blank for no auth)

  • :keyspace (String)

    name of keyspace to connect to

  • :ssl (Boolean)

    enable/disable ssl/tls support

  • :server_cert (String)

    path to ssl server certificate

  • :client_cert (String)

    path to ssl client certificate

  • :private_key (String)

    path to ssl client private key

Since:

  • 1.0.0


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/cequel/metal/keyspace.rb', line 127

def configure(configuration = {})
  if configuration.key?(:thrift)
    warn "Cequel no longer uses the Thrift transport to communicate " \
         "with Cassandra. The :thrift option is deprecated and ignored."
  end
  @configuration = configuration

  @hosts, @port = extract_hosts_and_port(configuration)
  @credentials  = extract_credentials(configuration)
  @max_retries  = extract_max_retries(configuration)
  @retry_delay  = extract_retry_delay(configuration)
  @ssl_config = extract_ssl_config(configuration)

  @name = configuration[:keyspace]
  @default_consistency = configuration[:default_consistency].try(:to_sym)

  # reset the connections
  clear_active_connections!
end

#execute(statement, *bind_vars) ⇒ Enumerable

Execute a CQL query in this keyspace

If a connection error occurs, will retry a maximum number of
time (default 3) before re-raising the original connection
error.

Parameters:

  • statement (String)

    CQL string

  • bind_vars (Object)

    values for bind variables

Returns:

  • (Enumerable)

    the results of the query

See Also:

Since:

  • 1.0.0


186
187
188
# File 'lib/cequel/metal/keyspace.rb', line 186

def execute(statement, *bind_vars)
  execute_with_consistency(statement, bind_vars, default_consistency)
end

#execute_with_consistency(statement, bind_vars, consistency) ⇒ Enumerable

Execute a CQL query in this keyspace with the given consistency

Parameters:

  • statement (String)

    CQL string

  • bind_vars (Array)

    array of values for bind variables

  • consistency (Symbol)

    consistency at which to execute query

Returns:

  • (Enumerable)

    the results of the query

Since:

  • 1.1.0


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/cequel/metal/keyspace.rb', line 200

def execute_with_consistency(statement, bind_vars, consistency)
  retries = max_retries

  log('CQL', statement, *bind_vars) do
    begin
      client.execute(sanitize(statement, bind_vars),
                     consistency: consistency || default_consistency)
    rescue Cassandra::Errors::NoHostsAvailable,
           Ione::Io::ConnectionError => e
      clear_active_connections!
      raise if retries == 0
      retries -= 1
      sleep(retry_delay)
      retry
    end
  end
end

#exists?Boolean

Returns true if the keyspace exists.

Returns:

  • (Boolean)

    true if the keyspace exists

Since:

  • 1.0.0


245
246
247
248
249
250
251
252
253
254
255
# File 'lib/cequel/metal/keyspace.rb', line 245

def exists?
  statement = <<-CQL
    SELECT keyspace_name
    FROM system.schema_keyspaces
    WHERE keyspace_name = ?
  CQL

  log('CQL', statement, [name]) do
    client_without_keyspace.execute(sanitize(statement, [name])).any?
  end
end

#sanitizeString

Combine a statement with bind vars into a fully-fledged CQL query. This will no longer be needed once the CQL driver supports bound values natively.

Parameters:

  • statement (String)

    CQL statement with ? placeholders for bind vars

  • bind_vars (Array)

    bind variables corresponding to ? in the statement

Returns:

  • (String)

    CQL statement with quoted values in place of bind variables


86
# File 'lib/cequel/metal/keyspace.rb', line 86

def_delegator 'self.class', :sanitize

#schemaSchema::Keyspace

Returns schema object providing full read/write access to database schema.

Returns:

  • (Schema::Keyspace)

    schema object providing full read/write access to database schema

Since:

  • 1.0.0


150
151
152
# File 'lib/cequel/metal/keyspace.rb', line 150

def schema
  Schema::Keyspace.new(self)
end

#write(statement, *bind_vars) ⇒ void

This method returns an undefined value.

Write data to this keyspace using a CQL query. Will be included the current batch operation if one is present.


45
# File 'lib/cequel/metal/keyspace.rb', line 45

def_delegator :write_target, :execute, :write

#write_with_consistency(statement, bind_vars, consistency) ⇒ void

This method returns an undefined value.

Write data to this keyspace using a CQL query at the given consistency. Will be included the current batch operation if one is present.


56
57
# File 'lib/cequel/metal/keyspace.rb', line 56

def_delegator :write_target, :execute_with_consistency,
:write_with_consistency