A Go query builder and struct mapper.

godb - a Go query builder and struct mapper

Build Status GoDoc

godb is a simple Go query builder and struct mapper, not a full-featured ORM. godb does not manage relationships.

Initially godb was a learning project. The purpose was to improve my Go skills by doing real and usable stuff. But it could be useful for somebody else.

The documentation is as young as the code, but it exists ! You have an example (see below) showing you the main features, and more details in GoDoc : https://godoc.org/github.com/samonzeweb/godb

WARNING : it is still a young project and the public API could change.


  • Queries builder.
  • Mapping between structs and tables.
  • Mapping with nested structs.
  • Execution of custom SELECT, INSERT, UPDATE and DELETE queries with structs and slices.
  • SQL queries and durations logs.
  • Two adjustable prepared statements caches (with/without transaction).
  • RETURNING support for PostgreSQL.
  • Could by used with
    • SQLite
    • PostgreSQL
    • MySQL / MariaDB
    • MS SQL Server
    • other compatible database if you write an adapter.

I made some tests of godb on Windows and Linux, ARM (Cortex A7) and Intel x64.


go get github.com/samonzeweb/godb

Install the required driver (see tests). You cas use multiple databases if needed.


godb tests use GoConvey and at least SQLite :

go get github.com/smartystreets/goconvey
go get github.com/mattn/go-sqlite3

To run tests, go into the godb directory and executes go test ./...

SQLite tests are done with in memory database, it’s fast. You can run tests with others databases, see below.

With the exception of SQLite, all drivers are pure Go code, and does not require external dependencies.

Tests with PostgreSQL

Install the driver and set the GODB_POSTGRESQL environment variable with the PostgreSQL connection string.

go get github.com/lib/pq
GODB_POSTGRESQL="your connection string" go test ./...

Tests with MySQL / MariaDB

Install the driver and set the GODB_MYSQL environment variable with the MySQL connection string.

go get github.com/go-sql-driver/mysql
GODB_MYSQL="your connection string" go test ./...

Tests with MS SQL Server

Install the driver and set the GODB_MSSQL environment variable with the SQL Server connection string.

go get github.com/denisenkom/go-mssqldb
GODB_MSSQL="your connection string" go test ./...


The example below illustrates the main features of godb.

You can copy the code into an example.go file and run it. You need to create the database and the books table as explained in the code.

package main

import (


  To run this example, initialize a SQLite3 DB called 'library.db' and add
  a 'books' table like this :

  create table books (
  	id        integer not null primary key autoincrement,
  	title     text    not null,
  	author    text    not null,
  	published date    not null);

// Struct and its mapping
type Book struct {
	Id        int       `db:"id,key,auto"`
	Title     string    `db:"title"`
	Author    string    `db:"author"`
	Published time.Time `db:"published"`

// Optional, default if the struct name (Book)
func (*Book) TableName() string {
	return "books"

// See "group by" example
type CountByAuthor struct {
	Author string `db:"author"`
	Count  int    `db:"count"`

func main() {
	// Examples fixtures
	var authorTolkien = "J.R.R. tolkien"

	var bookTheHobbit = Book{
		Title:     "The Hobbit",
		Author:    authorTolkien,
		Published: time.Date(1937, 9, 21, 0, 0, 0, 0, time.UTC),

	var bookTheFellowshipOfTheRing = Book{
		Title:     "The Fellowship of the Ring",
		Author:    authorTolkien,
		Published: time.Date(1954, 7, 29, 0, 0, 0, 0, time.UTC),

	var bookTheTwoTowers = Book{
		Title:     "The Two Towers",
		Author:    authorTolkien,
		Published: time.Date(1954, 11, 11, 0, 0, 0, 0, time.UTC),

	var bookTheReturnOfTheKing = Book{
		Title:     "The Return of the King",
		Author:    authorTolkien,
		Published: time.Date(1955, 10, 20, 0, 0, 0, 0, time.UTC),

	var setTheLordOfTheRing = []Book{

	// Connect to the DB
	db, err := godb.Open(sqlite.Adapter, "./library.db")

	// Single insert (id will be updated)
	err = db.Insert(&bookTheHobbit).Do()

	// Multiple insert
	// Warning : BulkInsert only update ids with PostgreSQL !
	err = db.BulkInsert(&setTheLordOfTheRing).Do()

	// Count
	count, err := db.SelectFrom("books").Count()
	fmt.Println("Books count : ", count)

	// Custom select
	countByAuthor := make([]CountByAuthor, 0, 0)
	err = db.SelectFrom("books").
		Columns("author", "count(*) as count").
		Having("count(*) > 3").
	fmt.Println("Count by authors : ", countByAuthor)

	// Select single object
	singleBook := Book{}
	err = db.Select(&singleBook).
		Where("title = ?", bookTheHobbit.Title).
	if err == sql.ErrNoRows {
		// sql.ErrNoRows is only returned when the target is a single instance
		fmt.Println("Book not found !")
	} else {

	// Select multiple objects
	multipleBooks := make([]Book, 0, 0)
	err = db.Select(&multipleBooks).Do()
	fmt.Println("Books found : ", len(multipleBooks))

	// Update and transactions
	err = db.Begin()

	updated, err := db.UpdateTable("books").Set("author", "Tolkien").Do()
	fmt.Println("Books updated : ", updated)

	bookTheHobbit.Author = "Tolkien"
	updated, err = db.Update(&bookTheHobbit).Do()
	fmt.Println("Books updated : ", updated)

	err = db.Rollback()

	// Delete
	deleted, err := db.Delete(&bookTheHobbit).Do()
	fmt.Println("Books deleted : ", deleted)

	deleted, err = db.DeleteFrom("books").
			godb.Q("author = ?", authorTolkien),
			godb.Q("author = ?", "Georged Orwell"),
	fmt.Println("Books deleted : ", deleted)

	// Bye
	err = db.Close()

// It's just an example, what did you expect ?
func panicIfErr(err error) {
	if err != nil {


Released under the MIT License, see LICENSE.txt for more informations.

Related Repositories



A Go query builder and struct mapper. ...



goDB v.1.x ...



A high-level database access library for Go ...



A basic NoSQL datastore written in Go. This is for now primarily experimental and an exercise to learn the Go language. ...

Top Contributors

samonzeweb arnoldstoba FLGMwt