easy-cass-go

README

THIS REPOSITORY HAS BEEN ARCHIVED

When this project was first created, it was cumbersome to configure Go code to talk to Datastax Astra database. But now the Stargate Golang gRPC Client is available--I've started using it and find it to be excellent. See also the Datastax Documentation for more information on using the client.

easy-cass-go

The easy-cass-go project makes it easy for go code to connect to a Datastax Astra Cassandra database.

gocql is the defacto golang library for connecting to Apache Cassandra databases. It works great, but gets a little confusing when trying to connect a Datastax Astra database. The easycass package simplifies the necessary steps to connect to an Astra database.

Database Setup

This package requires a Datastax Astra database which is built on top of Cassandra. The free tier of the database will be more than adequate for many use cases. To create an Astra database, go to https://astra.datastax.com/ and follow the instructions to register and create a database.

After creating the database, you will also need to create a client ID and client secret in order to connect to the database--this is also done via the Astra console).

In addition to the client ID and secret, you will need a secure connect bundle file. You can download this zip file from the Astra console. Save it to a known location as you will need the full path to the file.

Basic Usage

The easiest way to get up and running is to call the easycass.GetSession() function and pass it the username, password, and path to the secure connect bundle zip. It will return a *gocql.Session that can be used normally.

package main

import (
    "log"
    "github.com/NathanBak/easy-cass-go/pkg/easycass"
)

func main() {

    // Specify the client ID and secret and the path to the secure connect bundle
    username  := "clientID"
    password  := "clientSecret"
    pathToZip := "/home/me/Downloads/secure-connect-databasename.zip"

    // This creates and returns the gocql.Session
    session, err := easycass.GetSession(username, password, pathToZip)
    if err != nil {
        log.Fatal(err)
    }
    
    // Do something neat

    // All done
    session.Close()
}

Examples

• The simplesession example connects to an Astra Database and then lists the tables in the default keyspace.
• The configuredsession example allows modification of the cluster configuration before creating the session to connect to the Astra Database and list the tables in the default keyspace.
• The fromproperties example shows how to create a cluster when it's easier to pass properties to the code than the secure connect bundle zip file. The extractprops tool can be used to extract the properties from the secure connect bundle.