Class: CassandraObject::Adapters::CassandraDriver::Client

Inherits:
ActiveRecord::ConnectionAdapters::AbstractAdapter
  • Object
show all
Defined in:
lib/cassandra_object/adapters/cassandra_driver.rb

Overview

The client class acts like the old cassandra gem

Constant Summary collapse

KEY_FIELD = 
'key'
NAME_FIELD = 
'column1'
VALUE_FIELD = 
'value'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session, cluster) ⇒ Client

Returns a new instance of Client.



75
76
77
78
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 75

def initialize(session, cluster)
  @session = session
  @cluster = cluster
end

Instance Attribute Details

#cluster ⇒ Object (readonly)

Returns the value of attribute cluster.



69
70
71
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 69

def cluster
  @cluster
end

#session ⇒ Object (readonly)

Returns the value of attribute session.



69
70
71
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 69

def session
  @session
end

Instance Method Details

#add(column_family, key, by, fields, opts = nil) ⇒ Object 



169
170
171
172
173
174
175
176
177
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 169

def add(column_family, key, by, fields, opts=nil)
  async = opts.try(:[], :async)
  fields = [fields] unless fields.is_a?(Array)

  fields.each do |field|
    query = "UPDATE \"#{column_family}\" SET #{VALUE_FIELD} = #{VALUE_FIELD} + #{by} WHERE #{KEY_FIELD} = #{escape(key, key_type(column_family))} AND #{NAME_FIELD} = #{escape(field, name_type(column_family))};"
    async ? self.execute_async(query, execute_options(opts)) : self.execute(query, execute_options(opts))
  end
end

#add_column_family(column_family) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 275

def add_column_family(column_family)
  value_type = column_family.default_validation_class == 'CounterColumnType' ? 'counter' : 'text'

  query = <<-CQL
CREATE TABLE "#{column_family.name}" (
  key blob,
  column1 text,
  value #{value_type},
  PRIMARY KEY (key, column1)
) WITH COMPACT STORAGE
  AND CLUSTERING ORDER BY (column1 ASC)
  AND bloom_filter_fp_chance = 0.1
  AND caching = '{"keys":"ALL", "rows_per_partition":"NONE"}'
  AND comment = ''
  AND compaction = {'sstable_size_in_mb': '160', 'class': 'org.apache.cassandra.db.compaction.LeveledCompactionStrategy'}
  AND compression = {'sstable_compression': 'org.apache.cassandra.io.compress.SnappyCompressor'}
  AND dclocal_read_repair_chance = 0.1
  AND default_time_to_live = 0
  AND gc_grace_seconds = 864000
  AND max_index_interval = 2048
  AND memtable_flush_period_in_ms = 0
  AND min_index_interval = 128
  AND read_repair_chance = 0.0
  AND speculative_retry = 'NONE';
CQL

  self.execute(query)

  self.column_families[column_family.name.to_s] = column_family
end

#add_multiple_columns(column_family, key, hash, opts = nil) ⇒ Object 



179
180
181
182
183
184
185
186
187
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 179

def add_multiple_columns(column_family, key, hash, opts=nil)
  async = opts.try(:[], :async)
  fields = [fields] unless fields.is_a?(Array)

  hash.each do |field, by|
    query = "UPDATE \"#{column_family}\" SET #{VALUE_FIELD} = #{VALUE_FIELD} + #{by} WHERE #{KEY_FIELD} = #{escape(key, key_type(column_family))} AND #{NAME_FIELD} = #{escape(field, name_type(column_family))};"
    async ? self.execute_async(query, execute_options(opts)) : self.execute(query, execute_options(opts))
  end
end

#batch ⇒ Object 



264
265
266
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 264

def batch
  yield
end

#close ⇒ Object 



80
81
82
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 80

def close
  session.close
end

#column_families ⇒ Object 



260
261
262
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 260

def column_families
  @column_families ||= self.cluster.keyspace(session.keyspace).tables.inject({}) { |hsh, table| hsh[table.name] = table; hsh }
end

#convert_str_to_hex(str) ⇒ Object

insert a blob



348
349
350
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 348

def convert_str_to_hex(str)
  '0x' << str.unpack('H*').first
end

#convert_str_to_timeuuid(str) ⇒ Object

when the column names are timeuuid



343
344
345
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 343

def convert_str_to_timeuuid(str)
  SimpleUUID::UUID.new(str).to_guid
end

#decode(val, type) ⇒ Object 



333
334
335
336
337
338
339
340
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 333

def decode(val, type)
  case type
  when :timeuuid
    SimpleUUID::UUID.new(val.to_s).to_s # binary version
  else
    val
  end
end

