godbal

README

godbal

Database Abstraction Layer (dbal) for go (now only support mysql)

Motivation

I wanted a DBAL that No ORM、No Reflect、Concurrency Save, support SQL builder following good practices and well tested code.

Requirements

Go 1.7 or above.

Installation

go get github.com/xujiajun/godbal

Supported Databases

• mysql

Getting Started

Godbal helps you build SQL queries from composable parts easily:

database, _ := godbal.NewMysql("root:123@tcp(127.0.0.1:3306)/test?charset=utf8").Open()
queryBuilder := mysql.NewQueryBuilder(database)
	sql := queryBuilder.Select("uid,username,price,flag").From("userinfo", "").SetFirstResult(0).
		SetMaxResults(3).OrderBy("uid", "DESC").GetSQL()

	fmt.Println(sql) 

Output:

SELECT uid,username,price,flag FROM userinfo ORDER BY uid DESC LIMIT 0,3

Godbal helps you get result easily:

rows, _ := queryBuilder.QueryAndGetMap()
jsonString, _ := json.Marshal(&rows)
fmt.Print(string(jsonString)) 

Output like:

 {"0":{"flag":"1","price":"111.00","uid":"6","username":"johnny2"},"1":{"flag":"1","price":"111.00","uid":"5","username":"johnny2"},"2":{"flag":"0","price":"123.99","uid":"4","username":"joe"}}

Full example:

package main

import (
	"encoding/json"
	"fmt"
	_ "github.com/go-sql-driver/mysql"
	"github.com/xujiajun/godbal"
	"github.com/xujiajun/godbal/driver/mysql"
)

func main() {
	database, err := godbal.NewMysql("root:123@tcp(127.0.0.1:3306)/test?charset=utf8").Open()
	if err != nil {
		panic(err)
	}

	err = database.Ping()
	if err != nil {
		panic(err)
	}

	queryBuilder := mysql.NewQueryBuilder(database)
	sql := queryBuilder.Select("uid,username,price,flag").From("userinfo", "").SetFirstResult(0).
		SetMaxResults(3).OrderBy("uid", "DESC").GetSQL()

	fmt.Println(sql) // SELECT uid,username,price,flag FROM userinfo ORDER BY uid DESC LIMIT 0,3

	rows, _ := queryBuilder.QueryAndGetMap()

	jsonString, _ := json.Marshal(&rows)
	fmt.Print(string(jsonString)) 
  // result like: {"0":{"flag":"1","price":"111.00","uid":"6","username":"johnny2"},"1":{"flag":"1","price":"111.00","uid":"5","username":"johnny2"},"2":{"flag":"0","price":"123.99","uid":"4","username":"joe"}}
}

More examples

• select

• insert

• delete

• update

• join

• transaction

Contributing

If you'd like to help out with the project. You can put up a Pull Request.

Author

• xujiajun

License

The godbal is open-sourced software licensed under the MIT Licensed

Documentation

Index

• func NewMysql(dataSourceName string) *mysql.Database
• type DriveManager
  • func NewDriveManager() *DriveManager
  • func (driverManager *DriveManager) GetAvailableDrivers() map[string]string
  • func (driverManager *DriveManager) GetMysqlDB(dataSourceName string) *mysql.Database

Functions

func NewMysql

func NewMysql(dataSourceName string) *mysql.Database

NewMysql is short for GetMysqlDB

Types

type DriveManager

type DriveManager struct {
	// contains filtered or unexported fields
}

DriveManager records drivers

func NewDriveManager

func NewDriveManager() *DriveManager

NewDriveManager returns a newly initialized NewDriveManager that implements DriveManager

func (*DriveManager) GetAvailableDrivers

func (driverManager *DriveManager) GetAvailableDrivers() map[string]string

GetAvailableDrivers returns available drivers

func (*DriveManager) GetMysqlDB

func (driverManager *DriveManager) GetMysqlDB(dataSourceName string) *mysql.Database

GetMysqlDB returns mysql Database