Class: Aerospike::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/aerospike/client.rb

Overview

Examples:

# connect to the database client = Client.new(‘192.168.0.1’)

#=> raises Aerospike::Exceptions::Timeout if a :timeout is specified and :fail_if_not_connected set to true

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hosts = nil, policy: ClientPolicy.new, connect: true) ⇒ Client

Returns a new instance of Client.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/aerospike/client.rb', line 42

def initialize(hosts = nil, policy: ClientPolicy.new, connect: true)
  @default_policy = Policy.new
  @default_write_policy = WritePolicy.new
  @default_scan_policy = ScanPolicy.new
  @default_query_policy = QueryPolicy.new
  @default_admin_policy = QueryPolicy.new

  hosts = parse_hosts(hosts || ENV["AEROSPIKE_HOSTS"] || "localhost")
  policy = create_policy(policy, ClientPolicy)
  @cluster = Cluster.new(policy, *hosts)
  @cluster.add_cluster_config_change_listener(self)

  self.connect if connect
  self
end

Instance Attribute Details

#default_admin_policy ⇒ Object

Returns the value of attribute default_admin_policy.



39
40
41
 
# File 'lib/aerospike/client.rb', line 39

def default_admin_policy
  @default_admin_policy
end

#default_policy ⇒ Object

Returns the value of attribute default_policy.



39
40
41
 
# File 'lib/aerospike/client.rb', line 39

def default_policy
  @default_policy
end

#default_query_policy ⇒ Object

Returns the value of attribute default_query_policy.



39
40
41
 
# File 'lib/aerospike/client.rb', line 39

def default_query_policy
  @default_query_policy
end

#default_scan_policy ⇒ Object

Returns the value of attribute default_scan_policy.



39
40
41
 
# File 'lib/aerospike/client.rb', line 39

def default_scan_policy
  @default_scan_policy
end

#default_write_policy ⇒ Object

Returns the value of attribute default_write_policy.



39
40
41
 
# File 'lib/aerospike/client.rb', line 39

def default_write_policy
  @default_write_policy
end

Instance Method Details

#add(key, bins, options = {}) ⇒ Object

Examples:

client.add key, {'bin', -1}, :timeout => 0.001



178
179
180
181
182
 
# File 'lib/aerospike/client.rb', line 178

def add(key, bins, options={})
  policy = create_policy(options, WritePolicy)
  command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::ADD)
  execute_command(command)
end

#append(key, bins, options = {}) ⇒ Object

Examples:

client.append key, {'bin', 'value to append'}, :timeout => 0.001



136
137
138
139
140
 
# File 'lib/aerospike/client.rb', line 136

def append(key, bins, options={})
  policy = create_policy(options, WritePolicy)
  command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::APPEND)
  execute_command(command)
end

#batch_exists(keys, options = {}) ⇒ Object

Check if multiple record keys exist in one batch call.

The returned array bool is in positional order with the original key array order.
The policy can be used to specify timeouts.



271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/aerospike/client.rb', line 271

def batch_exists(keys, options={})
  policy = create_policy(options, Policy)

  # same array can be used without sychronization;
  # when a key exists, the corresponding index will be marked true
  exists_array = Array.new(keys.length)

  key_map = BatchItem.generate_map(keys)

  batch_execute(keys) do |node, bns|
    BatchCommandExists.new(node, bns, policy, key_map, exists_array)
  end
  exists_array
end

#batch_get(keys, bin_names = [], options = {}) ⇒ Object

Read multiple record headers and bins for specified keys in one batch call.

The returned records are in positional order with the original key array order.
If a key is not found, the positional record will be nil.
The policy can be used to specify timeouts.



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/aerospike/client.rb', line 317

def batch_get(keys, bin_names=[], options={})
  policy = create_policy(options, Policy)

  # wait until all migrations are finished
  # TODO: implement
  # @cluster.WaitUntillMigrationIsFinished(policy.timeout)

  # same array can be used without sychronization;
  # when a key exists, the corresponding index will be set to record
  records = Array.new(keys.length)

  key_map = BatchItem.generate_map(keys)

  batch_execute(keys) do |node, bns|
    BatchCommandGet.new(node, bns, policy, key_map, bin_names.uniq, records, INFO1_READ)
  end
  records
