Class: Couchbase::Options::Cluster

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/options.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/options.rb more...

Overview

Options for Cluster.connect

Examples:

Pass authenticator object to Options

Cluster.connect("couchbase://localhost",
  Options::Cluster(authenticator: PasswordAuthenticator.new("Administrator", "password")))

Shorter version, more useful for interactive sessions

Cluster.connect("couchbase://localhost", "Administrator", "password")

Authentication with TLS client certificate (note couchbases:// schema)

Cluster.connect("couchbases://localhost?trust_certificate=/tmp/ca.pem",
  Options::Cluster(authenticator: CertificateAuthenticator.new("/tmp/certificate.pem", "/tmp/private.key")))

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authenticator: nil, enable_metrics: nil, metrics_emit_interval: nil, enable_tracing: nil, orphaned_emit_interval: nil, orphaned_sample_size: nil, threshold_emit_interval: nil, threshold_sample_size: nil, key_value_threshold: nil, query_threshold: nil, view_threshold: nil, search_threshold: nil, analytics_threshold: nil, management_threshold: nil, bootstrap_timeout: nil, resolve_timeout: nil, connect_timeout: nil, key_value_timeout: nil, view_timeout: nil, query_timeout: nil, analytics_timeout: nil, search_timeout: nil, management_timeout: nil, dns_srv_timeout: nil, tcp_keep_alive_interval: nil, config_poll_interval: nil, config_poll_floor: nil, config_idle_redial_timeout: nil, idle_http_connection_timeout: nil) {|self| ... } ⇒ Cluster

Creates an instance of options for Cluster.connect

