Skip to content
Package gocql implements a fast and robust Cassandra client for the Go programming language.
Go Shell
Branch: master
Clone or download
Zariel conn: fix race evicting statements on ErrUnPrepared (#1391)
Ensure we only remove prepared statements on ErrUnPrepared when our
cached statements ID matches the unprepared statement.
Latest commit 617765a Jan 15, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [skip-ci] fix typo Jan 13, 2018
internal murmur: fix for 32bit arch (#1326) Jun 29, 2019
testdata
.gitignore add .idea to .gitignore Mar 21, 2016
.travis.yml Test with Go 1.13 and 1.12 in CI (#1347) Sep 15, 2019
AUTHORS
CONTRIBUTING.md update README to match Travis CI Sep 15, 2016
LICENSE
README.md
address_translators.go
address_translators_test.go adding AddressTranslator interface and impl for use in ec2 Nov 3, 2016
batch_test.go run TestWriteFailure against all versions (#1203) Oct 19, 2018
cass1batch_test.go run TestWriteFailure against all versions (#1203) Oct 19, 2018
cassandra_test.go query: fixes pagination with query binding (#1363) Oct 18, 2019
cluster.go Allow setting a custom Authenticator (#1242) Nov 24, 2018
cluster_test.go
common_test.go
compressor.go
compressor_test.go run TestWriteFailure against all versions (#1203) Oct 19, 2018
conn.go
conn_test.go [feature] AWS HelenusAuthenticator (#1379) Dec 24, 2019
connectionpool.go conn: dont propogate context cancelled in prepare (#1368) Nov 6, 2019
control.go conn: dont propogate context cancelled in prepare (#1368) Nov 6, 2019
control_test.go
cqltypes.go Allow to use protocol V5 (#1165) Aug 31, 2018
debug_off.go
debug_on.go rename debug -> gocqlDebug Feb 2, 2016
doc.go Add vgo support (#1086) Apr 11, 2018
errors.go Allow to use protocol V5 (#1165) Aug 31, 2018
errors_test.go
events.go framer: remove framerpool May 22, 2018
events_ccm_test.go dont build ccm tests as they will be rewritten Oct 24, 2016
events_test.go typo fix: Debouncer Oct 19, 2016
filters.go WhiteListHostFilter: use IP.String() for the filter key (#926) Jun 27, 2017
filters_test.go
frame.go Add information about Host to FrameHeaderObserver (#1317) Jun 10, 2019
frame_test.go
framer_bench_test.go
fuzz.go
go.mod
go.sum Token aware batches (#1313) May 22, 2019
helpers.go
helpers_test.go Fix metadata tuple parsing (#1190) Sep 20, 2018
host_source.go
host_source_gen.go hostinfo: fix using default conn and overriding values (#1009) Oct 28, 2017
host_source_test.go run TestWriteFailure against all versions (#1203) Oct 19, 2018
install_test_deps.sh
integration.sh
integration_test.go Test with Go 1.13 and 1.12 in CI (#1347) Sep 15, 2019
logger.go Added ConnectTimeout for initial connections to nodes Feb 9, 2017
marshal.go Fix unmarshaling to unsigned integers (#1360) Nov 2, 2019
marshal_test.go
metadata.go
metadata_test.go add metadata for views (#1225) Jan 26, 2019
policies.go Fix ExponentialReconnectionPolicy not incrementing correctly (#1374) Nov 26, 2019
policies_test.go policy: roundrobbin should try all up hosts (#1351) Sep 22, 2019
prepared_cache.go conn: fix race evicting statements on ErrUnPrepared (#1391) Jan 15, 2020
query_executor.go
ring.go Acquire exclusive lock when updating (#1025) Nov 28, 2017
ring_test.go Fix more hostinfo (#888) Jun 24, 2017
session.go
session_connect_test.go session: improve host setup in session Oct 24, 2017
session_test.go Add attempt number to ObservedQuery (#1324) Jul 8, 2019
stress_test.go
token.go topology: replace token map with binary search (#1350) Sep 22, 2019
token_test.go
topology.go
topology_test.go
tuple_test.go marshall: correctly handle null tuple elements (#985) Sep 30, 2017
udt_test.go
uuid.go Add helpful functions for TimeUUID (#1338) Aug 10, 2019
uuid_test.go Add helpful functions for TimeUUID (#1338) Aug 10, 2019
wiki_test.go

README.md

gocql

Join the chat at https://gitter.im/gocql/gocql Build Status GoDoc

Package gocql implements a fast and robust Cassandra client for the Go programming language.

Project Website: https://gocql.github.io/
API documentation: https://godoc.org/github.com/gocql/gocql
Discussions: https://groups.google.com/forum/#!forum/gocql

Supported Versions

The following matrix shows the versions of Go and Cassandra that are tested with the integration test suite as part of the CI build:

Go/Cassandra 2.1.x 2.2.x 3.x.x
1.12 yes yes yes
1.13 yes yes yes

Gocql has been tested in production against many different versions of Cassandra. Due to limits in our CI setup we only test against the latest 3 major releases, which coincide with the official support from the Apache project.

Sunsetting Model

In general, the gocql team will focus on supporting the current and previous versions of Go. gocql may still work with older versions of Go, but official support for these versions will have been sunset.

Installation

go get github.com/gocql/gocql

Features

  • Modern Cassandra client using the native transport
  • Automatic type conversions between Cassandra and Go
    • Support for all common types including sets, lists and maps
    • Custom types can implement a Marshaler and Unmarshaler interface
    • Strict type conversions without any loss of precision
    • Built-In support for UUIDs (version 1 and 4)
  • Support for logged, unlogged and counter batches
  • Cluster management
    • Automatic reconnect on connection failures with exponential falloff
    • Round robin distribution of queries to different hosts
    • Round robin distribution of queries to different connections on a host
    • Each connection can execute up to n concurrent queries (whereby n is the limit set by the protocol version the client chooses to use)
    • Optional automatic discovery of nodes
    • Policy based connection pool with token aware and round-robin policy implementations
  • Support for password authentication
  • Iteration over paged results with configurable page size
  • Support for TLS/SSL
  • Optional frame compression (using snappy)
  • Automatic query preparation
  • Support for query tracing
  • Support for Cassandra 2.1+ binary protocol version 3
    • Support for up to 32768 streams
    • Support for tuple types
    • Support for client side timestamps by default
    • Support for UDTs via a custom marshaller or struct tags
  • Support for Cassandra 3.0+ binary protocol version 4
  • An API to access the schema metadata of a given keyspace

Performance

While the driver strives to be highly performant, there are cases where it is difficult to test and verify. The driver is built with maintainability and code readability in mind first and then performance and features, as such every now and then performance may degrade, if this occurs please report and issue and it will be looked at and remedied. The only time the driver copies data from its read buffer is when it Unmarshal's data into supplied types.

Some tips for getting more performance from the driver:

  • Use the TokenAware policy
  • Use many goroutines when doing inserts, the driver is asynchronous but provides a synchronous API, it can execute many queries concurrently
  • Tune query page size
  • Reading data from the network to unmarshal will incur a large amount of allocations, this can adversely affect the garbage collector, tune GOGC
  • Close iterators after use to recycle byte buffers

Important Default Keyspace Changes

gocql no longer supports executing "use " statements to simplify the library. The user still has the ability to define the default keyspace for connections but now the keyspace can only be defined before a session is created. Queries can still access keyspaces by indicating the keyspace in the query:

SELECT * FROM example2.table;

Example of correct usage:

	cluster := gocql.NewCluster("192.168.1.1", "192.168.1.2", "192.168.1.3")
	cluster.Keyspace = "example"
	...
	session, err := cluster.CreateSession()

Example of incorrect usage:

	cluster := gocql.NewCluster("192.168.1.1", "192.168.1.2", "192.168.1.3")
	cluster.Keyspace = "example"
	...
	session, err := cluster.CreateSession()

	if err = session.Query("use example2").Exec(); err != nil {
		log.Fatal(err)
	}

This will result in an err being returned from the session.Query line as the user is trying to execute a "use" statement.

Example

/* Before you execute the program, Launch `cqlsh` and execute:
create keyspace example with replication = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 };
create table example.tweet(timeline text, id UUID, text text, PRIMARY KEY(id));
create index on example.tweet(timeline);
*/
package main

import (
	"fmt"
	"log"

	"github.com/gocql/gocql"
)

func main() {
	// connect to the cluster
	cluster := gocql.NewCluster("192.168.1.1", "192.168.1.2", "192.168.1.3")
	cluster.Keyspace = "example"
	cluster.Consistency = gocql.Quorum
	session, _ := cluster.CreateSession()
	defer session.Close()

	// insert a tweet
	if err := session.Query(`INSERT INTO tweet (timeline, id, text) VALUES (?, ?, ?)`,
		"me", gocql.TimeUUID(), "hello world").Exec(); err != nil {
		log.Fatal(err)
	}

	var id gocql.UUID
	var text string

	/* Search for a specific set of records whose 'timeline' column matches
	 * the value 'me'. The secondary index that we created earlier will be
	 * used for optimizing the search */
	if err := session.Query(`SELECT id, text FROM tweet WHERE timeline = ? LIMIT 1`,
		"me").Consistency(gocql.One).Scan(&id, &text); err != nil {
		log.Fatal(err)
	}
	fmt.Println("Tweet:", id, text)

	// list all tweets
	iter := session.Query(`SELECT id, text FROM tweet WHERE timeline = ?`, "me").Iter()
	for iter.Scan(&id, &text) {
		fmt.Println("Tweet:", id, text)
	}
	if err := iter.Close(); err != nil {
		log.Fatal(err)
	}
}

Data Binding

There are various ways to bind application level data structures to CQL statements:

  • You can write the data binding by hand, as outlined in the Tweet example. This provides you with the greatest flexibility, but it does mean that you need to keep your application code in sync with your Cassandra schema.
  • You can dynamically marshal an entire query result into an []map[string]interface{} using the SliceMap() API. This returns a slice of row maps keyed by CQL column names. This method requires no special interaction with the gocql API, but it does require your application to be able to deal with a key value view of your data.
  • As a refinement on the SliceMap() API you can also call MapScan() which returns map[string]interface{} instances in a row by row fashion.
  • The Bind() API provides a client app with a low level mechanism to introspect query meta data and extract appropriate field values from application level data structures.
  • The gocqlx package is an idiomatic extension to gocql that provides usability features. With gocqlx you can bind the query parameters from maps and structs, use named query parameters (:identifier) and scan the query results into structs and slices. It comes with a fluent and flexible CQL query builder that supports full CQL spec, including BATCH statements and custom functions.
  • Building on top of the gocql driver, cqlr adds the ability to auto-bind a CQL iterator to a struct or to bind a struct to an INSERT statement.
  • Another external project that layers on top of gocql is cqlc which generates gocql compliant code from your Cassandra schema so that you can write type safe CQL statements in Go with a natural query syntax.
  • gocassa is an external project that layers on top of gocql to provide convenient query building and data binding.
  • gocqltable provides an ORM-style convenience layer to make CRUD operations with gocql easier.

Ecosystem

The following community maintained tools are known to integrate with gocql:

  • gocqlx is a gocql extension that automates data binding, adds named queries support, provides flexible query builders and plays well with gocql.
  • journey is a migration tool with Cassandra support.
  • negronicql is gocql middleware for Negroni.
  • cqlr adds the ability to auto-bind a CQL iterator to a struct or to bind a struct to an INSERT statement.
  • cqlc generates gocql compliant code from your Cassandra schema so that you can write type safe CQL statements in Go with a natural query syntax.
  • gocassa provides query building, adds data binding, and provides easy-to-use "recipe" tables for common query use-cases.
  • gocqltable is a wrapper around gocql that aims to simplify common operations.
  • gockle provides simple, mockable interfaces that wrap gocql types
  • scylladb is a fast Apache Cassandra-compatible NoSQL database
  • go-cql-driver is an CQL driver conforming to the built-in database/sql interface. It is good for simple use cases where the database/sql interface is wanted. The CQL driver is a wrapper around this project.

Other Projects

  • gocqldriver is the predecessor of gocql based on Go's database/sql package. This project isn't maintained anymore, because Cassandra wasn't a good fit for the traditional database/sql API. Use this package instead.

SEO

For some reason, when you Google golang cassandra, this project doesn't feature very highly in the result list. But if you Google go cassandra, then we're a bit higher up the list. So this is note to try to convince Google that golang is an alias for Go.

License

Copyright (c) 2012-2016 The gocql Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

You can’t perform that action at this time.