Use a Couchbase SDK with Capella Analytics Services

  • Capella Analytics
  • how-to
    +
    The Couchbase SDKs enable you to connect client code written in popular languages to Capella Analytics services. You can connect existing applications to Capella Analytics services and develop new ones.

    Capella Analytics SDKs, also known as Columnar SDKs, are similar to the Enterprise Analytics SDKs. They must be used to connect to the current Capella Analytics Service, as it presents a different connection interface, without Enterprise Analytics' load balancer.

    About SDK Use

    Existing applications that you originally designed for the Analytics Service in Couchbase Server or Capella should continue to work with Capella Analytics services after a few changes, centered on connection string, imports, and the query method. For more information, see the individual Capella Analytics SDK pages for the Go, Java, Node.js, and Python Columnar SDKs.

    The main differences are:

    • How you obtain the connection string for your app.

    • How Capella Analytics links to, and organizes, collections of data from different sources.

    For more information about developing an app for analytics, see the Analytics topic in the SDK documentation for your preferred language. For example, for the Java SDK see Analytics (Java SDK).

    Getting Started

    Before you can connect an app built with a Couchbase SDK to Capella Analytics services, you use the Capella UI to create a project and cluster. See Create a Cluster.

    You can also use the UI to manage links and collections for different data sources and for ad hoc querying and exploration.

    Getting the Connection String

    Each Capella Analytics cluster has its own connection string. To find and copy the string:

    1. In the Capella UI, select the Capella Analytics tab.

    2. Select the cluster you want to connect to. The workbench opens.

    3. At top left, from the Capella Analytics Cluster <cluster name> list select Connection Information.

      Using the cluster name as a menu

      The Connection Information dialog opens.

    4. To copy the connection string, click it or the copy icon.

    5. When you paste in the connection string, replace the https:// protocol with couchbases://:

      couchbases://cb.<your-endpoint>.cloud.couchbase.com

    For more information, see the Connection Strings section of the Go, Java, Node.js, and Python Columnar SDKs Connections pages.