connect

type CouchbaseConnection ¶ added in v1.1.0

type CouchbaseConnection struct {

	//The logger.
	Logger *clog.CompositeLogger
	//The connection resolver.
	ConnectionResolver *CouchbaseConnectionResolver
	//The configuration options.
	Options *cconf.ConfigParams
	//The Couchbase cluster connection object.
	Connection *gocb.Cluster
	//The Couchbase bucket name.
	BucketName string
	//The Couchbase bucket object.
	Bucket        *gocb.Bucket
	Authenticator gocb.PasswordAuthenticator
	// contains filtered or unexported fields
}

CouchbaseConnection it is couchbase connection using plain couchbase driver. This is the most basic persistence component that is only able to store data items of any type. Specific CRUD operations over the data items must be implemented in child classes by accessing c.Connection properties.

Configuration parameters:

• bucket: (optional) Couchbase bucket name

• connection(s):

• discovery_key: (optional) a key to retrieve the connection from connect.idiscovery.html IDiscovery]]

• host: host name or IP address

• port: port number (default: 27017)

• uri: resource URI or connection string with all parameters in it

• credential(s):

• store_key: (optional) a key to retrieve the credentials from auth.icredentialstore.html ICredentialStore]]

• username: (optional) user name

• password: (optional) user password

• options:

• auto_create: (optional) automatically create missing bucket (default: false)

• auto_index: (optional) automatically create primary index (default: false)

• flush_enabled: (optional) bucket flush enabled (default: false)

• bucket_type: (optional) bucket type (default: couchbase)

• ram_quota: (optional) RAM quota in MB (default: 100)

  References:

- *:logger:*:*:1.0 (optional) ILogger components to pass log messages - *:discovery:*:*:1.0 (optional) IDiscovery services - *:credential-store:\*:\*:1.0 (optional) Credential stores to resolve credentials

func NewCouchbaseConnection(bucketName string) *CouchbaseConnection

func (c *CouchbaseConnection) Close(correlationId string) (err error)

func (c *CouchbaseConnection) Configure(config *cconf.ConfigParams)

func (c *CouchbaseConnection) GetBucket() *gocb.Bucket

func (c *CouchbaseConnection) GetBucketName() string

func (c *CouchbaseConnection) GetConnection() *gocb.Cluster

func (c *CouchbaseConnection) IsOpen() bool

func (c *CouchbaseConnection) Open(correlationId string) (err error)

func (c *CouchbaseConnection) SetReferences(references cref.IReferences)

type CouchbaseConnectionParams ¶

type CouchbaseConnectionParams struct {
	Uri      string `json: "uri"`
	Username string `json "username"`
	Password string `json: "password"`
}

CouchbaseConnectionParams struct for save connection params

type CouchbaseConnectionResolver ¶

type CouchbaseConnectionResolver struct {
	//The connections resolver.
	ConnectionResolver *ccon.ConnectionResolver
	//The credentials resolver.
	CredentialResolver *cauth.CredentialResolver
}

CouchbaseConnectionResolver helper class that resolves Couchbase connection and credential parameters, validates them and generates a connection URI.

It is able to process multiple connections to Couchbase cluster nodes.

Configuration parameters:

• connection(s):
• discovery_key: (optional) a key to retrieve the connection from IDiscovery
• host: host name or IP address
• port: port number (default: 27017)
• database: database (bucket) name
• uri: resource URI or connection string with all parameters in it
• credential(s):
• store_key: (optional) a key to retrieve the credentials from auth.icredentialstore.html ICredentialStore
• username: user name
• password: user password

References:

- *:discovery:*:*:1.0 (optional) IDiscovery services - *:credential-store:*:*:1.0 (optional) Credential stores to resolve credentials

func NewCouchbaseConnectionResolver() *CouchbaseConnectionResolver

func (c *CouchbaseConnectionResolver) Configure(config *cconf.ConfigParams)

func (c *CouchbaseConnectionResolver) Resolve(correlationId string) (connection *CouchbaseConnectionParams, err error)

func (c *CouchbaseConnectionResolver) SetReferences(references cref.IReferences)