-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7861e0b
commit d0fc118
Showing
1 changed file
with
9 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,13 @@ | ||
// Package gockle simplifies and mocks github.com/gocql/gocql. | ||
// 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. | ||
// | ||
// Gockle provides the basic abilities to insert, query, and mutate data, as | ||
// well as access to basic keyspace and table metadata. | ||
// | ||
// The entry point is NewSession or NewSimpleSession. Call it to get a Session. | ||
// | ||
// A Session is the connection to the database and the primary means to access | ||
// it. It has all the query methods and the means to iterate result rows and | ||
// batch together mutations. The Session implementation simply wraps | ||
// gocql.Session and adapts a few things to have a simpler interface. | ||
// | ||
// Closing the Session closes the underlying gocql.Session, including the one | ||
// passed in with NewSimpleSession. | ||
// 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. | ||
package gockle |