#escape(str, type) ⇒ Object 



322
323
324
325
326
327
328
329
330
331
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 322

def escape(str, type)
  case type
  when :timeuuid
    convert_str_to_timeuuid str
  when :blob
    convert_str_to_hex str
  else
    "'#{str}'"
  end
end

#execute(query, options = {}) ⇒ Object 



84
85
86
87
88
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 84

def execute(query, options={})
  ActiveSupport::Notifications.instrument('query.cassandra', query: query, options: options, async: false) do
    session.execute query, options
  end
end

#execute_async(query, options = {}) ⇒ Object 



90
91
92
93
94
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 90

def execute_async(query, options={})
  ActiveSupport::Notifications.instrument('query.cassandra', query: query, options: options, async: true) do
    session.execute_async query, options
  end
end

#execute_options(opts) ⇒ Object 



238
239
240
241
242
243
244
245
246
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 238

def execute_options(opts)
  opts.try(:slice,
           :consistency,
           :page_size,
           :trace,
           :timeout,
           :serial_consistency
          ) || {}
end

#get(column_family, key, *columns_options) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 111

def get(column_family, key, *columns_options)
  opts = columns_options.pop if columns_options.last.is_a?(Hash)
  async = opts.try(:[], :async)

  columns = columns_options.flatten.compact

  query =
    if columns.size == 1
      "SELECT #{VALUE_FIELD} FROM \"#{column_family}\" WHERE #{KEY_FIELD} = #{escape(key, key_type(column_family))} AND #{NAME_FIELD} = #{escape(columns.first, name_type(column_family))}"
    else
      "SELECT #{NAME_FIELD}, #{VALUE_FIELD} FROM \"#{column_family}\" WHERE #{KEY_FIELD} = #{escape(key, key_type(column_family))}"
    end

  result = async ? self.execute_async(query, execute_options(opts)) : self.execute(query, execute_options(opts))
  return result if async

  if columns.size == 1
    result.size > 0 ? result.first[VALUE_FIELD] : nil
  else
    data = result.inject({}) { |hsh, row| hsh[row[NAME_FIELD]] = row[VALUE_FIELD]; hsh }
    columns.size > 0 ? data.slice(*columns.map(&:to_s)) : data
  end
end

#get_columns(column_family, key, columns, opts) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 135

def get_columns(column_family, key, columns, opts)
  async = opts.try(:[], :async)

  name_fields = columns.map { |c| escape(c, name_type(column_family)) }.join(', ')

  query = "SELECT #{NAME_FIELD}, #{VALUE_FIELD} FROM \"#{column_family}\" WHERE #{NAME_FIELD} IN(#{name_fields}) AND #{KEY_FIELD} = #{escape(key, key_type(column_family))}"

  result = async ? self.execute_async(query, execute_options(opts)) : self.execute(query, execute_options(opts))
  return result if async

  data = result
         .inject({}) { |hsh, row| hsh[row[NAME_FIELD]] = row[VALUE_FIELD]; hsh }

  columns.map { |column| data[column.to_s] }
end

#get_columns_as_hash(column_family, key, columns, opts) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 151

def get_columns_as_hash(column_family, key, columns, opts)
  async = opts.try(:[], :async)

  name_fields = columns.map { |c| "'#{c}'" }.join(', ')

  query = "SELECT #{NAME_FIELD}, #{VALUE_FIELD} FROM \"#{column_family}\" WHERE #{NAME_FIELD} IN(#{name_fields}) AND #{KEY_FIELD} = #{escape(key, key_type(column_family))}"

  result = async ? self.execute_async(query, execute_options(opts)) : self.execute(query, execute_options(opts))
  return result if async

  result
    .inject({}) { |hsh, row| hsh[row[NAME_FIELD]] = row[VALUE_FIELD]; hsh }
end

#get_range(column_family, opts = {}, &blk) ⇒ Object 



203
204
205
206
207
208
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 203

def get_range(column_family, opts={}, &blk)
  key_count = opts[:key_count] || 100
  query = "SELECT #{KEY_FIELD} FROM \"#{column_family}\" LIMIT #{key_count}"
  keys = self.execute(query, execute_options(opts)).map { |result| result[KEY_FIELD] }
  keys.size > 0 ? multi_get(column_family, keys) : {}
end

#get_slice(column_family, key, column, start, finish, count, reversed, consistency, opts = {}) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 222

