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

Extends: CompositeConnectionResolver


The CouchbaseConnectionResolver class is used to resolve Couchbase connections and credential parameters, validate them and generate connection URIs/

Important points

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

Configuration parameters

  • connection(s):
    • discovery_key: (optional) 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) key to retrieve the credentials from ICredentialStore
    • username: username
    • password: user’s password


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



Connection resolver

protected _connectionResolver: ConnectionResolver


Credential resolver

protected _credentialResolver: CredentialResolver


Creates an instance of this class.

public constructor()

Instance methods


Merges connection options with connection parameters. This method can be overriden in child classes.

public resolve(correlationId: string): Promise<CouchbaseConnectionParams>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • returns: Promise<CouchbaseConnectionParams> - resolved URI.


Sets references to dependent components.

public setReferences(references: IReferences): void

  • references: IReferences - references to locate the component’s dependencies.