end

#batch_get_header(keys, options = {}) ⇒ Object

Read multiple record header data for specified keys in one batch call.

The returned records are in positional order with the original key array order.
If a key is not found, the positional record will be nil.
The policy can be used to specify timeouts.



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/aerospike/client.rb', line 340

def batch_get_header(keys, options={})
  policy = create_policy(options, Policy)

  # wait until all migrations are finished
  # TODO: Fix this and implement
  # @cluster.WaitUntillMigrationIsFinished(policy.timeout)

  # same array can be used without sychronization;
  # when a key exists, the corresponding index will be set to record
  records = Array.new(keys.length)

  key_map = BatchItem.generate_map(keys)

  batch_execute(keys) do |node, bns|
    BatchCommandGet.new(node, bns, policy, key_map, nil, records, INFO1_READ | INFO1_NOBINDATA)
  end

  records
end

#change_password(user, password, options = {}) ⇒ Object

Change user’s password. Clear-text password will be hashed using bcrypt before sending to server.

Raises:



748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/aerospike/client.rb', line 748

def change_password(user, password, options={})
  raise Aerospike::Exceptions::Aerospike.new(INVALID_USER) unless @cluster.user && @cluster.user != ""
  policy = create_policy(options, AdminPolicy)

  hash = AdminCommand.hash_password(password)
  command = AdminCommand.new

  if user == @cluster.user
    # Change own password.
    command.change_password(@cluster, policy, user, hash)
  else
    # Change other user's password by user admin.
    command.set_password(@cluster, policy, user, hash)
  end

  @cluster.change_password(user, hash)
end

#close ⇒ Object

Closes all client connections to database server nodes.



68
69
70
 
# File 'lib/aerospike/client.rb', line 68

def close
  @cluster.close
end

#connect ⇒ Object

Connect to the cluster.



61
62
63
 
# File 'lib/aerospike/client.rb', line 61

def connect
  @cluster.connect
end

#connected? ⇒ Boolean

Determines if there are active connections to the database server cluster.

Returns +true+ if connections exist.

Returns:

  • (Boolean) 


76
77
78
 
# File 'lib/aerospike/client.rb', line 76

def connected?
  @cluster.connected?
end

#create_index(namespace, set_name, index_name, bin_name, index_type, collection_type = nil, options = {}) ⇒ Object

Create secondary index.

This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
IndexTask instance.

This method is only supported by Aerospike 3 servers.
index_type should be :string, :numeric or :geo2dsphere (requires server version 3.7 or later)
collection_type should be :list, :mapkeys or :mapvalues

Raises:



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/aerospike/client.rb', line 546

def create_index(namespace, set_name, index_name, bin_name, index_type, collection_type=nil, options={})
  if options.nil? && collection_type.is_a?(Hash)
    options, collection_type = collection_type, nil
  end
  policy = create_policy(options, WritePolicy)
  str_cmd = "sindex-create:ns=#{namespace}"
  str_cmd << ";set=#{set_name}" unless set_name.to_s.strip.empty?
  str_cmd << ";indexname=#{index_name};numbins=1"
  str_cmd << ";indextype=#{collection_type.to_s.upcase}" if collection_type
  str_cmd << ";indexdata=#{bin_name},#{index_type.to_s.upcase}"
  str_cmd << ";priority=normal"

  # Send index command to one node. That node will distribute the command to other nodes.
  response = send_info_command(policy, str_cmd).upcase
  if response == 'OK'
    # Return task that could optionally be polled for completion.
    return IndexTask.new(@cluster, namespace, index_name)
  end

  if response.start_with?('FAIL:200')
    # Index has already been created.  Do not need to poll for completion.
    return IndexTask.new(@cluster, namespace, index_name, true)
  end

  raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::INDEX_GENERIC, "Create index failed: #{response}")
end

#create_user(user, password, roles, options = {}) ⇒ Object

Create user with password and roles. Clear-text password will be hashed using bcrypt before sending to server.



733
734
735
736
737
738
 
# File 'lib/aerospike/client.rb', line 733