def get_slice(column_family, key, column, start, finish, count, reversed, consistency, opts={})
  opts[:consistency] = consistency

  query = "SELECT * FROM \"#{column_family}\" WHERE #{KEY_FIELD} = #{escape(key, key_type(column_family))}"
  query << " AND #{NAME_FIELD} = #{escape(column, name_type(column_family))}" if column
  query << " AND #{NAME_FIELD} >= #{escape(start, name_type(column_family))}" unless start.empty?
  query << " AND #{NAME_FIELD} <= #{escape(finish, name_type(column_family))}" unless finish.empty?
  query << " ORDER BY #{NAME_FIELD} #{reverse_comparator(column_family) ? 'ASC' : 'DESC'}" if reversed
  query << " LIMIT #{count}"

  self.execute(query, execute_options(opts)).inject({}) do |results, row|
    results[decode(row[NAME_FIELD], name_type(column_family))] = decode(row[VALUE_FIELD], value_type(column_family))
    results
  end
end

#get_value(column_family, key, column, consistency) ⇒ Object 



165
166
167
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 165

def get_value(column_family, key, column, consistency)
  get column_family, key, [column], :consistency => consistency
end

#has_table?(name) ⇒ Boolean

Returns:

  • (Boolean) 


252
253
254
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 252

def has_table?(name)
  self.cluster.keyspace(session.keyspace).has_table? name
end

#insert(column_family, key, values, opts = nil) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 96

def insert(column_family, key, values, opts=nil)
  ttl = opts.try(:[], :ttl)
  async = opts.try(:[], :async)

  insert_into_options = ttl ? " USING TTL #{ttl}" : ''

  query = "BEGIN BATCH\n"
  query << values.map do |name, value|
    "  INSERT INTO \"#{column_family}\" (#{KEY_FIELD}, #{NAME_FIELD}, #{VALUE_FIELD}) VALUES (#{escape(key, key_type(column_family))}, #{escape(name, name_type(column_family))}, #{escape(value, value_type(column_family))})#{insert_into_options}"
  end.join("\n")
  query << "\nAPPLY BATCH;"

  async ? self.execute_async(query, execute_options(opts)) : self.execute(query, execute_options(opts))
end

#key_type(column_family) ⇒ Object 



306
307
308
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 306

def key_type(column_family)
  self.cluster.keyspace(keyspace).table(column_family).column(KEY_FIELD).type.kind
end

#keyspace ⇒ Object 



248
249
250
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 248

def keyspace
  session.keyspace
end

#multi_get(column_family, keys, *args) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 210

def multi_get(column_family, keys, *args)
  opts = args.pop if args.last.is_a?(Hash)
  keys = keys.map { |key| escape(key, key_type(column_family)) }.join(',')
  results = {}
  query = "SELECT * FROM \"#{column_family}\" WHERE #{KEY_FIELD} IN(#{keys})"
  self.execute(query, execute_options(opts)).each do |row|
    results[row[KEY_FIELD]] ||= {}
    results[row[KEY_FIELD]][row[NAME_FIELD]] = row[VALUE_FIELD]
  end
  results
end

#name_type(column_family) ⇒ Object 



310
311
312
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 310

def name_type(column_family)
  self.cluster.keyspace(keyspace).table(column_family).column(NAME_FIELD).type.kind
end

#remove(column_family, key, *args) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 189

def remove(column_family, key, *args)
  opts = args.pop if args.last.is_a?(Hash)
  async = opts.try(:[], :async)

  query =
    if args.first.nil? || args.first.is_a?(Hash)
      "DELETE FROM \"#{column_family}\" WHERE #{KEY_FIELD} = #{escape(key, key_type(column_family))};"
    else
      "DELETE \"#{column_family}\" WHERE #{KEY_FIELD} = #{escape(key, key_type(column_family))} AND #{NAME_FIELD} = #{escape(args.first, name_type(column_family))};"
    end

  async ? self.execute_async(query, execute_options(opts)) : self.execute(query, execute_options(opts))
end

#reverse_comparator(column_family) ⇒ Object 



318
319
320
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 318

def reverse_comparator(column_family)
  self.cluster.keyspace(keyspace).table(column_family).send(:clustering_order).first == :desc
end

#schema(reload = false) ⇒ Object 



268
269
270
271
272
273
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 268

def schema(reload=false)
  if reload
    remove_instance_variable(:@schema_cache) if instance_variable_defined?(:@schema_cache)
    remove_instance_variable(:@column_families) if instance_variable_defined?(:@column_families)
  end
end

#schema_cache ⇒ Object 



256
257
258
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 256

def schema_cache
  @schema_cache ||= SchemaCache.new(self)
end

#value_type(column_family) ⇒ Object 



314
315
316
 
# File 'lib/cassandra_object/adapters/cassandra_driver.rb', line 314

def value_type(column_family)
  self.cluster.keyspace(keyspace).table(column_family).column(VALUE_FIELD).type.kind
end