dbless

README

go-dbless

Database library with less complexity and less modeling.

Install

go get -u github.com/ddliu/go-dbless

Usage

import (
    "github.com/ddliu/go-dbless"
    _ "github.com/ddliu/go-dbless/driver/mysql"
    _ "github.com/go-sql-driver/mysql"
)
db := dbless.Open("mysql", "dsn")

Basic

• Insert
• Update
• Delete
• GetRows
• GetRow
• Scalar

Schema

• List databases
• List tables
• List columns

Resource

package main
import github.com/ddliu/go-dbless

func main() {
    db := somedb()

    resource := dbless.Resource{
        Name: "user",
        Timestamp: true,
        DB: db,
    }

    id, err := resource.Save(dbless.Record{
        "username": "ddliu",
        "password": "123456",
    })

    user, err := record.Get(id)

    listing := resource.List(dbless.ListInput{
        Pagination: dbless.Pagination {
            PageSize: 20,
            Page: 1,
        },
    })
}

Documentation

Index

• func IsRecordNotFound(err error) bool
• func ListColumnsByQuery(db *DB, dbname, tableName string) ([]*sql.ColumnType, error)
• func ListDatabaseByQuery(db *DB, query string, name string, exclude []string) ([]string, error)
• func ListTableByQuery(db *DB, query string, name string, params ...interface{}) ([]string, error)
• func RegisterDriver(driver Driver)
• type DB
  • func New(driverName string, db *sql.DB) *DB
  • func Open(driverName, dsn string) (*DB, error)
  • func (db *DB) Delete(table string, where string, args ...interface{}) (uint64, error)
  • func (db *DB) GetPaging(pageSize uint, page uint, sql string, args ...interface{}) (*PagedRows, error)
  • func (db *DB) GetRow(sql string, args ...interface{}) (Record, error)
  • func (db *DB) GetRows(sqlStr string, args ...interface{}) ([]Record, error)
  • func (db *DB) Insert(table string, row map[string]interface{}) error
  • func (db *DB) InsertGetID(table string, row map[string]interface{}) (string, error)
  • func (db *DB) ListColumns(dbname, tablename string) ([]*sql.ColumnType, error)
  • func (db *DB) ListDatabases() ([]string, error)
  • func (db *DB) ListTables(dbname string) ([]string, error)
  • func (db *DB) Scalar(sql string, args ...interface{}) (uint64, error)
  • func (db *DB) Update(table string, row map[string]interface{}, where string, args ...interface{}) (uint64, error)
• type Driver
• type DriverNotImplementedError
  • func (e DriverNotImplementedError) Error() string
• type Field
• type Filter
  • func (f Filter) GetWhere(db *DB) (string, []interface{})
• type ListInput
• type ListOutput
• type NoDriverError
  • func (e NoDriverError) Error() string
• type PagedRows
• type Pagination
  • func NewPagination(pageSize, page uint) *Pagination
  • func (p *Pagination) GetOffsetLimit() (uint, uint)
  • func (p *Pagination) SetTotal(total uint)
  • func (p *Pagination) Valid()
• type Record
  • func (r Record) ID() string
  • func (r Record) Unmarshal(input interface{}) error
• type RecordNotFoundError
  • func (e RecordNotFoundError) Error() string
• type Resource
  • func (r Resource) Delete(filter interface{}) error
  • func (r Resource) Get(filter interface{}) (Record, error)
  • func (r Resource) List(input ListInput) (*ListOutput, error)
  • func (r Resource) Save(record Record, filter ...Filter) (string, error)

Functions

func IsRecordNotFound

func IsRecordNotFound(err error) bool

func ListColumnsByQuery

func ListColumnsByQuery(db *DB, dbname, tableName string) ([]*sql.ColumnType, error)

func ListDatabaseByQuery

func ListDatabaseByQuery(db *DB, query string, name string, exclude []string) ([]string, error)

func ListTableByQuery

func ListTableByQuery(db *DB, query string, name string, params ...interface{}) ([]string, error)

func RegisterDriver

func RegisterDriver(driver Driver)

Types

type DB

type DB struct {
	DB     *sql.DB
	Driver Driver
	Debug  bool
}

