Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Managing Connections

      +
      This section describes how to connect the Go Analytics SDK to an Analytics cluster. It contains best practices as well as information on TLS/SSL and advanced connection options, and a sub-page on troubleshooting remote connections.

      Our Getting Started pages cover the basics of making a connection to an Enterprise Analytics cluster. This page is a wider look at the topic.

      Connecting to a Cluster

      A connection to an Enterprise Analytics cluster is represented by a Cluster object. A Cluster provides access to Buckets and Scopes, as well as various Couchbase services and management interfaces. The simplest way to create a Cluster object is to call cbanalytics.Connect() with a connection string, username, and password:

      	cluster, err := cbanalytics.NewCluster(
		connStr,
		cbanalytics.NewBasicAuthCredential(username, password),
		// The third parameter is optional.
		// This example sets the default server query timeout to 3 minutes,
		// that is the timeout value sent to the query server.
		cbanalytics.NewClusterOptions().SetTimeoutOptions(
			cbanalytics.NewTimeoutOptions().SetQueryTimeout(3*time.Minute),
		),
	)
	handleErr(err)

      Connection Strings

      Typically, an Enterprise Analytics cluster will be behind a load balancer, and you will be making a connection over TLS — so the port used will be 443. This is the defaut for the SDK, so port 443 does not need to be specified: https://analytics.example.com.

      You must specify the schema — either https:// (for TLS) or http:// (for insecure connections — perhaps on a development machine) in the connection string. The default port for insecure connections is port 80.

      If you’re connecting to a cluster directly, without a load balancer, you can specify the port in the connection string: https://analytics.example.com:18095. For a standalone Analytics cluster, the port is usually 18095 (or 8095 for an insecure connection). Make sure to check with your administrator.

      Client Settings Parameters

      Connection strings can also include client settings, which will override any that are also set in the code.

      Connection string with two parameters
      https://analytics.example.com?timeout.connect_timeout=30s&timeout.query_timeout=2m

      The full list of recognized parameters is documented in the client settings reference.

      Local Development

      We strongly recommend that the client and server are in the same LAN-like environment (e.g. AWS Region). As this may not always be possible during development, read the guidance on working with constrained network environments.

      Troubleshooting Connections to Cloud

      Our Troubleshooting Connections page will help you to diagnose some problems encountered if your test cluster is in a remote data center, but you are developing on a local laptop — as well as introducing the SDK doctor tool.