def create_user(user, password, roles, options={})
  policy = create_policy(options, AdminPolicy)
  hash = AdminCommand.hash_password(password)
  command = AdminCommand.new
  command.create_user(@cluster, policy, user, hash, roles)
end

#delete(key, options = {}) ⇒ Object

Examples:

existed = client.delete key, :timeout => 0.001



200
201
202
203
204
205
 
# File 'lib/aerospike/client.rb', line 200

def delete(key, options={})
  policy = create_policy(options, WritePolicy)
  command = DeleteCommand.new(@cluster, policy, key)
  execute_command(command)
  command.existed
end

#drop_index(namespace, set_name, index_name, options = {}) ⇒ Object

Delete secondary index.

This method is only supported by Aerospike 3 servers.

Raises:



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/aerospike/client.rb', line 575

def drop_index(namespace, set_name, index_name, options={})
  policy = create_policy(options, WritePolicy)
  str_cmd = "sindex-delete:ns=#{namespace}"
  str_cmd << ";set=#{set_name}" unless set_name.to_s.strip.empty?
  str_cmd << ";indexname=#{index_name}"

  # Send index command to one node. That node will distribute the command to other nodes.
  response = send_info_command(policy, str_cmd).upcase
  return if response == 'OK'

  # Index did not previously exist. Return without error.
  return if response.start_with?('FAIL:201')

  raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::INDEX_GENERIC, "Drop index failed: #{response}")
end

#drop_user(user, options = {}) ⇒ Object

Remove user from cluster.



741
742
743
744
745
 
# File 'lib/aerospike/client.rb', line 741

def drop_user(user, options={})
  policy = create_policy(options, AdminPolicy)
  command = AdminCommand.new
  command.drop_user(@cluster, policy, user)
end

#execute_udf(key, package_name, function_name, args = [], options = {}) ⇒ Object

Execute user defined function on server and return results.

The function operates on a single record.
The package name is used to locate the udf file location:

udf file = <server udf dir>/<package name>.lua

This method is only supported by Aerospike 3 servers.

Raises:



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/aerospike/client.rb', line 480

def execute_udf(key, package_name, function_name, args=[], options={})
  policy = create_policy(options, WritePolicy)

  command = ExecuteCommand.new(@cluster, policy, key, package_name, function_name, args)
  execute_command(command)

  record = command.record

  return nil if !record || record.bins.empty?

  result_map = record.bins

  # User defined functions don't have to return a value.
  key, obj = result_map.detect{ |k, _| k.include?('SUCCESS') }
  return obj if key

  key, obj = result_map.detect{ |k, _| k.include?('FAILURE') }
  message = key ? obj.to_s : "Invalid UDF return value"
  raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::UDF_BAD_RESPONSE, message)
end

#execute_udf_on_query(statement, package_name, function_name, function_args = [], options = {}) ⇒ Object

execute_udf_on_query applies user defined function on records that match the statement filter. Records are not returned to the client. This asynchronous server call will return before command is complete. The user can optionally wait for command completion by using the returned ExecuteTask instance.

This method is only supported by Aerospike 3 servers. If the policy is nil, the default relevant policy will be used.



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'lib/aerospike/client.rb', line 509

def execute_udf_on_query(statement, package_name, function_name, function_args=[], options={})
  policy = create_policy(options, QueryPolicy)

  nodes = @cluster.nodes
  if nodes.empty?
    raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_NOT_AVAILABLE, "Executing UDF failed because cluster is empty.")
  end

  # TODO: wait until all migrations are finished
  statement.set_aggregate_function(package_name, function_name, function_args, false)

  # Use a thread per node
  nodes.each do |node|
    Thread.new do
      Thread.current.abort_on_exception = true
      begin
        command = QueryCommand.new(node, policy, statement, nil)
        execute_command(command)
      rescue => e
        Aerospike.logger.error(e)
        raise e
      end
    end
  end

  ExecuteTask.new(@cluster, statement)
end

#exists(key, options = {}) ⇒ Object

Determines if a record key exists.

The policy can be used to specify timeouts.



261
262
263
264
265
266
 
# File 'lib/aerospike/client.rb', line 261

def exists(key, options={})
  policy = create_policy(options, Policy)
  command = ExistsCommand.new(@cluster, policy, key)
  execute_command(command)
  command.exists