func New

func New(driverName string, db *sql.DB) *DB

func Open

func Open(driverName, dsn string) (*DB, error)

func (*DB) Delete

func (db *DB) Delete(table string, where string, args ...interface{}) (uint64, error)

func (*DB) GetPaging

func (db *DB) GetPaging(pageSize uint, page uint, sql string, args ...interface{}) (*PagedRows, error)

func (*DB) GetRow

func (db *DB) GetRow(sql string, args ...interface{}) (Record, error)

func (*DB) GetRows

func (db *DB) GetRows(sqlStr string, args ...interface{}) ([]Record, error)

func (*DB) Insert

func (db *DB) Insert(table string, row map[string]interface{}) error

func (*DB) InsertGetID

func (db *DB) InsertGetID(table string, row map[string]interface{}) (string, error)

func (*DB) ListColumns

func (db *DB) ListColumns(dbname, tablename string) ([]*sql.ColumnType, error)

func (*DB) ListDatabases

func (db *DB) ListDatabases() ([]string, error)

func (*DB) ListTables

func (db *DB) ListTables(dbname string) ([]string, error)

func (*DB) Scalar

func (db *DB) Scalar(sql string, args ...interface{}) (uint64, error)

func (*DB) Update

func (db *DB) Update(table string, row map[string]interface{}, where string, args ...interface{}) (uint64, error)

type Driver

type Driver interface {
	Name() string
	QuoteIdentifier(string) string
	Placeholder(values []interface{}) []string
	ListDatabases(db *DB) ([]string, error)
	ListTables(db *DB, dbname string) ([]string, error)
	ListColumns(db *DB, dbname string, tablename string) ([]*sql.ColumnType, error)
	ScanReceiver(t *sql.ColumnType) (interface{}, error)
}

type DriverNotImplementedError

type DriverNotImplementedError struct {
}

func (DriverNotImplementedError) Error

func (e DriverNotImplementedError) Error() string

type Field

type Field struct {
	Name        string `json:"name"`
	Title       string `json:"title"`
	Description string `json:"description"`
	Meta        string `json:"meta"`
}

type Filter

type Filter map[string]interface{}

func (Filter) GetWhere

func (f Filter) GetWhere(db *DB) (string, []interface{})

type ListInput

type ListInput struct {
	Pagination Pagination `json: "pagination"`
	Filter     Filter     `json:"filter"`
}

type ListOutput

type ListOutput struct {
	Pagination
	List []Record `json:"list"`
}

type NoDriverError

type NoDriverError struct {
}

func (NoDriverError) Error

func (e NoDriverError) Error() string

type PagedRows

type PagedRows struct {
	Pagination
	List []Record `json:"list"`
}

type Pagination

type Pagination struct {
	PageSize  uint `json:"page_size"`
	Page      uint `json:"page"`
	PageTotal uint `json:"page_total"`
	Total     uint `json:"total"`
}

func NewPagination

func NewPagination(pageSize, page uint) *Pagination

func (*Pagination) GetOffsetLimit

func (p *Pagination) GetOffsetLimit() (uint, uint)

func (*Pagination) SetTotal

func (p *Pagination) SetTotal(total uint)

func (*Pagination) Valid

func (p *Pagination) Valid()

type Record

type Record map[string]interface{}

func (Record) ID

func (r Record) ID() string

func (Record) Unmarshal

func (r Record) Unmarshal(input interface{}) error

type RecordNotFoundError

type RecordNotFoundError struct {
}

func (RecordNotFoundError) Error

func (e RecordNotFoundError) Error() string

type Resource

type Resource struct {
	Name      string  `json:"name"`
	Title     string  `json:"title"`
	Fields    []Field `json:"fields"`
	Timestamp bool    `json:"timestamp"`
	Meta      string  `json:"meta"`
	DB        *DB     `json:"-"`
}

func (Resource) Delete

func (r Resource) Delete(filter interface{}) error

func (Resource) Get

func (r Resource) Get(filter interface{}) (Record, error)

func (Resource) List

func (r Resource) List(input ListInput) (*ListOutput, error)

func (Resource) Save

func (r Resource) Save(record Record, filter ...Filter) (string, error)