Files
gocqlx/README.md

22 lines
1.1 KiB
Markdown
Raw Normal View History

2017-07-24 16:59:39 +02:00
# gocqlx [![GoDoc](http://img.shields.io/badge/go-documentation-blue.svg?style=flat-square)](http://godoc.org/github.com/scylladb/gocqlx) [![Go Report Card](https://goreportcard.com/badge/github.com/scylladb/gocqlx)](https://goreportcard.com/report/github.com/scylladb/gocqlx) [![Build Status](http://img.shields.io/travis/scylladb/gocqlx.svg?style=flat-square)](https://travis-ci.org/scylladb/gocqlx)
2017-07-24 16:22:30 +02:00
Package `gocqlx` is a `gocql` extension, similar to what `sqlx` is to `database/sql`.
It provides a new type that seamlessly wraps `gocql.Iter` and provide
convenience methods which are useful in the development of database driven
applications. None of the underlying gocql.Iter methods are changed.
Instead all extended behavior is implemented through new methods defined on
wrapper type.
The wrapper type enables you to bind iterator row into a struct. Under the
hood it uses `sqlx/reflectx` package, models / structs working whit `sqlx` will
also work with `gocqlx`.
## Installation
2017-07-24 16:59:39 +02:00
go get github.com/scylladb/gocqlx
2017-07-24 16:22:30 +02:00
## Example
2017-07-24 16:59:39 +02:00
See [example test](https://github.com/scylladb/gocqlx/blob/master/example_test.go).