struct CryBase::CouchBase::ConnectionString

• CryBase::CouchBase::ConnectionString
• CryBase::Interfaces::ConnectionString
• Struct
• Value
• Object

Overview

Parses a Couchbase connection string of the form:

• couchbase://host[,host2][:port] — plaintext
• couchbases://host[,host2][:port] — TLS
• couchbase://user:pass@host[:port]/bucket?params — KV credentials/options
• http(s)://host[:port] — treated as the Management URL

cs = CryBase::CouchBase::ConnectionString.parse(
  "couchbases://user:pass@n1,n2:11207/default?tls_verify=false"
)
cs.hosts         # => ["n1", "n2"]
cs.tls?          # => true
cs.explicit_port # => 11207
cs.username      # => "user"
cs.bucket        # => "default"

Defined in:

Constructors

• .new(hosts : Array(String), tls : Bool, explicit_port : Int32 | Nil = nil, username : String | Nil = nil, password : String | Nil = nil, bucket : String | Nil = nil, params : URI::Params = URI::Params.new, ports : Array(Int32 | Nil) = [] of Int32 | ::Nil)
• .parse(input : String) : ConnectionString

  Parses input into a ConnectionString.

Instance Method Summary

• #bool_param(name : String, default : Bool) : Bool

  Reads a boolean query parameter.

• #bucket : String | Nil
• #explicit_port : Int32 | Nil

  Port explicitly given in the URI, or nil when none was supplied.

• #hosts : Array(String)

  The cluster nodes parsed from the connection string.

• #param(name : String) : String | Nil

  Returns the first value for name from the connection string query.

• #params : URI::Params
• #password : String | Nil
• #ports : Array(Int32 | Nil)
• #tls? : Bool

  Whether the connection should be made over TLS.

• #username : String | Nil

Constructor Detail

ConnectionString.parse("localhost")          # plaintext, no port
ConnectionString.parse("couchbases://h1,h2") # TLS, two hosts

Instance Method Detail