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.


50
51
52
53
54
55
56
57
58
59
60
# File 'lib/aerospike/client.rb', line 50

def initialize(hosts = nil, policy: ClientPolicy.new, connect: true)

  hosts = ::Aerospike::Host::Parse.(hosts || ENV['AEROSPIKE_HOSTS'] || 'localhost')
  policy = create_policy(policy, ClientPolicy)
  set_default_policies(policy.policies)
  @cluster = Cluster.new(policy, hosts)
  @cluster.add_cluster_config_change_listener(self)

  self.connect if connect
  self
end

Instance Attribute Details

#clusterObject

Returns the value of attribute cluster


48
49
50
# File 'lib/aerospike/client.rb', line 48

def cluster
  @cluster
end

#default_admin_policyObject

Returns the value of attribute default_admin_policy


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

def default_admin_policy
  @default_admin_policy
end

#default_batch_policyObject

Returns the value of attribute default_batch_policy


41
42
43
# File 'lib/aerospike/client.rb', line 41

def default_batch_policy
  @default_batch_policy
end

#default_info_policyObject

Returns the value of attribute default_info_policy


42
43
44
# File 'lib/aerospike/client.rb', line 42

def default_info_policy
  @default_info_policy
end

#default_operate_policyObject

Returns the value of attribute default_operate_policy


47
48
49
# File 'lib/aerospike/client.rb', line 47

def default_operate_policy
  @default_operate_policy
end

#default_query_policyObject

Returns the value of attribute default_query_policy


43
44
45
# File 'lib/aerospike/client.rb', line 43

def default_query_policy
  @default_query_policy
end

#default_read_policyObject

Returns the value of attribute default_read_policy


44
45
46
# File 'lib/aerospike/client.rb', line 44

def default_read_policy
  @default_read_policy
end

#default_scan_policyObject

Returns the value of attribute default_scan_policy


45
46
47
# File 'lib/aerospike/client.rb', line 45

def default_scan_policy
  @default_scan_policy
end

#default_write_policyObject

Returns the value of attribute default_write_policy


46
47
48
# File 'lib/aerospike/client.rb', line 46

def default_write_policy
  @default_write_policy
end

Instance Method Details

#add(key, bins, options = nil) ⇒ Object

Examples:

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

182
183
184
185
186
# File 'lib/aerospike/client.rb', line 182

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

#append(key, bins, options = nil) ⇒ Object

Examples:

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

140
141
142
143
144
# File 'lib/aerospike/client.rb', line 140

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

#batch_exists(keys, options = nil) ⇒ Object

Check if multiple record keys exist in one batch call.

The returned boolean array is in positional order with the original key array order.
The policy can be used to specify timeouts and protocol type.

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/aerospike/client.rb', line 360

def batch_exists(keys, options = nil)
  policy = create_policy(options, BatchPolicy, default_batch_policy)
  results = Array.new(keys.length)

  if policy.use_batch_direct
    key_map = BatchItem.generate_map(keys)
    execute_batch_direct_commands(policy, keys) do |node, batch|
      BatchDirectExistsCommand.new(node, batch, policy, key_map, results)
    end
  else
    execute_batch_index_commands(policy, keys) do |node, batch|
      BatchIndexExistsCommand.new(node, batch, policy, results)
    end
  end

  results
end

#batch_get(keys, bin_names = nil, options = nil) ⇒ 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 and protocol type.

321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'lib/aerospike/client.rb', line 321

def batch_get(keys, bin_names = nil, options = nil)
  policy = create_policy(options, BatchPolicy, default_batch_policy)
  results = Array.new(keys.length)
  info_flags = INFO1_READ

  case bin_names
  when :all, nil, []
    info_flags |= INFO1_GET_ALL
    bin_names = nil
  when :none
    info_flags |= INFO1_NOBINDATA
    bin_names = nil
  end

  if policy.use_batch_direct
    key_map = BatchItem.generate_map(keys)
    execute_batch_direct_commands(policy, keys) do |node, batch|
      BatchDirectCommand.new(node, batch, policy, key_map, bin_names, results, info_flags)
    end
  else
    execute_batch_index_commands(policy, keys) do |node, batch|
      BatchIndexCommand.new(node, batch, policy, bin_names, results, info_flags)
    end
  end

  results
