pixeldrain/gocqlx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md (#347)

Browse Source 
* Update README.md

1. Remove test code, replace it with production code, t.Log -> log.
2. Add import part
3. Add gocqlx instalation step

* Fix typo in installation instructions
This commit is contained in:
Dmitry Kropachev
2025-09-17 07:41:11 -04:00
committed by GitHub
parent acb61eb06f
commit ce13945e3f
1 changed files with 33 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -30,8 +30,18 @@ Subpackages provide additional functionality:
* CRUD operations based on table model ([package table](https://github.com/scylladb/gocqlx/blob/master/table)) * CRUD operations based on table model ([package table](https://github.com/scylladb/gocqlx/blob/master/table))
* Database migrations ([package migrate](https://github.com/scylladb/gocqlx/blob/master/migrate)) * Database migrations ([package migrate](https://github.com/scylladb/gocqlx/blob/master/migrate))
## Installation ## Installation GocqlX
Add GocqlX to your Go module:
```bash
go get github.com/scylladb/gocqlx/v3
```
## Installation schemagen
Unfortunately you can't install it via `go install`, since `go.mod` contains `replace` directive.
So, you have to check it out and install manually:
```bash ```bash
git clone git@github.com:scylladb/gocqlx.git git clone git@github.com:scylladb/gocqlx.git
cd gocqlx/cmd/schemagen/ cd gocqlx/cmd/schemagen/
@@ -40,16 +50,31 @@ go install .
## Getting started ## Getting started
First, import the required packages:
```go
import (
"fmt"
"log"
"github.com/gocql/gocql"
"github.com/scylladb/gocqlx/v3"
"github.com/scylladb/gocqlx/v3/qb"
"github.com/scylladb/gocqlx/v3/table"
)
```
Wrap gocql Session: Wrap gocql Session:
```go ```go
// Create gocql cluster. // Create gocql cluster.
cluster := gocql.NewCluster(hosts...) cluster := gocql.NewCluster(hosts...)
// Wrap session on creation, gocqlx session embeds gocql.Session pointer. // Wrap session on creation, gocqlx session embeds gocql.Session pointer.
session, err := gocqlx.WrapSession(cluster.CreateSession()) session, err := gocqlx.WrapSession(cluster.CreateSession())
if err != nil { if err != nil {
t.Fatal(err) log.Fatal(err)
} }
defer session.Close()
``` ```
Specify table model: Specify table model:
@@ -90,7 +115,7 @@ p := Person{
} }
q := session.Query(personTable.Insert()).BindStruct(p) q := session.Query(personTable.Insert()).BindStruct(p)
if err := q.ExecRelease(); err != nil { if err := q.ExecRelease(); err != nil {
t.Fatal(err) log.Fatal(err)
} }
``` ```
@@ -104,9 +129,9 @@ p := Person{
} }
q := session.Query(personTable.Get()).BindStruct(p) q := session.Query(personTable.Get()).BindStruct(p)
if err := q.GetRelease(&p); err != nil { if err := q.GetRelease(&p); err != nil {
t.Fatal(err) log.Fatal(err)
} }
t.Log(p) fmt.Println(p)
// stdout: {Michał Matczuk [michal@scylladb.com]} // stdout: {Michał Matczuk [michal@scylladb.com]}
``` ```
@@ -116,9 +141,9 @@ Load all rows in to a slice:
var people []Person var people []Person
q := session.Query(personTable.Select()).BindMap(qb.M{"first_name": "Michał"}) q := session.Query(personTable.Select()).BindMap(qb.M{"first_name": "Michał"})
if err := q.SelectRelease(&people); err != nil { if err := q.SelectRelease(&people); err != nil {
t.Fatal(err) log.Fatal(err)
} }
t.Log(people) fmt.Println(people)
// stdout: [{Michał Matczuk [michal@scylladb.com]}] // stdout: [{Michał Matczuk [michal@scylladb.com]}]
``` ```