end

#get(key, bin_names = [], options = {}) ⇒ Object

Read record header and bins for specified key.

The policy can be used to specify timeouts.



292
293
294
295
296
297
298
 
# File 'lib/aerospike/client.rb', line 292

def get(key, bin_names=[], options={})
  policy = create_policy(options, Policy)

  command = ReadCommand.new(@cluster, policy, key, bin_names)
  execute_command(command)
  command.record
end

#get_header(key, options = {}) ⇒ Object

Read record generation and expiration only for specified key. Bins are not read.

The policy can be used to specify timeouts.



302
303
304
305
306
307
 
# File 'lib/aerospike/client.rb', line 302

def get_header(key, options={})
  policy = create_policy(options, Policy)
  command = ReadHeaderCommand.new(@cluster, policy, key)
  execute_command(command)
  command.record
end

#grant_roles(user, roles, options = {}) ⇒ Object

Add roles to user’s list of roles.



767
768
769
770
771
 
# File 'lib/aerospike/client.rb', line 767

def grant_roles(user, roles, options={})
  policy = create_policy(options, AdminPolicy)
  command = AdminCommand.new
  command.grant_roles(@cluster, policy, user, roles)
end

#list_udf(options = {}) ⇒ Object

ListUDF lists all packages containing user defined functions in the server.

This method is only supported by Aerospike 3 servers.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/aerospike/client.rb', line 444

def list_udf(options={})
  str_cmd = 'udf-list'

  # Send command to one node. That node will distribute it to other nodes.
  response_map = @cluster.request_info(@default_policy, str_cmd)
  _, response = response_map.first

  vals = response.split(';')

  vals.map do |udf_info|
    next if udf_info.strip! == ''

    udf_parts = udf_info.split(',')
    udf = UDF.new
    udf_parts.each do |values|
      k, v = values.split('=', 2)
      case k
      when 'filename'
        udf.filename = v
      when 'hash'
        udf.hash = v
      when 'type'
        udf.language = v
      end
    end
    udf
  end
end

#node_names ⇒ Object

Returns list of active server node names in the cluster.



90
91
92
 
# File 'lib/aerospike/client.rb', line 90

def node_names
  @cluster.nodes.map(&:get_name)
end

#nodes ⇒ Object

Returns array of active server nodes in the cluster.



83
84
85
 
# File 'lib/aerospike/client.rb', line 83

def nodes
  @cluster.nodes
end

#operate(key, operations, options = {}) ⇒ Object

Perform multiple read/write operations on a single key in one batch call.

An example would be to add an integer value to an existing record and then
read the result, all in one database call. Operations are executed in
the order they are specified.



368
369
370
371
372
373
374
 
# File 'lib/aerospike/client.rb', line 368

def operate(key, operations, options={})
  policy = create_policy(options, WritePolicy)

  command = OperateCommand.new(@cluster, policy, key, operations)
  execute_command(command)
  command.record
end

#prepend(key, bins, options = {}) ⇒ Object

Examples:

client.prepend key, {'bin', 'value to prepend'}, :timeout => 0.001



155
156
157
158
159
 
# File 'lib/aerospike/client.rb', line 155

def prepend(key, bins, options={})
  policy = create_policy(options, WritePolicy)
  command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::PREPEND)
  execute_command(command)
end

#put(key, bins, options = {}) ⇒ Object

Examples:

client.put key, {'bin', 'value string'}, :timeout => 0.001



113
114
115
116
117
 
# File 'lib/aerospike/client.rb', line 113

def put(key, bins, options={})
  policy = create_policy(options, WritePolicy)
  command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::WRITE)
  execute_command(command)
end

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

Query executes a query and returns a recordset. The query executor puts records on a channel from separate goroutines. The caller can concurrently pops records off the channel through the record channel.

This method is only supported by Aerospike 3 servers. If the policy is nil, a default policy will be generated.



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/aerospike/client.rb', line 697