end

#batch_get_header(keys, options = nil) ⇒ 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 and protocol type.

353
354
355
# File 'lib/aerospike/client.rb', line 353

def batch_get_header(keys, options = nil)
  batch_get(keys, :none, options)
end

#change_password(user, password, options = nil) ⇒ Object

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


775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
# File 'lib/aerospike/client.rb', line 775

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

  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

#closeObject

Closes all client connections to database server nodes.


72
73
74
# File 'lib/aerospike/client.rb', line 72

def close
  @cluster.close
end

#connectObject

Connect to the cluster.


65
66
67
# File 'lib/aerospike/client.rb', line 65

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)

80
81
82
# File 'lib/aerospike/client.rb', line 80

def connected?
  @cluster.connected?
end

#create_index(namespace, set_name, index_name, bin_name, index_type, collection_type = nil, options = nil) ⇒ 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

570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
# File 'lib/aerospike/client.rb', line 570

def create_index(namespace, set_name, index_name, bin_name, index_type, collection_type = nil, options = nil)
  if options.nil? && collection_type.is_a?(Hash)
    options, collection_type = collection_type, nil
  end
  policy = create_policy(options, Policy, default_info_policy)

  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 = nil) ⇒ Object

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


760
761
762
763
764
765
# File 'lib/aerospike/client.rb', line 760

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

#delete(key, options = nil) ⇒ Object

Examples:

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

204
205
206
207
208
209
# File 'lib/aerospike/client.rb', line 204

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

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

Delete secondary index.

This method is only supported by Aerospike 3 servers.

600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
# File 'lib/aerospike/client.rb', line 600

def drop_index(namespace, set_name, index_name, options = nil)
  policy = create_policy(options, Policy, default_info_policy)

  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 = nil) ⇒ Object

Remove user from cluster.


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

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

#execute_udf(key, package_name, function_name, args = [], options = nil) ⇒ 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.

504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
# File 'lib/aerospike/client.rb', line 504

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

  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 = nil) ⇒ 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.


533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
# File 'lib/aerospike/client.rb', line 533

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

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

  statement = statement.clone
  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 = nil) ⇒ Object

Determines if a record key exists.

The policy can be used to specify timeouts.

283
284
285
286
287
288
# File 'lib/aerospike/client.rb', line 283

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

#get(key, bin_names = nil, options = nil) ⇒ Object

Read record header and bins for specified key.

The policy can be used to specify timeouts.

296
297
298
299
300
301
302
# File 'lib/aerospike/client.rb', line 296

def get(key, bin_names = nil, options = nil)
  policy = create_policy(options, Policy, default_read_policy)

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

#get_header(key, options = nil) ⇒ Object

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

The policy can be used to specify timeouts.

306
307
308
309
310
311
# File 'lib/aerospike/client.rb', line 306

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

#grant_roles(user, roles, options = nil) ⇒ Object

Add roles to user's list of roles.


794
795
796
797
798
# File 'lib/aerospike/client.rb', line 794

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

#list_udf(options = nil) ⇒ Object

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

This method is only supported by Aerospike 3 servers.

466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
# File 'lib/aerospike/client.rb', line 466

