diff --git a/README.md b/README.md index ab2af0c..ddc93f8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ # gockle -[![Go Reference](https://pkg.go.dev/badge/github.com/willfaught/gockle.svg)](https://pkg.go.dev/github.com/willfaught/gockle) +Package gockle simplifies and mocks github.com/gocql/gocql. It provides simple interfaces to insert, query, and mutate Cassandra data, as well as get basic keyspace and table metadata. -*Note: Test coverage is low because there is no Cassandra database for the tests to use. Providing one yields 97.37% test coverage. Some code is uncovered because gocql cannot be mocked. This is one difficulty your code avoids by using gockle.* +The entry points are NewSession and NewSimpleSession. Call them to get a Session. Session interacts with the database. It executes queries and batched queries and iterates result rows. Closing the Session closes the underlying gocql.Session, including the one passed to NewSimpleSession. + +Mocks are provided for testing use of Batch, Iterator, and Session. + +Tx is short for transaction. + +The name gockle comes from a pronunciation of gocql. + +Note: Test coverage is low because there is no Cassandra database for the tests to use. Providing one yields 97.37% test coverage. Some code is uncovered because gocql cannot be mocked. This is one difficulty your code avoids by using gockle.