def query(statement, options={})
  policy = create_policy(options, QueryPolicy)
  new_policy = policy.clone

  nodes = @cluster.nodes
  if nodes.empty?
    raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_NOT_AVAILABLE, "Scan failed because cluster is empty.")
  end

  recordset = Recordset.new(policy.record_queue_size, nodes.length, :query)

  # Use a thread per node
  nodes.each do |node|
    Thread.new do
      Thread.current.abort_on_exception = true
      command = QueryCommand.new(node, new_policy, statement, recordset)
      begin
        execute_command(command)
      rescue => e
        Aerospike.logger.error(e.backtrace.join("\n")) unless e == QUERY_TERMINATED_EXCEPTION
        recordset.cancel(e)
      ensure
        recordset.thread_finished
      end
    end
  end

  recordset
end

#query_user(user, options = {}) ⇒ Object

Retrieve roles for a given user.



781
782
783
784
785
 
# File 'lib/aerospike/client.rb', line 781

def query_user(user, options={})
  policy = create_policy(options, AdminPolicy)
  command = AdminCommand.new
  command.query_user(@cluster, policy, user)
end

#query_users(options = {}) ⇒ Object

Retrieve all users and their roles.



788
789
790
791
792
 
# File 'lib/aerospike/client.rb', line 788

def query_users(options={})
  policy = create_policy(options, AdminPolicy)
  command = AdminCommand.new
  command.query_users(@cluster, policy)
end

#register_udf(udf_body, server_path, language, options = {}) ⇒ Object

Register package containing user defined functions with server.

This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
RegisterTask instance.

This method is only supported by Aerospike 3 servers.



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/aerospike/client.rb', line 397

def register_udf(udf_body, server_path, language, options={})
  content = Base64.strict_encode64(udf_body).force_encoding('binary')

  str_cmd = "udf-put:filename=#{server_path};content=#{content};"
  str_cmd << "content-len=#{content.length};udf-type=#{language};"
  # Send UDF to one node. That node will distribute the UDF to other nodes.
  response_map = @cluster.request_info(@default_policy, str_cmd)

  res = {}
  response_map.each do |k, response|
    vals = response.to_s.split(';')
    vals.each do |pair|
      k, v = pair.split("=", 2)
      res[k] = v
    end
  end

  if res['error']
    raise Aerospike::Exceptions::CommandRejected.new("Registration failed: #{res['error']}\nFile: #{res['file']}\nLine: #{res['line']}\nMessage: #{res['message']}")
  end

  UdfRegisterTask.new(@cluster, server_path)
end

#register_udf_from_file(client_path, server_path, language, options = {}) ⇒ Object

Register package containing user defined functions with server.

This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
RegisterTask instance.

This method is only supported by Aerospike 3 servers.



386
387
388
389
 
# File 'lib/aerospike/client.rb', line 386

def register_udf_from_file(client_path, server_path, language, options={})
  udf_body = File.read(client_path)
  register_udf(udf_body, server_path, language, options)
end

#remove_udf(udf_name, options = {}) ⇒ Object

RemoveUDF removes a package containing user defined functions in the server.

This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
RemoveTask instance.

This method is only supported by Aerospike 3 servers.



427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/aerospike/client.rb', line 427

def remove_udf(udf_name, options={})
  str_cmd = "udf-remove:filename=#{udf_name};"

  # Send command to one node. That node will distribute it to other nodes.
  # Send UDF to one node. That node will distribute the UDF to other nodes.
  response_map = @cluster.request_info(@default_policy, str_cmd)
  _, response = response_map.first

  if response == 'ok'
    UdfRemoveTask.new(@cluster, udf_name)
  else
    raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_ERROR, response)
  end
end

#request_info(*commands) ⇒ Object 



591
592
593
 
# File 'lib/aerospike/client.rb', line 591

def request_info(*commands)
  @cluster.request_info(@default_policy, *commands)
end

#revoke_roles(user, roles, options = {}) ⇒ Object

Remove roles from user’s list of roles.



774
775
776
777
778
 
# File 'lib/aerospike/client.rb', line 774

def revoke_roles(user, roles, options={})
  policy = create_policy(options, AdminPolicy)
  command = AdminCommand.new
  command.revoke_roles(@cluster, policy, user, roles)
end

#scan_all(namespace, set_name, bin_names = [], options = {}) ⇒ Object