def list_udf(options = nil)
  policy = create_policy(options, Policy, default_info_policy)

  str_cmd = 'udf-list'

  # Send command to one node. That node will distribute it to other nodes.
  response_map = @cluster.request_info(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_namesObject

Returns list of active server node names in the cluster.


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

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

#nodesObject

Returns array of active server nodes in the cluster.


87
88
89
# File 'lib/aerospike/client.rb', line 87

def nodes
  @cluster.nodes
end

#operate(key, operations, options = nil) ⇒ 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.

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

def operate(key, operations, options = nil)
  policy = create_policy(options, OperatePolicy, default_operate_policy)

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

#prepend(key, bins, options = nil) ⇒ Object

Examples:

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

159
160
161
162
163
# File 'lib/aerospike/client.rb', line 159

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

#put(key, bins, options = nil) ⇒ Object

Examples:

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

117
118
119
120
121
# File 'lib/aerospike/client.rb', line 117

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

#query(statement, options = nil) ⇒ 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.


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
# File 'lib/aerospike/client.rb', line 724

def query(statement, options = nil)
  policy = create_policy(options, QueryPolicy, default_query_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, :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 = nil) ⇒ Object

Retrieve roles for a given user.


808
809
810
811
812
# File 'lib/aerospike/client.rb', line 808

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

#query_users(options = nil) ⇒ Object

Retrieve all users and their roles.


815
816
817
818
819
# File 'lib/aerospike/client.rb', line 815

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

#register_udf(udf_body, server_path, language, options = nil) ⇒ 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.

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
# File 'lib/aerospike/client.rb', line 415

def register_udf(udf_body, server_path, language, options = nil)
  policy = create_policy(options, Policy, default_info_policy)

  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(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 = nil) ⇒ 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.

404
405
406
407
# File 'lib/aerospike/client.rb', line 404

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

#remove_udf(udf_name, options = nil) ⇒ 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.

447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'lib/aerospike/client.rb', line 447

def remove_udf(udf_name, options = nil)
  policy = create_policy(options, Policy, default_info_policy)

  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(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, policy: nil) ⇒ Object


617
618
619
620
# File 'lib/aerospike/client.rb', line 617

def request_info(*commands, policy: nil)
  policy = create_policy(policy, Policy, default_info_policy)
  @cluster.request_info(policy, *commands)
end

#revoke_roles(user, roles, options = nil) ⇒ Object

Remove roles from user's list of roles.


801
802
803
804
805
# File 'lib/aerospike/client.rb', line 801

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

#scan_all(namespace, set_name, bin_names = nil, options = nil) ⇒ Object


Scan Operations



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
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
# File 'lib/aerospike/client.rb', line 626

def scan_all(namespace, set_name, bin_names = nil, options = nil)
  policy = create_policy(options, ScanPolicy, default_scan_policy)

  # 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 = nil, options = nil) ⇒ Object

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


682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
# File 'lib/aerospike/client.rb', line 682

def scan_node(node, namespace, set_name, bin_names = nil, options = nil)
  policy = create_policy(options, ScanPolicy, default_scan_policy)
  # 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)

98
99
100
# File 'lib/aerospike/client.rb', line 98

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

#touch(key, options = nil) ⇒ Object

Examples:

client.touch key, :timeout => 0.001

270
271
272
273
274
# File 'lib/aerospike/client.rb', line 270

def touch(key, options = nil)
  policy = create_policy(options, WritePolicy, default_write_policy)
  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.


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/aerospike/client.rb', line 226

def truncate(namespace, set_name = nil, before_last_update = nil, options = {})
  policy = create_policy(options, Policy, default_info_policy)

  node = @cluster.random_node
  conn = node.get_connection(policy.timeout)

  if set_name && !set_name.to_s.strip.empty?
    str_cmd = "truncate:namespace=#{namespace}"
    str_cmd << ";set=#{set_name}" unless set_name.to_s.strip.empty?
  else
    if node.supports_feature(Aerospike::Features::TRUNCATE_NAMESPACE)
      str_cmd = "truncate-namespace:namespace=#{namespace}"
    else
      str_cmd = "truncate:namespace=#{namespace}"
    end
  end

  if before_last_update
    lut_nanos = (before_last_update.to_f * 1_000_000_000.0).round
    str_cmd << ";lut=#{lut_nanos}"
  elsif supports_feature?(Aerospike::Features::LUT_NOW)
    # Servers >= 4.3.1.4 require lut argument
    str_cmd << ";lut=now"
  end

  response = send_info_command(policy, str_cmd, node).upcase
  return if response == 'OK'
  raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_ERROR, "Truncate failed: #{response}")
end