Parameters:

  • authenticator (PasswordAuthenticator, CertificateAuthenticator) (defaults to: nil)
  • key_value_timeout (nil, Integer, #in_milliseconds) (defaults to: nil) —

    default timeout for Key/Value operations, e.g. Collection#get

  • view_timeout (nil, Integer, #in_milliseconds) (defaults to: nil) —

    default timeout for View query

  • query_timeout (nil, Integer, #in_milliseconds) (defaults to: nil) —

    default timeout for N1QL query

  • analytics_timeout (nil, Integer, #in_milliseconds) (defaults to: nil) —

    default timeout for Analytics query

  • search_timeout (nil, Integer, #in_milliseconds) (defaults to: nil) —

    default timeout for Search query

  • management_timeout (nil, Integer, #in_milliseconds) (defaults to: nil) —

    default timeout for management operations

Yield Parameters:

See Also:

[View source]

1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'lib/couchbase/options.rb', line 1461

def initialize(authenticator: nil,
               enable_metrics: nil,
               metrics_emit_interval: nil,
               enable_tracing: nil,
               orphaned_emit_interval: nil,
               orphaned_sample_size: nil,
               threshold_emit_interval: nil,
               threshold_sample_size: nil,
               key_value_threshold: nil,
               query_threshold: nil,
               view_threshold: nil,
               search_threshold: nil,
               analytics_threshold: nil,
               management_threshold: nil,
               bootstrap_timeout: nil,
               resolve_timeout: nil,
               connect_timeout: nil,
               key_value_timeout: nil,
               view_timeout: nil,
               query_timeout: nil,
               analytics_timeout: nil,
               search_timeout: nil,
               management_timeout: nil,
               dns_srv_timeout: nil,
               tcp_keep_alive_interval: nil,
               config_poll_interval: nil,
               config_poll_floor: nil,
               config_idle_redial_timeout: nil,
               idle_http_connection_timeout: nil)
  @authenticator = authenticator
  @enable_metrics = enable_metrics
  @metrics_emit_interval = metrics_emit_interval
  @enable_tracing = enable_tracing
  @orphaned_emit_interval = orphaned_emit_interval
  @orphaned_sample_size = orphaned_sample_size
  @threshold_emit_interval = threshold_emit_interval
  @threshold_sample_size = threshold_sample_size
  @key_value_threshold = key_value_threshold
  @query_threshold = query_threshold
  @view_threshold = view_threshold
  @search_threshold = search_threshold
  @analytics_threshold = analytics_threshold
  @management_threshold = management_threshold
  @bootstrap_timeout = bootstrap_timeout
  @resolve_timeout = resolve_timeout
  @connect_timeout = connect_timeout
  @key_value_timeout = key_value_timeout
  @view_timeout = view_timeout
  @query_timeout = query_timeout
  @analytics_timeout = analytics_timeout
  @search_timeout = search_timeout
  @management_timeout = management_timeout
  @dns_srv_timeout = dns_srv_timeout
  @tcp_keep_alive_interval = tcp_keep_alive_interval
  @config_poll_interval = config_poll_interval
  @config_poll_floor = config_poll_floor
  @config_idle_redial_timeout = config_idle_redial_timeout
  @idle_http_connection_timeout = idle_http_connection_timeout
  yield self if block_given?
end

Instance Attribute Details

#analytics_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1429
1430
1431
 
# File 'lib/couchbase/options.rb', line 1429

def analytics_threshold
  @analytics_threshold
end

#analytics_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1438
1439
1440
 
# File 'lib/couchbase/options.rb', line 1438

def analytics_timeout
  @analytics_timeout
end

#authenticator ⇒ PasswordAuthenticator, CertificateAuthenticator

Returns:


1416
1417
1418
 
# File 'lib/couchbase/options.rb', line 1416

def authenticator
  @authenticator
end

#bootstrap_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1432
1433
1434
 
# File 'lib/couchbase/options.rb', line 1432

def bootstrap_timeout
  @bootstrap_timeout
end

#config_idle_redial_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1445
1446
1447
 
# File 'lib/couchbase/options.rb', line 1445

def config_idle_redial_timeout
  @config_idle_redial_timeout
end

#config_poll_floor ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1444
1445
1446
 
# File 'lib/couchbase/options.rb', line 1444

def config_poll_floor
  @config_poll_floor
end

#config_poll_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1443
1444
1445
 
# File 'lib/couchbase/options.rb', line 1443

def config_poll_interval
  @config_poll_interval
end

#connect_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1434
1435
1436
 
# File 'lib/couchbase/options.rb', line 1434

def connect_timeout
  @connect_timeout
end

#dns_srv_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1441
1442
1443
 
# File 'lib/couchbase/options.rb', line 1441

def dns_srv_timeout
  @dns_srv_timeout
end

#enable_metrics ⇒ Boolean

Returns:

  • (Boolean) 

1418
1419
1420
 
# File 'lib/couchbase/options.rb', line 1418

def enable_metrics
  @enable_metrics
end

#enable_tracing ⇒ Boolean

Returns:

  • (Boolean) 

1420
1421
1422
 
# File 'lib/couchbase/options.rb', line 1420

def enable_tracing
  @enable_tracing
end

#idle_http_connection_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1446
1447
1448
 
# File 'lib/couchbase/options.rb', line 1446

def idle_http_connection_timeout
  @idle_http_connection_timeout
end

#key_value_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1425
1426
1427
 
# File 'lib/couchbase/options.rb', line 1425

def key_value_threshold
  @key_value_threshold
end

#key_value_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1435
1436
1437
 
# File 'lib/couchbase/options.rb', line 1435

def key_value_timeout
  @key_value_timeout
end

#management_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1430
1431
1432
 
# File 'lib/couchbase/options.rb', line 1430

def management_threshold
  @management_threshold
end

#management_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1440
1441
1442
 
# File 'lib/couchbase/options.rb', line 1440

def management_timeout
  @management_timeout
end

#metrics_emit_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1419
1420
1421
 
# File 'lib/couchbase/options.rb', line 1419

def metrics_emit_interval
  @metrics_emit_interval
end

#orphaned_emit_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1421
1422
1423
 
# File 'lib/couchbase/options.rb', line 1421

def orphaned_emit_interval
  @orphaned_emit_interval
end

#orphaned_sample_size ⇒ nil, Integer

Returns:

  • (nil, Integer) 

1422
1423
1424
 
# File 'lib/couchbase/options.rb', line 1422

def orphaned_sample_size
  @orphaned_sample_size
end

#query_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1426
1427
1428
 
# File 'lib/couchbase/options.rb', line 1426

def query_threshold
  @query_threshold
end

#query_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1437
1438
1439
 
# File 'lib/couchbase/options.rb', line 1437

def query_timeout
  @query_timeout
end

#resolve_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1433
1434
1435
 
# File 'lib/couchbase/options.rb', line 1433

def resolve_timeout
  @resolve_timeout
end

#search_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1428
1429
1430
 
# File 'lib/couchbase/options.rb', line 1428

def search_threshold
  @search_threshold
end

#search_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1439
1440
1441
 
# File 'lib/couchbase/options.rb', line 1439

def search_timeout
  @search_timeout
end

#tcp_keep_alive_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1442
1443
1444
 
# File 'lib/couchbase/options.rb', line 1442

def tcp_keep_alive_interval
  @tcp_keep_alive_interval
end

#threshold_emit_interval ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1423
1424
1425
 
# File 'lib/couchbase/options.rb', line 1423

def threshold_emit_interval
  @threshold_emit_interval
end

#threshold_sample_size ⇒ nil, Integer

Returns:

  • (nil, Integer) 

1424
1425
1426
 
# File 'lib/couchbase/options.rb', line 1424

def threshold_sample_size
  @threshold_sample_size
end

#view_threshold ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1427
1428
1429
 
# File 'lib/couchbase/options.rb', line 1427

def view_threshold
  @view_threshold
end

#view_timeout ⇒ nil, ...

Returns:

  • (nil, Integer, #in_milliseconds) 

1436
1437
1438
 
# File 'lib/couchbase/options.rb', line 1436

def view_timeout
  @view_timeout
end

Instance Method Details

#apply_profile(profile_name) ⇒ Object

Parameters:

  • profile_name (String) —

    The name of the configuration profile to apply (e.g. “wan_development”)

[View source]

1529
1530
1531
 
# File 'lib/couchbase/options.rb', line 1529

def apply_profile(profile_name)
  ConfigProfiles::KNOWN_PROFILES.apply(profile_name, self)
end

#authenticate(username, password) ⇒ Object

Parameters:

  • username (String)
  • password (String)
[View source]

1524
1525
1526
 
# File 'lib/couchbase/options.rb', line 1524

def authenticate(username, password)
  @authenticator = PasswordAuthenticator.new(username, password)
end