Scan Operations



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/aerospike/client.rb', line 599

def scan_all(namespace, set_name, bin_names=[], options={})
  policy = create_policy(options, ScanPolicy)

  # wait until all migrations are finished
  # TODO: implement
  # @cluster.WaitUntillMigrationIsFinished(policy.timeout)

  # Retry policy must be one-shot for scans.
  # copy on write for policy
  new_policy = policy.clone

  nodes = @cluster.nodes
  if nodes.empty?
    raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_NOT_AVAILABLE, "Scan failed because cluster is empty.")
  end

  recordset = Recordset.new(policy.record_queue_size, nodes.length, :scan)

  if policy.concurrent_nodes
    # Use a thread per node
    nodes.each do |node|
      Thread.new do
        Thread.current.abort_on_exception = true
        command = ScanCommand.new(node, new_policy, namespace, set_name, bin_names, recordset)
        begin
          execute_command(command)
        rescue => e
          Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION
          recordset.cancel(e)
        ensure
          recordset.thread_finished
        end
      end
    end
  else
    Thread.new do
      Thread.current.abort_on_exception = true
      nodes.each do |node|
        command = ScanCommand.new(node, new_policy, namespace, set_name, bin_names, recordset)
        begin
          execute_command(command)
        rescue => e
          Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION
          recordset.cancel(e)
        ensure
          recordset.thread_finished
        end
      end
    end
  end

  recordset
end

#scan_node(node, namespace, set_name, bin_names = [], options = {}) ⇒ Object

ScanNode reads all records in specified namespace and set, from one node only. The policy can be used to specify timeouts.



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/aerospike/client.rb', line 655

def scan_node(node, namespace, set_name, bin_names=[], options={})
  policy = create_policy(options, ScanPolicy)
  # wait until all migrations are finished
  # TODO: implement
  # @cluster.WaitUntillMigrationIsFinished(policy.timeout)

  # Retry policy must be one-shot for scans.
  # copy on write for policy
  new_policy = policy.clone
  new_policy.max_retries = 0

  node = @cluster.get_node_by_name(node) unless node.is_a?(Aerospike::Node)

  recordset = Recordset.new(policy.record_queue_size, 1, :scan)

  Thread.new do
    Thread.current.abort_on_exception = true
    command = ScanCommand.new(node, new_policy, namespace, set_name, bin_names, recordset)
    begin
      execute_command(command)
    rescue => e
      Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION
      recordset.cancel(e)
    ensure
      recordset.thread_finished
    end
  end

  recordset
end

#supports_feature?(feature) ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/aerospike/client.rb', line 94

def supports_feature?(feature)
  @cluster.supports_feature?(feature)
end

#touch(key, options = {}) ⇒ Object

Examples:

client.touch key, :timeout => 0.001



248
249
250
251
252
 
# File 'lib/aerospike/client.rb', line 248

def touch(key, options={})
  policy = create_policy(options, WritePolicy)
  command = TouchCommand.new(@cluster, policy, key)
  execute_command(command)
end

#truncate(namespace, set_name = nil, before_last_update = nil, options = {}) ⇒ Object

Removes records in the specified namespace/set efficiently.

This method is orders of magnitude faster than deleting records one at a time. It requires Aerospike Server version 3.12 or later. See www.aerospike.com/docs/reference/info#truncate for further information.

This asynchronous server call may return before the truncate is complete. The user can still write new records after the server call returns because new records will have last update times greater than the truncate cut-off (set at the time of the truncate call.)

If no policy options are provided, @default_info_policy will be used.

Raises:



222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/aerospike/client.rb', line 222

def truncate(namespace, set_name = nil, before_last_update = nil, options = {})
  policy = create_policy(options, WritePolicy)
  str_cmd = "truncate:namespace=#{namespace}"
  str_cmd << ";set=#{set_name}" unless set_name.to_s.strip.empty?
  str_cmd << ";lut=#{(before_last_update.to_f * 1_000_000_000.0).round}" if before_last_update

  # Send index command to one node. That node will distribute the command to other nodes.
  response = send_info_command(policy, str_cmd).upcase
  return if response == 'OK'
  raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_ERROR, "Truncate failed: #{response}")
end