Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aacanakin/qb
The database toolkit for go
https://github.com/aacanakin/qb
Last synced: 3 months ago
JSON representation
The database toolkit for go
- Host: GitHub
- URL: https://github.com/aacanakin/qb
- Owner: aacanakin
- License: lgpl-2.1
- Fork: true (slicebit/qb)
- Created: 2018-12-01T14:27:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-02T21:32:25.000Z (almost 6 years ago)
- Last Synced: 2024-06-19T05:43:15.376Z (5 months ago)
- Language: Go
- Homepage: http://qb.readme.io
- Size: 560 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- go-awesome - qb - the database toolkit for go (Open source library / Database)
README
# qb - the database toolkit for go
[](https://travis-ci.org/slicebit/qb)
[](https://coveralls.io/github/slicebit/qb?branch=master)
[](http://opensource.org/licenses/LGPL-2.1)
[](https://goreportcard.com/report/github.com/slicebit/qb)
[](http://godoc.org/github.com/slicebit/qb)
**This project is currently pre 1.**
Currently, it's not feature complete. It can have potential bugs. There are no tests covering concurrency race conditions. It can crash especially in concurrency.
Before 1.x releases, each major release could break backwards compatibility.
About qb
--------
qb is a database toolkit for easier db queries in go. It is inspired from python's best orm, namely sqlalchemy. qb is an orm(sqlx) as well as a query builder. It is quite modular in case of using just expression api and query building stuff.
[Documentation](https://qb.readme.io)
-------------
The documentation is hosted in [readme.io](https://qb.readme.io) which has great support for markdown docs. Currently, the docs are about 80% - 90% complete. The doc files will be added to this repo soon. Moreover, you can check the godoc from [here](https://godoc.org/github.com/slicebit/qb). Contributions & Feedbacks in docs are welcome.
Features
--------
- Support for postgres(9.5.+), mysql & sqlite3
- Powerful expression API for building queries & table ddls
- Struct to table ddl mapper where initial table migrations can happen
- Transactional session api that auto map structs to queries
- Foreign key definitions
- Single & Composite column indices
- Relationships (soon.. probably in 0.3 milestone)
Installation
------------
```sh
go get -u github.com/slicebit/qb
```
If you want to install test dependencies then;
```sh
go get -u -t github.com/slicebit/qb
```
Quick Start
-----------
```go
package main
import (
"fmt"
"github.com/slicebit/qb"
_ "github.com/mattn/go-sqlite3"
_ "github.com/slicebit/qb/dialects/sqlite"
)
type User struct {
ID string `db:"id"`
Email string `db:"email"`
FullName string `db:"full_name"`
Oscars int `db:"oscars"`
}
func main() {
users := qb.Table(
"users",
qb.Column("id", qb.Varchar().Size(40)),
qb.Column("email", qb.Varchar()).NotNull().Unique(),
qb.Column("full_name", qb.Varchar()).NotNull(),
qb.Column("oscars", qb.Int()).NotNull().Default(0),
qb.PrimaryKey("id"),
)
db, err := qb.New("sqlite3", "./qb_test.db")
if err != nil {
panic(err)
}
defer db.Close()
metadata := qb.MetaData()
// add table to metadata
metadata.AddTable(users)
// create all tables registered to metadata
metadata.CreateAll(db)
defer metadata.DropAll(db) // drops all tables
ins := qb.Insert(users).Values(map[string]interface{}{
"id": "b6f8bfe3-a830-441a-a097-1777e6bfae95",
"email": "[email protected]",
"full_name": "Jack Nicholson",
})
_, err = db.Exec(ins)
if err != nil {
panic(err)
}
// find user
var user User
sel := qb.Select(users.C("id"), users.C("email"), users.C("full_name")).
From(users).
Where(users.C("id").Eq("b6f8bfe3-a830-441a-a097-1777e6bfae95"))
err = db.Get(sel, &user)
fmt.Printf("%+v\n", user)
}
```
Credits
-------
- [Aras Can Akın](https://github.com/aacanakin)
- [Christophe de Vienne](https://github.com/cdevienne)
- [Onur Şentüre](https://github.com/onursenture)
- [Aaron O. Ellis](https://github.com/aodin)
- [Shawn Smith](https://github.com/shawnps)