Managing Connections
This section describes how to connect the Python Analytics SDK to an Enterprise Analytics cluster. It contains best practices as well as information on TLS/SSL and advanced connection options, and a sub-page on troubleshooting Cloud 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
The examples below use these imports:
from couchbase_analytics.cluster import Cluster
from couchbase_analytics.credential import Credential
from couchbase_analytics.options import (ClusterOptions,
SecurityOptions)A connection to an Enterprise Analytics cluster is represented by a Cluster object.
The simplest way to create a Cluster object is to call Cluster.createnstance() with a connection string, user credentials, and any optional settings:
def main() -> None:
# Update this to your cluster
connstr = 'https://--your-instance--'
username = 'username'
pw = 'Password!123'
# User Input ends here.
cred = Credential.from_username_and_password(username, pw)
cluster = Cluster.create_instance(connstr, cred, opts)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.
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.
https://analytics.example.com?timeout.connect_timeout=75s&timeout.query_timeout=100s
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.