README
¶
Couchbase Connection Strings for Go
This library allows you to parse and resolve Couchbase Connection Strings in Go. This is used by the Couchbase Go SDK, as well as various tools throughout the Couchbase infrastructure.
Using the Library
To parse a connection string, simply call Parse with your connection string.
You will receive a ConnSpec structure representing the connection string`:
type Address struct {
Host string
Port int
}
type ConnSpec struct {
Scheme string
Addresses []Address
Bucket string
Options map[string][]string
}
One you have a parsed connection string, you can also use our resolver to take
the ConnSpec and resolve any DNS SRV records as well as generate a list of
endpoints for the Couchbase server. You will receive a ResolvedConnSpec
structure in return:
type ResolvedConnSpec struct {
UseSsl bool
MemdHosts []Address
HttpHosts []Address
Bucket string
Options map[string][]string
}
License
Copyright 2020 Couchbase Inc.
Licensed under the Apache License, Version 2.0.
Documentation
¶
Index ¶
Constants ¶
const ( // DefaultHttpPort is the default HTTP port to use to connect to Couchbase Server. DefaultHttpPort = 8091 // DefaultSslHttpPort is the default HTTPS port to use to connect to Couchbase Server. DefaultSslHttpPort = 18091 // DefaultMemdPort is the default memd port to use to connect to Couchbase Server. DefaultMemdPort = 11210 // DefaultSslMemdPort is the default memd SSL port to use to connect to Couchbase Server. DefaultSslMemdPort = 11207 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConnSpec ¶
type ConnSpec struct {
Scheme string
Addresses []Address
Bucket string
Options map[string][]string
}
ConnSpec describes a connection specification.
func (ConnSpec) GetOptionString ¶
GetOptionString returns the specified option value for the ConnSpec.
func (ConnSpec) SrvRecordName ¶
SrvRecordName returns the record name for the ConnSpec.
type ResolvedConnSpec ¶
type ResolvedConnSpec struct {
UseSsl bool
MemdHosts []Address
HttpHosts []Address
NSServerHost *Address
Bucket string
Options map[string][]string
SrvRecord *SrvRecord
}
ResolvedConnSpec is the result of resolving a ConnSpec.
func Resolve ¶
func Resolve(connSpec ConnSpec) (out ResolvedConnSpec, err error)
Resolve parses a ConnSpec into a ResolvedConnSpec.
Source Files