xorm

package module
v0.0.0-...-8fc1c82 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2018 License: BSD-3-Clause Imports: 27 Imported by: 8

README

中文

Xorm is a simple and powerful ORM for Go.

Gitter

Build Status

Notice

The last master version is not backwards compatible. You should use engine.ShowSQL() and engine.Logger().SetLevel() instead of engine.ShowSQL = , engine.ShowInfo = and so on.

Features

  • Struct <-> Table Mapping Support

  • Chainable APIs

  • Transaction Support

  • Both ORM and raw SQL operation Support

  • Sync database schema Support

  • Query Cache speed up

  • Database Reverse support, See Xorm Tool README

  • Simple cascade loading support

  • Optimistic Locking support

  • SQL Builder support via github.com/coscms/xorm/builder

Drivers Support

Drivers for Go's sql package which currently support database/sql includes:

Changelog

  • v0.6.0

    • remove support for ql
    • add query condition builder support via github.com/coscms/xorm/builder, so Where, And, Or methods can use builder.Cond as parameter
    • add Sum, SumInt, SumInt64 and NotIn methods
    • some bugs fixed
  • v0.5.0

    • logging interface changed
    • some bugs fixed
  • v0.4.5

    • many bugs fixed
    • extends support unlimited deepth
    • Delete Limit support
  • v0.4.4

    • ql database expriment support
    • tidb database expriment support
    • sql.NullString and etc. field support
    • select ForUpdate support
    • many bugs fixed

More changes ...

Installation

If you have gopm installed,

gopm get github.com/coscms/xorm

Or

go get github.com/coscms/xorm

Documents

Quick Start

  • Create Engine
engine, err := xorm.NewEngine(driverName, dataSourceName)
  • Define a struct and Sync2 table struct to database
type User struct {
    Id int64
    Name string
    Salt string
    Age int
    Passwd string `xorm:"varchar(200)"`
    Created time.Time `xorm:"created"`
    Updated time.Time `xorm:"updated"`
}

err := engine.Sync2(new(User))
  • Query a SQL string, the returned results is []map[string][]byte
results, err := engine.Query("select * from user")
  • Execute a SQL string, the returned results
affected, err := engine.Exec("update user set age = ? where name = ?", age, name)
  • Insert one or multiple records to database
affected, err := engine.Insert(&user)
// INSERT INTO struct () values ()
affected, err := engine.Insert(&user1, &user2)
// INSERT INTO struct1 () values ()
// INSERT INTO struct2 () values ()
affected, err := engine.Insert(&users)
// INSERT INTO struct () values (),(),()
affected, err := engine.Insert(&user1, &users)
// INSERT INTO struct1 () values ()
// INSERT INTO struct2 () values (),(),()
  • Query one record from database
has, err := engine.Get(&user)
// SELECT * FROM user LIMIT 1
has, err := engine.Where("name = ?", name).Desc("id").Get(&user)
// SELECT * FROM user WHERE name = ? ORDER BY id DESC LIMIT 1
  • Query multiple records from database, also you can use join and extends
var users []User
err := engine.Where("name = ?", name).And("age > 10").Limit(10, 0).Find(&users)
// SELECT * FROM user WHERE name = ? AND age > 10 limit 0 offset 10

type Detail struct {
    Id int64
    UserId int64 `xorm:"index"`
}

type UserDetail struct {
    User `xorm:"extends"`
    Detail `xorm:"extends"`
}

var users []UserDetail
err := engine.Table("user").Select("user.*, detail.*")
    Join("INNER", "detail", "detail.user_id = user.id").
    Where("user.name = ?", name).Limit(10, 0).
    Find(&users)
// SELECT user.*, detail.* FROM user INNER JOIN detail WHERE user.name = ? limit 0 offset 10
  • Query multiple records and record by record handle, there are two methods Iterate and Rows
err := engine.Iterate(&User{Name:name}, func(idx int, bean interface{}) error {
    user := bean.(*User)
    return nil
})
// SELECT * FROM user

rows, err := engine.Rows(&User{Name:name})
// SELECT * FROM user
defer rows.Close()
bean := new(Struct)
for rows.Next() {
    err = rows.Scan(bean)
}
  • Update one or more records, default will update non-empty and non-zero fields except when you use Cols, AllCols and so on.
affected, err := engine.Id(1).Update(&user)
// UPDATE user SET ... Where id = ?

affected, err := engine.Update(&user, &User{Name:name})
// UPDATE user SET ... Where name = ?

var ids = []int64{1, 2, 3}
affected, err := engine.In("id", ids).Update(&user)
// UPDATE user SET ... Where id IN (?, ?, ?)

// force update indicated columns by Cols
affected, err := engine.Id(1).Cols("age").Update(&User{Name:name, Age: 12})
// UPDATE user SET age = ?, updated=? Where id = ?

// force NOT update indicated columns by Omit
affected, err := engine.Id(1).Omit("name").Update(&User{Name:name, Age: 12})
// UPDATE user SET age = ?, updated=? Where id = ?

affected, err := engine.Id(1).AllCols().Update(&user)
// UPDATE user SET name=?,age=?,salt=?,passwd=?,updated=? Where id = ?
  • Delete one or more records, Delete MUST have condition
affected, err := engine.Where(...).Delete(&user)
// DELETE FROM user Where ...
affected, err := engine.Id(2).Delete(&user)
  • Count records
counts, err := engine.Count(&user)
// SELECT count(*) AS total FROM user
  • Query conditions builder
err := engine.Where(builder.NotIn("a", 1, 2).And(builder.In("b", "c", "d", "e"))).Find(&users)
// SELECT id, name ... FROM user WHERE a NOT IN (?, ?) AND b IN (?, ?, ?)

Cases

Discuss

Please visit Xorm on Google Groups

Contributing

If you want to pull request, please see CONTRIBUTING

LICENSE

BSD License http://creativecommons.org/licenses/BSD/

Documentation

Overview

Package xorm is a simple and powerful ORM for Go.

Installation

Make sure you have installed Go 1.1+ and then:

go get github.com/coscms/xorm

Create Engine

Firstly, we should new an engine for a database

engine, err := xorm.NewEngine(driverName, dataSourceName)

Method NewEngine's parameters is the same as sql.Open. It depends drivers' implementation. Generally, one engine for an application is enough. You can set it as package variable.

Raw Methods

Xorm also support raw sql execution:

1. query a SQL string, the returned results is []map[string][]byte

results, err := engine.Query("select * from user")

2. execute a SQL string, the returned results

affected, err := engine.Exec("update user set .... where ...")

ORM Methods

There are 7 major ORM methods and many helpful methods to use to operate database.

1. Insert one or multipe records to database

affected, err := engine.Insert(&struct)
// INSERT INTO struct () values ()
affected, err := engine.Insert(&struct1, &struct2)
// INSERT INTO struct1 () values ()
// INSERT INTO struct2 () values ()
affected, err := engine.Insert(&sliceOfStruct)
// INSERT INTO struct () values (),(),()
affected, err := engine.Insert(&struct1, &sliceOfStruct2)
// INSERT INTO struct1 () values ()
// INSERT INTO struct2 () values (),(),()

2. Query one record from database

has, err := engine.Get(&user)
// SELECT * FROM user LIMIT 1

3. Query multiple records from database

sliceOfStructs := new(Struct)
err := engine.Find(sliceOfStructs)
// SELECT * FROM user

4. Query multiple records and record by record handle, there two methods, one is Iterate, another is Rows

err := engine.Iterate(...)
// SELECT * FROM user

rows, err := engine.Rows(...)
// SELECT * FROM user
defer rows.Close()
bean := new(Struct)
for rows.Next() {
    err = rows.Scan(bean)
}

5. Update one or more records

affected, err := engine.Id(...).Update(&user)
// UPDATE user SET ...

6. Delete one or more records, Delete MUST has conditon

affected, err := engine.Where(...).Delete(&user)
// DELETE FROM user Where ...

7. Count records

counts, err := engine.Count(&user)
// SELECT count(*) AS total FROM user

Conditions

The above 7 methods could use with condition methods chainable. Attention: the above 7 methods should be the last chainable method.

1. Id, In

engine.Id(1).Get(&user) // for single primary key
// SELECT * FROM user WHERE id = 1
engine.Id(core.PK{1, 2}).Get(&user) // for composite primary keys
// SELECT * FROM user WHERE id1 = 1 AND id2 = 2
engine.In("id", 1, 2, 3).Find(&users)
// SELECT * FROM user WHERE id IN (1, 2, 3)
engine.In("id", []int{1, 2, 3})
// SELECT * FROM user WHERE id IN (1, 2, 3)

2. Where, And, Or

engine.Where().And().Or().Find()
// SELECT * FROM user WHERE (.. AND ..) OR ...

3. OrderBy, Asc, Desc

engine.Asc().Desc().Find()
// SELECT * FROM user ORDER BY .. ASC, .. DESC
engine.OrderBy().Find()
// SELECT * FROM user ORDER BY ..

4. Limit, Top

engine.Limit().Find()
// SELECT * FROM user LIMIT .. OFFSET ..
engine.Top(5).Find()
// SELECT TOP 5 * FROM user // for mssql
// SELECT * FROM user LIMIT .. OFFSET 0 //for other databases

5. Sql, let you custom SQL

var users []User
engine.Sql("select * from user").Find(&users)

6. Cols, Omit, Distinct

var users []*User
engine.Cols("col1, col2").Find(&users)
// SELECT col1, col2 FROM user
engine.Cols("col1", "col2").Where().Update(user)
// UPDATE user set col1 = ?, col2 = ? Where ...
engine.Omit("col1").Find(&users)
// SELECT col2, col3 FROM user
engine.Omit("col1").Insert(&user)
// INSERT INTO table (non-col1) VALUES ()
engine.Distinct("col1").Find(&users)
// SELECT DISTINCT col1 FROM user

7. Join, GroupBy, Having

engine.GroupBy("name").Having("name='xlw'").Find(&users)
//SELECT * FROM user GROUP BY name HAVING name='xlw'
engine.Join("LEFT", "userdetail", "user.id=userdetail.id").Find(&users)
//SELECT * FROM user LEFT JOIN userdetail ON user.id=userdetail.id

More usage, please visit http://xorm.io/docs

Index

Constants

View Source
const (
	DEFAULT_LOG_PREFIX = "[xorm]"
	DEFAULT_LOG_FLAG   = log.Ldate | log.Lmicroseconds
	DEFAULT_LOG_LEVEL  = core.LOG_DEBUG
)
View Source
const (
	// Version show the xorm's version
	Version string = "0.6.0.0923"
)

Variables

View Source
var (
	ErrParamsType      error = errors.New("Params type error")
	ErrTableNotFound   error = errors.New("Not found table")
	ErrUnSupportedType error = errors.New("Unsupported type error")
	ErrNotExist        error = errors.New("Not exist error")
	ErrCacheFailed     error = errors.New("Cache failed")
	ErrNeedDeletedCond error = errors.New("Delete need at least one condition")
	ErrNotImplemented  error = errors.New("Not implemented.")
)

Functions

func AddCSlashes

func AddCSlashes(s string, b ...rune) string

func AddSlashes

func AddSlashes(s string, args ...rune) string

func BuildSqlResult

func BuildSqlResult(sqlStr string, args interface{}) string

替换sql中的占位符

func NewJoinParam

func NewJoinParam(stmt *Statement) *joinParam

func RowProcessing

func RowProcessing(rows *core.Rows, fields []string, fn func(data *reflect.Value, index int, fieldName string) error) (err error)

获取一行中每一列reflect.Value数据

func StrRowProcessing

func StrRowProcessing(rows *core.Rows, fields []string, fn func(data string, index int, fieldName string)) (err error)

获取一行中每一列字符串数据

Types

type AdmpubLogger

type AdmpubLogger struct {
	*log.Logger
	// contains filtered or unexported fields
}

AdmpubLogger is the default implment of core.ILogger

func NewAdmpubLogger

func NewAdmpubLogger(args ...*log.Logger) *AdmpubLogger

func NewAdmpubLoggerWithPrefix

func NewAdmpubLoggerWithPrefix(prefix string, args ...*log.Logger) *AdmpubLogger

func (*AdmpubLogger) IsShowSQL

func (s *AdmpubLogger) IsShowSQL() bool

IsShowSQL implement core.ILogger

func (*AdmpubLogger) Level

func (s *AdmpubLogger) Level() core.LogLevel

Level implement core.ILogger

func (*AdmpubLogger) SetLevel

func (s *AdmpubLogger) SetLevel(l core.LogLevel)

SetLevel implement core.ILogger

func (*AdmpubLogger) ShowSQL

func (s *AdmpubLogger) ShowSQL(show ...bool)

ShowSQL implement core.ILogger

type AfterDeleteProcessor

type AfterDeleteProcessor interface {
	AfterDelete()
}

Executed after an object has been deleted

type AfterInsertProcessor

type AfterInsertProcessor interface {
	AfterInsert()
}

Executed after an object is persisted to the database

type AfterSetProcessor

type AfterSetProcessor interface {
	AfterSet(string, Cell)
}

type AfterUpdateProcessor

type AfterUpdateProcessor interface {
	AfterUpdate()
}

Executed after an object has been updated

type BeforeDeleteProcessor

type BeforeDeleteProcessor interface {
	BeforeDelete()
}

Executed before an object is deleted

type BeforeInsertProcessor

type BeforeInsertProcessor interface {
	BeforeInsert()
}

Executed before an object is initially persisted to the database

type BeforeSetProcessor

type BeforeSetProcessor interface {
	BeforeSet(string, Cell)
}

type BeforeUpdateProcessor

type BeforeUpdateProcessor interface {
	BeforeUpdate()
}

Executed before an object is updated

type CLogger

type CLogger struct {
	Name      string
	Disabled  bool
	Processor func(tag string, format string, args []interface{}) (string, []interface{})
	Logger    core.ILogger
}

func (*CLogger) Debug

func (c *CLogger) Debug(v ...interface{})

func (*CLogger) Debugf

func (c *CLogger) Debugf(format string, v ...interface{})

func (*CLogger) Error

func (c *CLogger) Error(v ...interface{})

func (*CLogger) Errorf

func (c *CLogger) Errorf(format string, v ...interface{})

func (*CLogger) Info

func (c *CLogger) Info(v ...interface{})

func (*CLogger) Infof

func (c *CLogger) Infof(format string, v ...interface{})

func (*CLogger) Warn

func (c *CLogger) Warn(v ...interface{})

func (*CLogger) Warnf

func (c *CLogger) Warnf(format string, v ...interface{})

type Cell

type Cell *interface{}

Cell cell is a result of one column field

type DiscardLogger

type DiscardLogger struct{}

func (DiscardLogger) Debug

func (DiscardLogger) Debug(v ...interface{})

func (DiscardLogger) Debugf

func (DiscardLogger) Debugf(format string, v ...interface{})

func (DiscardLogger) Error

func (DiscardLogger) Error(v ...interface{})

func (DiscardLogger) Errorf

func (DiscardLogger) Errorf(format string, v ...interface{})

func (DiscardLogger) Info

func (DiscardLogger) Info(v ...interface{})

func (DiscardLogger) Infof

func (DiscardLogger) Infof(format string, v ...interface{})

func (DiscardLogger) IsShowSQL

func (DiscardLogger) IsShowSQL() bool

func (DiscardLogger) Level

func (DiscardLogger) Level() core.LogLevel

func (DiscardLogger) SetLevel

func (DiscardLogger) SetLevel(l core.LogLevel)

func (DiscardLogger) ShowSQL

func (DiscardLogger) ShowSQL(show ...bool)

func (DiscardLogger) Warn

func (DiscardLogger) Warn(v ...interface{})

func (DiscardLogger) Warnf

func (DiscardLogger) Warnf(format string, v ...interface{})

type Engine

type Engine struct {
	ColumnMapper  core.IMapper
	TableMapper   core.IMapper
	TagIdentifier string
	Tables        map[reflect.Type]*core.Table

	Cacher core.Cacher

	TZLocation *time.Location
	DatabaseTZ *time.Location // The timezone of the database

	//[SWH|+]
	TablePrefix        string
	TableSuffix        string
	RelTagIdentifier   string
	AliasTagIdentifier string
	TLogger            *TLogger
	// contains filtered or unexported fields
}

Engine is the major struct of xorm, it means a database manager. Commonly, an application only need one engine

func NewEngine

func NewEngine(driverName string, dataSourceName string) (*Engine, error)

NewEngine new a db manager according to the parameter. Currently support four drivers

func (*Engine) After

func (engine *Engine) After(closures func(interface{})) *Session

After apply after insert Processor, affected bean is passed to closure arg

func (*Engine) Alias

func (engine *Engine) Alias(alias string) *Session

Alias set the table alias

func (*Engine) AllCols

func (engine *Engine) AllCols() *Session

AllCols indicates that all columns should be use

func (*Engine) Asc

func (engine *Engine) Asc(colNames ...string) *Session

Asc will generate "ORDER BY column1,column2 Asc" This method can chainable use.

engine.Desc("name").Asc("age").Find(&users)
// SELECT * FROM user ORDER BY name DESC, age ASC

func (*Engine) AutoIncrStr

func (engine *Engine) AutoIncrStr() string

AutoIncrStr Database's autoincrement statement

func (*Engine) Before

func (engine *Engine) Before(closures func(interface{})) *Session

Before apply before Processor, affected bean is passed to closure arg

func (*Engine) Cascade

func (engine *Engine) Cascade(trueOrFalse ...bool) *Session

Cascade use cascade or not

func (*Engine) Charset

func (engine *Engine) Charset(charset string) *Session

Charset set charset when create table, only support mysql now

func (*Engine) ClearCache

func (engine *Engine) ClearCache(beans ...interface{}) error

ClearCache if enabled cache, clear some tables' cache

func (*Engine) ClearCacheBean

func (engine *Engine) ClearCacheBean(bean interface{}, id string) error

ClearCacheBean if enabled cache, clear the cache bean

func (*Engine) Clone

func (engine *Engine) Clone() (*Engine, error)

Clone clone an engine

func (*Engine) Close

func (engine *Engine) Close() error

Close the engine

func (*Engine) CloseLog

func (engine *Engine) CloseLog(types ...string)

func (*Engine) Cols

func (engine *Engine) Cols(columns ...string) *Session

Cols only use the paramters as select or update columns

func (*Engine) Count

func (engine *Engine) Count(bean interface{}) (int64, error)

Count counts the records. bean's non-empty fields are conditions.

func (*Engine) CreateIndexes

func (engine *Engine) CreateIndexes(bean interface{}) error

CreateIndexes create indexes

func (*Engine) CreateTables

func (engine *Engine) CreateTables(beans ...interface{}) error

CreateTables create tabls according bean

func (*Engine) CreateUniques

func (engine *Engine) CreateUniques(bean interface{}) error

CreateUniques create uniques

func (*Engine) DB

func (engine *Engine) DB() *core.DB

DB return the wrapper of sql.DB

func (*Engine) DBMetas

func (engine *Engine) DBMetas() ([]*core.Table, error)

DBMetas Retrieve all tables, columns, indexes' informations from database.

func (*Engine) DataSourceName

func (engine *Engine) DataSourceName() string

DataSourceName return the current connection string

func (*Engine) Decr

func (engine *Engine) Decr(column string, arg ...interface{}) *Session

Decr provides a update string like "column = column - ?"

func (*Engine) Delete

func (engine *Engine) Delete(bean interface{}) (int64, error)

Delete records, bean's non-empty fields are conditions

func (*Engine) Desc

func (engine *Engine) Desc(colNames ...string) *Session

Desc will generate "ORDER BY column1 DESC, column2 DESC"

func (*Engine) Dialect

func (engine *Engine) Dialect() core.Dialect

Dialect return database dialect

func (*Engine) Distinct

func (engine *Engine) Distinct(columns ...string) *Session

Distinct use for distinct columns. Caution: when you are using cache, distinct will not be cached because cache system need id, but distinct will not provide id

func (*Engine) DriverName

func (engine *Engine) DriverName() string

DriverName return the current sql driver's name

func (*Engine) DropIndexes

func (engine *Engine) DropIndexes(bean interface{}) error

DropIndexes drop indexes

func (*Engine) DropTables

func (engine *Engine) DropTables(beans ...interface{}) error

DropTables drop specify tables

func (*Engine) DumpAll

func (engine *Engine) DumpAll(w io.Writer) error

DumpAll dump database all table structs and data to w

func (*Engine) DumpAllToFile

func (engine *Engine) DumpAllToFile(fp string) error

DumpAllToFile dump database all table structs and data to a file

func (*Engine) DumpTables

func (engine *Engine) DumpTables(tables []*core.Table, w io.Writer, tp ...core.DbType) error

DumpTables dump specify tables to io.Writer

func (*Engine) DumpTablesToFile

func (engine *Engine) DumpTablesToFile(tables []*core.Table, fp string, tp ...core.DbType) error

DumpTablesToFile dump specified tables to SQL file.

func (*Engine) Exec

func (engine *Engine) Exec(sql string, args ...interface{}) (sql.Result, error)

Exec raw sql

func (*Engine) Find

func (engine *Engine) Find(beans interface{}, condiBeans ...interface{}) error

Find retrieve records from table, condiBeans's non-empty fields are conditions. beans could be []Struct, []*Struct, map[int64]Struct map[int64]*Struct

func (*Engine) FormatTime

func (engine *Engine) FormatTime(sqlTypeName string, t time.Time) (v interface{})

FormatTime format time

func (*Engine) Get

func (engine *Engine) Get(bean interface{}) (bool, error)

Get retrieve one record from table, bean's non-empty fields are conditions

func (*Engine) GetOne

func (this *Engine) GetOne(sql string, params ...interface{}) (result string)

func (*Engine) GetRow

func (this *Engine) GetRow(sql string, params ...interface{}) (result *ResultSet)

func (*Engine) GetRows

func (this *Engine) GetRows(sql string, params ...interface{}) []*ResultSet

----------------------- ResultSet结果 -----------------------

func (*Engine) GobRegister

func (engine *Engine) GobRegister(v interface{}) *Engine

GobRegister register one struct to gob for cache use

func (*Engine) GroupBy

func (engine *Engine) GroupBy(keys string) *Session

GroupBy generate group by statement

func (*Engine) Having

func (engine *Engine) Having(conditions string) *Session

Having generate having statement

func (*Engine) ID

func (engine *Engine) ID(id interface{}) *Session

ID mehtod provoide a condition as (id) = ?

func (*Engine) Id

func (engine *Engine) Id(id interface{}) *Session

Id will be depracated, please use ID instead

func (*Engine) IdOf

func (engine *Engine) IdOf(bean interface{}) core.PK

IdOf get id from one struct

func (*Engine) IdOfV

func (engine *Engine) IdOfV(rv reflect.Value) core.PK

IdOfV get id from one value of struct

func (*Engine) Import

func (engine *Engine) Import(r io.Reader) ([]sql.Result, error)

Import SQL DDL from io.Reader

func (*Engine) ImportFile

func (engine *Engine) ImportFile(ddlPath string) ([]sql.Result, error)

ImportFile SQL DDL file

func (*Engine) In

func (engine *Engine) In(column string, args ...interface{}) *Session

In will generate "column IN (?, ?)"

func (*Engine) Incr

func (engine *Engine) Incr(column string, arg ...interface{}) *Session

Incr provides a update string like "column = column + ?"

func (*Engine) Init

func (engine *Engine) Init()

func (*Engine) Insert

func (engine *Engine) Insert(beans ...interface{}) (int64, error)

Insert one or more records

func (*Engine) InsertMulti

func (engine *Engine) InsertMulti(beans interface{}) (int64, error)

InsertMulti Insert more records

func (*Engine) InsertOne

func (engine *Engine) InsertOne(bean interface{}) (int64, error)

InsertOne insert only one record

func (*Engine) IsTableEmpty

func (engine *Engine) IsTableEmpty(bean interface{}) (bool, error)

IsTableEmpty if a table has any reocrd

func (*Engine) IsTableExist

func (engine *Engine) IsTableExist(beanOrTableName interface{}) (bool, error)

IsTableExist if a table is exist

func (*Engine) Iterate

func (engine *Engine) Iterate(bean interface{}, fun IterFunc) error

Iterate record by record handle records from table, bean's non-empty fields are conditions.

func (*Engine) Join

func (engine *Engine) Join(joinOperator string, tablename interface{}, condition string, args ...interface{}) *Session

Join the join_operator should be one of INNER, LEFT OUTER, CROSS etc - this will be prepended to JOIN

func (*Engine) Limit

func (engine *Engine) Limit(limit int, start ...int) *Session

Limit will generate "LIMIT start, limit"

func (*Engine) Logger

func (engine *Engine) Logger() core.ILogger

Logger return the logger interface

func (*Engine) MapCacher

func (engine *Engine) MapCacher(bean interface{}, cacher core.Cacher)

MapCacher Set a table use a special cacher

func (*Engine) MustCols

func (engine *Engine) MustCols(columns ...string) *Session

MustCols specify some columns must use even if they are empty

func (*Engine) NewDB

func (engine *Engine) NewDB() (*core.DB, error)

NewDB provides an interface to operate database directly

func (*Engine) NewSession

func (engine *Engine) NewSession() *Session

NewSession New a session

func (*Engine) NoAutoCondition

func (engine *Engine) NoAutoCondition(no ...bool) *Session

NoAutoCondition disable auto generate Where condition from bean or not

func (*Engine) NoAutoTime

func (engine *Engine) NoAutoTime() *Session

NoAutoTime Default if your struct has "created" or "updated" filed tag, the fields will automatically be filled with current time when Insert or Update invoked. Call NoAutoTime if you dont' want to fill automatically.

func (*Engine) NoCache

func (engine *Engine) NoCache() *Session

NoCache If you has set default cacher, and you want temporilly stop use cache, you can use NoCache()

func (*Engine) NoCascade

func (engine *Engine) NoCascade() *Session

NoCascade If you do not want to auto cascade load object

func (*Engine) NowTime

func (engine *Engine) NowTime(sqlTypeName string) interface{}

NowTime return current time

func (*Engine) NowTime2

func (engine *Engine) NowTime2(sqlTypeName string) (interface{}, time.Time)

NowTime2 return current time

func (*Engine) Nullable

func (engine *Engine) Nullable(columns ...string) *Session

Nullable set null when column is zero-value and nullable for update

func (*Engine) Omit

func (engine *Engine) Omit(columns ...string) *Session

Omit only not use the paramters as select or update columns

func (*Engine) OpenLog

func (engine *Engine) OpenLog(types ...string)

func (*Engine) OrderBy

func (engine *Engine) OrderBy(order string) *Session

OrderBy will generate "ORDER BY order"

func (*Engine) Ping

func (engine *Engine) Ping() error

Ping tests if database is alive

func (*Engine) Query

func (engine *Engine) Query(sql string, paramStr ...interface{}) (resultsSlice []map[string][]byte, err error)

Query a raw sql and return records as []map[string][]byte

func (*Engine) QueryRaw

func (this *Engine) QueryRaw(sql string, params ...interface{}) []map[string]interface{}

func (*Engine) QueryStr

func (this *Engine) QueryStr(sql string, params ...interface{}) []map[string]string

func (*Engine) Quote

func (engine *Engine) Quote(sql string) string

Quote Use QuoteStr quote the string sql

func (*Engine) QuoteKey

func (this *Engine) QuoteKey(s string) string

func (*Engine) QuoteStr

func (engine *Engine) QuoteStr() string

QuoteStr Engine's database use which charactor as quote. mysql, sqlite use ` and postgres use "

func (*Engine) QuoteValue

func (this *Engine) QuoteValue(s string) string

func (*Engine) QuoteWithDelim

func (engine *Engine) QuoteWithDelim(s, d string) string

func (*Engine) RawBatchInsert

func (this *Engine) RawBatchInsert(table string, multiSets []map[string]interface{}) (stdSQL.Result, error)

func (*Engine) RawDelete

func (this *Engine) RawDelete(table string, where string, params ...interface{}) (int64, error)

func (*Engine) RawExec

func (this *Engine) RawExec(sql string, retId bool, params ...interface{}) (affected int64, err error)

func (*Engine) RawExecr

func (this *Engine) RawExecr(sql string, params ...interface{}) (result stdSQL.Result, err error)

func (*Engine) RawFetch

func (this *Engine) RawFetch(fields string, table string, where string, params ...interface{}) (result map[string]string)

func (*Engine) RawFetchAll

func (this *Engine) RawFetchAll(fields string, table string, where string, params ...interface{}) []map[string]string

----------------------- map结果 -----------------------

func (*Engine) RawInsert

func (this *Engine) RawInsert(table string, sets map[string]interface{}) (lastId int64, err error)

RawInsert insert

func (*Engine) RawOnlyInsert

func (this *Engine) RawOnlyInsert(table string, sets map[string]interface{}) (stdSQL.Result, error)

func (*Engine) RawQuery

func (this *Engine) RawQuery(sql string, params ...interface{}) (resultsSlice []*ResultSet, err error)

======================= 原生SQL查询 =======================

func (*Engine) RawQueryAllKvs

func (this *Engine) RawQueryAllKvs(key string, sql string, params ...interface{}) map[string][]map[string]string

func (*Engine) RawQueryCallback

func (this *Engine) RawQueryCallback(callback func(*core.Rows, []string), sql string, params ...interface{}) (err error)

func (*Engine) RawQueryKv

func (this *Engine) RawQueryKv(key string, val string, sql string, params ...interface{}) map[string]string

*

  • 查询键值对

func (*Engine) RawQueryKvs

func (this *Engine) RawQueryKvs(key string, sql string, params ...interface{}) map[string]map[string]string

*

  • 查询基于指定字段值为键名的map

func (*Engine) RawQueryStr

func (this *Engine) RawQueryStr(sql string, params ...interface{}) []map[string]string

*

  • RawQueryStr 查询[]map[string]string

func (*Engine) RawReplace

func (this *Engine) RawReplace(table string, sets map[string]interface{}) (int64, error)

func (*Engine) RawSelect

func (this *Engine) RawSelect(fields string, table string, where string, params ...interface{}) SelectRows

RawSelect("*","member","id=?",1) RawSelect("*","member","status=? AND sex=?",1,1) RawSelect("*","`~member` a,`~order` b","a.status=? AND b.status=?",1,1)

func (*Engine) RawUpdate

func (this *Engine) RawUpdate(table string, sets map[string]interface{}, where string, args ...interface{}) (int64, error)

func (*Engine) ReplaceTablePrefix

func (this *Engine) ReplaceTablePrefix(sql string) (r string)

func (*Engine) Rows

func (engine *Engine) Rows(bean interface{}) (*Rows, error)

Rows return sql.Rows compatible Rows obj, as a forward Iterator object for iterating record by record, bean's non-empty fields are conditions.

func (*Engine) SQL

func (engine *Engine) SQL(query interface{}, args ...interface{}) *Session

SQL method let's you manualy write raw SQL and operate For example:

engine.SQL("select * from user").Find(&users)

This code will execute "select * from user" and set the records to users

func (*Engine) SQLType

func (engine *Engine) SQLType(c *core.Column) string

SQLType A simple wrapper to dialect's core.SqlType method

func (*Engine) Select

func (engine *Engine) Select(str string) *Session

Select customerize your select columns or contents

func (*Engine) SetColumnMapper

func (engine *Engine) SetColumnMapper(mapper core.IMapper)

SetColumnMapper set the column name mapping rule

func (*Engine) SetDefaultCacher

func (engine *Engine) SetDefaultCacher(cacher core.Cacher)

SetDefaultCacher set the default cacher. Xorm's default not enable cacher.

func (*Engine) SetDisableGlobalCache

func (engine *Engine) SetDisableGlobalCache(disable bool)

SetDisableGlobalCache disable global cache or not

func (*Engine) SetExpr

func (engine *Engine) SetExpr(column string, expression string) *Session

SetExpr provides a update string like "column = {expression}"

func (*Engine) SetLogger

func (engine *Engine) SetLogger(logger core.ILogger)

SetLogger set the new logger

func (*Engine) SetMapper

func (engine *Engine) SetMapper(mapper core.IMapper)

SetMapper set the name mapping rules

func (*Engine) SetMaxIdleConns

func (engine *Engine) SetMaxIdleConns(conns int)

SetMaxIdleConns set the max idle connections on pool, default is 2

func (*Engine) SetMaxOpenConns

func (engine *Engine) SetMaxOpenConns(conns int)

SetMaxOpenConns is only available for go 1.2+

func (*Engine) SetTableMapper

func (engine *Engine) SetTableMapper(mapper core.IMapper)

SetTableMapper set the table name mapping rule

func (*Engine) SetTblMapper

func (engine *Engine) SetTblMapper(mapper core.IMapper)

func (*Engine) ShowExecTime

func (engine *Engine) ShowExecTime(show ...bool)

ShowExecTime show SQL statment and execute time or not on logger if log level is great than INFO

func (*Engine) ShowSQL

func (engine *Engine) ShowSQL(show ...bool)

ShowSQL show SQL statment or not on logger if log level is great than INFO

func (*Engine) Sql

func (engine *Engine) Sql(querystring string, args ...interface{}) *Session

Sql will be depracated, please use SQL instead

func (*Engine) SqlType

func (engine *Engine) SqlType(c *core.Column) string

SqlType will be depracated, please use SQLType instead

func (*Engine) StoreEngine

func (engine *Engine) StoreEngine(storeEngine string) *Session

StoreEngine set store engine when create table, only support mysql now

func (*Engine) Sum

func (engine *Engine) Sum(bean interface{}, colName string) (float64, error)

Sum sum the records by some column. bean's non-empty fields are conditions.

func (*Engine) Sums

func (engine *Engine) Sums(bean interface{}, colNames ...string) ([]float64, error)

Sums sum the records by some columns. bean's non-empty fields are conditions.

func (*Engine) SumsInt

func (engine *Engine) SumsInt(bean interface{}, colNames ...string) ([]int64, error)

SumsInt like Sums but return slice of int64 instead of float64.

func (*Engine) SupportInsertMany

func (engine *Engine) SupportInsertMany() bool

SupportInsertMany If engine's database support batch insert records like "insert into user values (name, age), (name, age)". When the return is ture, then engine.Insert(&users) will generate batch sql and exeute.

func (*Engine) Sync

func (engine *Engine) Sync(beans ...interface{}) error

Sync the new struct changes to database, this method will automatically add table, column, index, unique. but will not delete or change anything. If you change some field, you should change the database manually.

func (*Engine) Sync2

func (engine *Engine) Sync2(beans ...interface{}) error

Sync2 synchronize structs to database tables

func (*Engine) TZTime

func (engine *Engine) TZTime(t time.Time) time.Time

TZTime change one time to xorm time location

func (*Engine) Table

func (engine *Engine) Table(tableNameOrBean interface{}) *Session

Table temporarily change the Get, Find, Update's table

func (*Engine) TableInfo

func (engine *Engine) TableInfo(bean interface{}) *Table

TableInfo get table info according to bean's content

func (*Engine) TableName

func (this *Engine) TableName(table string) string

func (*Engine) ToSQL

func (engine *Engine) ToSQL(sql string) core.SQL

func (*Engine) Unscoped

func (engine *Engine) Unscoped() *Session

Unscoped always disable struct tag "deleted"

func (*Engine) Update

func (engine *Engine) Update(bean interface{}, condiBeans ...interface{}) (int64, error)

Update records, bean's non-empty fields are updated contents, condiBean' non-empty filds are conditions CAUTION:

1.bool will defaultly be updated content nor conditions
 You should call UseBool if you have bool to use.
2.float32 & float64 may be not inexact as conditions

func (*Engine) UseBool

func (engine *Engine) UseBool(columns ...string) *Session

UseBool xorm automatically retrieve condition according struct, but if struct has bool field, it will ignore them. So use UseBool to tell system to do not ignore them. If no paramters, it will use all the bool field of struct, or it will use paramters's columns

func (*Engine) Where

func (engine *Engine) Where(query interface{}, args ...interface{}) *Session

Where method provide a condition query

type IterFunc

type IterFunc func(idx int, bean interface{}) error

IterFunc only use by Iterate

type LRUCacher

type LRUCacher struct {

	// maxSize    int
	MaxElementSize int
	Expired        time.Duration
	GcInterval     time.Duration
	// contains filtered or unexported fields
}

func NewLRUCacher

func NewLRUCacher(store core.CacheStore, maxElementSize int) *LRUCacher

func NewLRUCacher2

func NewLRUCacher2(store core.CacheStore, expired time.Duration, maxElementSize int) *LRUCacher

func (*LRUCacher) ClearBeans

func (m *LRUCacher) ClearBeans(tableName string)

func (*LRUCacher) ClearIds

func (m *LRUCacher) ClearIds(tableName string)

func (*LRUCacher) DelBean

func (m *LRUCacher) DelBean(tableName string, id string)

func (*LRUCacher) DelIds

func (m *LRUCacher) DelIds(tableName, sql string)

func (*LRUCacher) GC

func (m *LRUCacher) GC()

GC check ids lit and sql list to remove all element expired

func (*LRUCacher) GetBean

func (m *LRUCacher) GetBean(tableName string, id string) interface{}

Get bean according tableName and id from cache

func (*LRUCacher) GetIds

func (m *LRUCacher) GetIds(tableName, sql string) interface{}

Get all bean's ids according to sql and parameter from cache

func (*LRUCacher) PutBean

func (m *LRUCacher) PutBean(tableName string, id string, obj interface{})

func (*LRUCacher) PutIds

func (m *LRUCacher) PutIds(tableName, sql string, ids interface{})

func (*LRUCacher) RunGC

func (m *LRUCacher) RunGC()

RunGC run once every m.GcInterval

type MemoryStore

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

memory store

func NewMemoryStore

func NewMemoryStore() *MemoryStore

func (*MemoryStore) Del

func (s *MemoryStore) Del(key string) error

func (*MemoryStore) Get

func (s *MemoryStore) Get(key string) (interface{}, error)

func (*MemoryStore) Put

func (s *MemoryStore) Put(key string, value interface{}) error

type ResultSet

type ResultSet struct {
	Fields    []string
	Values    []*reflect.Value
	NameIndex map[string]int
	Length    int
}

func NewResultSet

func NewResultSet() *ResultSet

===================================== 定义ResultSet =====================================

func (*ResultSet) Get

func (r *ResultSet) Get(index int) interface{}

func (*ResultSet) GetBool

func (r *ResultSet) GetBool(index int) bool

func (*ResultSet) GetBoolByName

func (r *ResultSet) GetBoolByName(name string) bool

func (*ResultSet) GetByName

func (r *ResultSet) GetByName(name string) interface{}

func (*ResultSet) GetFloat32

func (r *ResultSet) GetFloat32(index int) float32

func (*ResultSet) GetFloat32ByName

func (r *ResultSet) GetFloat32ByName(name string) float32

func (*ResultSet) GetFloat64

func (r *ResultSet) GetFloat64(index int) float64

func (*ResultSet) GetFloat64ByName

func (r *ResultSet) GetFloat64ByName(name string) float64

func (*ResultSet) GetInt

func (r *ResultSet) GetInt(index int) int

func (*ResultSet) GetInt64

func (r *ResultSet) GetInt64(index int) int64

func (*ResultSet) GetInt64ByName

func (r *ResultSet) GetInt64ByName(name string) int64

func (*ResultSet) GetIntByName

func (r *ResultSet) GetIntByName(name string) int

func (*ResultSet) GetString

func (r *ResultSet) GetString(index int) string

func (*ResultSet) GetStringByName

func (r *ResultSet) GetStringByName(name string) string

func (*ResultSet) GetTime

func (r *ResultSet) GetTime(index int) time.Time

func (*ResultSet) GetTimeByName

func (r *ResultSet) GetTimeByName(name string) time.Time

func (*ResultSet) Set

func (r *ResultSet) Set(index int, value interface{}) bool

func (*ResultSet) SetByName

func (r *ResultSet) SetByName(name string, value interface{}) bool

type Rows

type Rows struct {
	NoTypeCheck bool
	// contains filtered or unexported fields
}

Rows rows wrapper a rows to

func (*Rows) Close

func (rows *Rows) Close() error

Close session if session.IsAutoClose is true, and claimed any opened resources

func (*Rows) Err

func (rows *Rows) Err() error

Err returns the error, if any, that was encountered during iteration. Err may be called after an explicit or implicit Close.

func (*Rows) Next

func (rows *Rows) Next() bool

Next move cursor to next record, return false if end has reached

func (*Rows) Scan

func (rows *Rows) Scan(bean interface{}) error

Scan row record to bean properties

type SelectRows

type SelectRows []*ResultSet

func (SelectRows) GetOne

func (this SelectRows) GetOne() (result string)

func (SelectRows) GetRow

func (this SelectRows) GetRow() (result *ResultSet)

type Session

type Session struct {
	Engine                 *Engine
	Tx                     *core.Tx
	Statement              Statement
	IsAutoCommit           bool
	IsCommitedOrRollbacked bool
	TransType              string
	IsAutoClose            bool

	// Automatically reset the statement after operations that execute a SQL
	// query such as Count(), Find(), Get(), ...
	AutoResetStatement bool
	// contains filtered or unexported fields
}

Session keep a pointer to sql.DB and provides all execution of all kind of database operations.

func (*Session) After

func (session *Session) After(closures func(interface{})) *Session

After Apply after Processor, affected bean is passed to closure arg

func (*Session) Alias

func (session *Session) Alias(alias string) *Session

Alias set the table alias

func (*Session) AllCols

func (session *Session) AllCols() *Session

AllCols ask all columns

func (*Session) And

func (session *Session) And(query interface{}, args ...interface{}) *Session

And provides custom query condition.

func (*Session) Asc

func (session *Session) Asc(colNames ...string) *Session

Asc provide asc order by query condition, the input parameters are columns.

func (*Session) Before

func (session *Session) Before(closures func(interface{})) *Session

Before Apply before Processor, affected bean is passed to closure arg

func (*Session) Begin

func (session *Session) Begin() error

Begin a transaction

func (*Session) Cascade

func (session *Session) Cascade(trueOrFalse ...bool) *Session

Cascade indicates if loading sub Struct

func (*Session) Charset

func (session *Session) Charset(charset string) *Session

Charset is only avialble mysql dialect currently

func (*Session) Clone

func (session *Session) Clone() *Session

Clone copy all the session's content and return a new session

func (*Session) Close

func (session *Session) Close()

Close release the connection from pool

func (*Session) Cols

func (session *Session) Cols(columns ...string) *Session

Cols provides some columns to special

func (*Session) Commit

func (session *Session) Commit() error

Commit When using transaction, Commit will commit all operations.

func (*Session) Count

func (session *Session) Count(bean interface{}) (int64, error)

Count counts the records. bean's non-empty fields are conditions.

func (*Session) CreateIndexes

func (session *Session) CreateIndexes(bean interface{}) error

CreateIndexes create indexes

func (*Session) CreateTable

func (session *Session) CreateTable(bean interface{}) error

CreateTable create a table according a bean

func (*Session) CreateUniques

func (session *Session) CreateUniques(bean interface{}) error

CreateUniques create uniques

func (*Session) DB

func (session *Session) DB() *core.DB

DB db return the wrapper of sql.DB

func (*Session) Decr

func (session *Session) Decr(column string, arg ...interface{}) *Session

Decr provides a query string like "count = count - 1"

func (*Session) Delete

func (session *Session) Delete(bean interface{}) (int64, error)

Delete records, bean's non-empty fields are conditions

func (*Session) Desc

func (session *Session) Desc(colNames ...string) *Session

Desc provide desc order by query condition, the input parameters are columns.

func (*Session) Distinct

func (session *Session) Distinct(columns ...string) *Session

Distinct use for distinct columns. Caution: when you are using cache, distinct will not be cached because cache system need id, but distinct will not provide id

func (*Session) DropIndexes

func (session *Session) DropIndexes(bean interface{}) error

DropIndexes drop indexes

func (*Session) DropTable

func (session *Session) DropTable(beanOrTableName interface{}) error

DropTable drop table will drop table if exist, if drop failed, it will return error

func (*Session) Exec

func (session *Session) Exec(sqlStr string, args ...interface{}) (sql.Result, error)

Exec raw sql

func (*Session) Find

func (session *Session) Find(rowsSlicePtr interface{}, condiBean ...interface{}) error

Find retrieve records from table, condiBeans's non-empty fields are conditions. beans could be []Struct, []*Struct, map[int64]Struct map[int64]*Struct

func (*Session) ForUpdate

func (session *Session) ForUpdate() *Session

ForUpdate Set Read/Write locking for UPDATE

func (*Session) Get

func (session *Session) Get(bean interface{}) (bool, error)

Get retrieve one record from database, bean's non-empty fields will be as conditions

func (*Session) GroupBy

func (session *Session) GroupBy(keys string) *Session

GroupBy Generate Group By statement

func (*Session) Having

func (session *Session) Having(conditions string) *Session

Having Generate Having statement

func (*Session) ID

func (session *Session) ID(id interface{}) *Session

ID provides converting id as a query condition

func (*Session) Id

func (session *Session) Id(id interface{}) *Session

Id will be deprecated, please use ID instead

func (*Session) In

func (session *Session) In(column string, args ...interface{}) *Session

In provides a query string like "id in (1, 2, 3)"

func (*Session) Incr

func (session *Session) Incr(column string, arg ...interface{}) *Session

Incr provides a query string like "count = count + 1"

func (*Session) Init

func (session *Session) Init()

Init reset the session as the init status.

func (*Session) Insert

func (session *Session) Insert(beans ...interface{}) (int64, error)

Insert insert one or more beans

func (*Session) InsertMulti

func (session *Session) InsertMulti(rowsSlicePtr interface{}) (int64, error)

InsertMulti insert multiple records

func (*Session) InsertOne

func (session *Session) InsertOne(bean interface{}) (int64, error)

InsertOne insert only one struct into database as a record. The in parameter bean must a struct or a point to struct. The return parameter is inserted and error

func (*Session) IsTableEmpty

func (session *Session) IsTableEmpty(bean interface{}) (bool, error)

IsTableEmpty if table have any records

func (*Session) IsTableExist

func (session *Session) IsTableExist(beanOrTableName interface{}) (bool, error)

IsTableExist if a table is exist

func (*Session) Iterate

func (session *Session) Iterate(bean interface{}, fun IterFunc) error

Iterate record by record handle records from table, condiBeans's non-empty fields are conditions. beans could be []Struct, []*Struct, map[int64]Struct map[int64]*Struct

func (*Session) Join

func (session *Session) Join(joinOperator string, tablename interface{}, condition string, args ...interface{}) *Session

Join join_operator should be one of INNER, LEFT OUTER, CROSS etc - this will be prepended to JOIN

func (*Session) LastSQL

func (session *Session) LastSQL() (string, []interface{})

LastSQL returns last query information

func (*Session) Limit

func (session *Session) Limit(limit int, start ...int) *Session

Limit provide limit and offset query condition

func (*Session) MustCols

func (session *Session) MustCols(columns ...string) *Session

MustCols specify some columns must use even if they are empty

func (*Session) NoAutoCondition

func (session *Session) NoAutoCondition(no ...bool) *Session

NoAutoCondition disable generate SQL condition from beans

func (*Session) NoAutoTime

func (session *Session) NoAutoTime() *Session

NoAutoTime means do not automatically give created field and updated field the current time on the current session temporarily

func (*Session) NoCache

func (session *Session) NoCache() *Session

NoCache ask this session do not retrieve data from cache system and get data from database directly.

func (*Session) NoCascade

func (session *Session) NoCascade() *Session

NoCascade indicate that no cascade load child object

func (*Session) NotIn

func (session *Session) NotIn(column string, args ...interface{}) *Session

NotIn provides a query string like "id in (1, 2, 3)"

func (*Session) Nullable

func (session *Session) Nullable(columns ...string) *Session

Nullable Set null when column is zero-value and nullable for update

func (*Session) Omit

func (session *Session) Omit(columns ...string) *Session

Omit Only not use the paramters as select or update columns

func (*Session) Or

func (session *Session) Or(query interface{}, args ...interface{}) *Session

Or provides custom query condition.

func (*Session) OrderBy

func (session *Session) OrderBy(order string) *Session

OrderBy provide order by query condition, the input parameter is the content after order by on a sql statement.

func (*Session) Ping

func (session *Session) Ping() error

Ping test if database is ok

func (*Session) Prepare

func (session *Session) Prepare() *Session

Prepare set a flag to session that should be prepare statment before execute query

func (*Session) Q

func (session *Session) Q(sqlStr string, params ...interface{}) (resultsSlice []*ResultSet, err error)

*

  • Exec a raw sql and return records as []*ResultSet
  • @param string SQL
  • @param ...interface{} params
  • @return []*ResultSet,error
  • @author AdamShen (swh@admpub.com)

func (*Session) QCallback

func (session *Session) QCallback(callback func(*core.Rows, []string), sqlStr string, params ...interface{}) (err error)

*

  • 逐行执行回调函数
  • @param func(*core.Rows) callback callback func
  • @param string sqlStr SQL
  • @param ...interface{} params params
  • @return error
  • @author AdamShen (swh@admpub.com)
  • @example
  • QCallback(func(rows *core.Rows){
  • if err := rows.Scan(bean); err != nil {
  • return
  • }
  • //.....
  • },"SELECT * FROM shop WHERE type=?","vip")

func (*Session) Query

func (session *Session) Query(sqlStr string, paramStr ...interface{}) (resultsSlice []map[string][]byte, err error)

Query a raw sql and return records as []map[string][]byte

func (*Session) QueryRaw

func (session *Session) QueryRaw(sqlStr string, params ...interface{}) ([]map[string]interface{}, error)

func (*Session) QueryStr

func (session *Session) QueryStr(sqlStr string, params ...interface{}) ([]map[string]string, error)

===================================== 增加Session结构体中的方法 =====================================

func (*Session) Rollback

func (session *Session) Rollback() error

Rollback When using transaction, you can rollback if any error

func (*Session) Rows

func (session *Session) Rows(bean interface{}) (*Rows, error)

Rows return sql.Rows compatible Rows obj, as a forward Iterator object for iterating record by record, bean's non-empty fields are conditions.

func (*Session) SQL

func (session *Session) SQL(query interface{}, args ...interface{}) *Session

SQL provides raw sql input parameter. When you have a complex SQL statement and cannot use Where, Id, In and etc. Methods to describe, you can use SQL.

func (*Session) Select

func (session *Session) Select(str string) *Session

Select provides some columns to special

func (*Session) SetExpr

func (session *Session) SetExpr(column string, expression string) *Session

SetExpr provides a query string like "column = {expression}"

func (*Session) Sql

func (session *Session) Sql(query string, args ...interface{}) *Session

Sql !DEPRECIATED! will be deprecated, please use SQL instead.

func (*Session) StoreEngine

func (session *Session) StoreEngine(storeEngine string) *Session

StoreEngine is only avialble mysql dialect currently

func (*Session) Sum

func (session *Session) Sum(bean interface{}, columnName string) (float64, error)

Sum call sum some column. bean's non-empty fields are conditions.

func (*Session) Sums

func (session *Session) Sums(bean interface{}, columnNames ...string) ([]float64, error)

Sums call sum some columns. bean's non-empty fields are conditions.

func (*Session) SumsInt

func (session *Session) SumsInt(bean interface{}, columnNames ...string) ([]int64, error)

SumsInt sum specify columns and return as []int64 instead of []float64

func (*Session) Sync2

func (session *Session) Sync2(beans ...interface{}) error

Sync2 synchronize structs to database tables

func (*Session) Table

func (session *Session) Table(tableNameOrBean interface{}) *Session

Table can input a string or pointer to struct for special a table to operate.

func (*Session) Unscoped

func (session *Session) Unscoped() *Session

Unscoped always disable struct tag "deleted"

func (*Session) Update

func (session *Session) Update(bean interface{}, condiBean ...interface{}) (int64, error)

Update records, bean's non-empty fields are updated contents, condiBean' non-empty filds are conditions CAUTION:

1.bool will defaultly be updated content nor conditions
 You should call UseBool if you have bool to use.
2.float32 & float64 may be not inexact as conditions

func (*Session) UseBool

func (session *Session) UseBool(columns ...string) *Session

UseBool automatically retrieve condition according struct, but if struct has bool field, it will ignore them. So use UseBool to tell system to do not ignore them. If no paramters, it will use all the bool field of struct, or it will use paramters's columns

func (*Session) Where

func (session *Session) Where(query interface{}, args ...interface{}) *Session

Where provides custom query condition.

type SimpleLogger

type SimpleLogger struct {
	DEBUG *log.Logger
	ERR   *log.Logger
	INFO  *log.Logger
	WARN  *log.Logger
	// contains filtered or unexported fields
}

SimpleLogger is the default implment of core.ILogger

func NewSimpleLogger

func NewSimpleLogger(out io.Writer) *SimpleLogger

NewSimpleLogger use a special io.Writer as logger output

func NewSimpleLogger2

func NewSimpleLogger2(out io.Writer, prefix string, flag int) *SimpleLogger

NewSimpleLogger2 let you customrize your logger prefix and flag

func NewSimpleLogger3

func NewSimpleLogger3(out io.Writer, prefix string, flag int, l core.LogLevel) *SimpleLogger

NewSimpleLogger3 let you customrize your logger prefix and flag and logLevel

func (*SimpleLogger) Debug

func (s *SimpleLogger) Debug(v ...interface{})

Debug implement core.ILogger

func (*SimpleLogger) Debugf

func (s *SimpleLogger) Debugf(format string, v ...interface{})

Debugf implement core.ILogger

func (*SimpleLogger) Error

func (s *SimpleLogger) Error(v ...interface{})

Error implement core.ILogger

func (*SimpleLogger) Errorf

func (s *SimpleLogger) Errorf(format string, v ...interface{})

Errorf implement core.ILogger

func (*SimpleLogger) Info

func (s *SimpleLogger) Info(v ...interface{})

Info implement core.ILogger

func (*SimpleLogger) Infof

func (s *SimpleLogger) Infof(format string, v ...interface{})

Infof implement core.ILogger

func (*SimpleLogger) IsShowSQL

func (s *SimpleLogger) IsShowSQL() bool

IsShowSQL implement core.ILogger

func (*SimpleLogger) Level

func (s *SimpleLogger) Level() core.LogLevel

Level implement core.ILogger

func (*SimpleLogger) SetLevel

func (s *SimpleLogger) SetLevel(l core.LogLevel)

SetLevel implement core.ILogger

func (*SimpleLogger) ShowSQL

func (s *SimpleLogger) ShowSQL(show ...bool)

ShowSQL implement core.ILogger

func (*SimpleLogger) Warn

func (s *SimpleLogger) Warn(v ...interface{})

Warn implement core.ILogger

func (*SimpleLogger) Warnf

func (s *SimpleLogger) Warnf(format string, v ...interface{})

Warnf implement core.ILogger

type Statement

type Statement struct {
	RefTable *core.Table
	Engine   *Engine
	Start    int
	LimitN   int
	IdParam  *core.PK
	OrderStr string

	GroupByStr string
	HavingStr  string
	ColumnStr  string

	OmitStr      string
	AltTableName string

	RawSQL      string
	RawParams   []interface{}
	UseCascade  bool
	UseAutoJoin bool
	StoreEngine string
	Charset     string
	UseCache    bool
	UseAutoTime bool

	IsDistinct  bool
	IsForUpdate bool
	TableAlias  string
	// contains filtered or unexported fields
}

Statement save all the sql info for executing SQL

func (*Statement) Alias

func (statement *Statement) Alias(alias string) *Statement

Alias set the table alias

func (*Statement) AllCols

func (statement *Statement) AllCols() *Statement

AllCols update use only: update all columns

func (*Statement) And

func (statement *Statement) And(query interface{}, args ...interface{}) *Statement

And add Where & and statment

func (*Statement) Asc

func (statement *Statement) Asc(colNames ...string) *Statement

Asc provide asc order by query condition, the input parameters are columns.

func (*Statement) Cols

func (statement *Statement) Cols(columns ...string) *Statement

Cols generate "col1, col2" statement

func (*Statement) Decr

func (statement *Statement) Decr(column string, arg ...interface{}) *Statement

Decr Generate "Update ... Set column = column - arg" statment

func (*Statement) Desc

func (statement *Statement) Desc(colNames ...string) *Statement

Desc generate `ORDER BY xx DESC`

func (*Statement) Distinct

func (statement *Statement) Distinct(columns ...string) *Statement

Generate "Distince col1, col2 " statment

func (*Statement) ForUpdate

func (statement *Statement) ForUpdate() *Statement

Generate "SELECT ... FOR UPDATE" statment

func (*Statement) GroupBy

func (statement *Statement) GroupBy(keys string) *Statement

GroupBy generate "Group By keys" statement

func (*Statement) Having

func (statement *Statement) Having(conditions string) *Statement

Having generate "Having conditions" statement

func (*Statement) Id

func (statement *Statement) Id(id interface{}) *Statement

Id generate "where id = ? " statment or for composite key "where key1 = ? and key2 = ?"

func (*Statement) In

func (statement *Statement) In(column string, args ...interface{}) *Statement

In generate "Where column IN (?) " statment

func (*Statement) Incr

func (statement *Statement) Incr(column string, arg ...interface{}) *Statement

Incr Generate "Update ... Set column = column + arg" statment

func (*Statement) Init

func (statement *Statement) Init()

Init reset all the statment's fields

func (*Statement) Join

func (statement *Statement) Join(joinOP string, tablename interface{}, condition string, args ...interface{}) *Statement

Join The joinOP should be one of INNER, LEFT OUTER, CROSS etc - this will be prepended to JOIN

func (*Statement) JoinColumns

func (statement *Statement) JoinColumns(cols []*core.Column, includeTableName bool) string

func (*Statement) JoinStr

func (statement *Statement) JoinStr() string

func (*Statement) Limit

func (statement *Statement) Limit(limit int, start ...int) *Statement

Limit generate LIMIT start, limit statement

func (*Statement) MustCols

func (statement *Statement) MustCols(columns ...string) *Statement

MustCols update use only: must update columns

func (*Statement) NoAutoCondition

func (statement *Statement) NoAutoCondition(no ...bool) *Statement

NoAutoCondition if you do not want convert bean's field as query condition, then use this function

func (*Statement) NotIn

func (statement *Statement) NotIn(column string, args ...interface{}) *Statement

NotIn generate "Where column IN (?) " statment

func (*Statement) Nullable

func (statement *Statement) Nullable(columns ...string)

Nullable Update use only: update columns to null when value is nullable and zero-value

func (*Statement) Omit

func (statement *Statement) Omit(columns ...string)

Omit do not use the columns

func (*Statement) Or

func (statement *Statement) Or(query interface{}, args ...interface{}) *Statement

Or add Where & Or statment

func (*Statement) OrderBy

func (statement *Statement) OrderBy(order string) *Statement

OrderBy generate "Order By order" statement

func (*Statement) SQL

func (statement *Statement) SQL(query interface{}, args ...interface{}) *Statement

Sql add the raw sql statement

func (*Statement) Select

func (s *Statement) Select(str string) *Statement

Select replace select

func (*Statement) SetExpr

func (statement *Statement) SetExpr(column string, expression string) *Statement

SetExpr Generate "Update ... Set column = {expression}" statment

func (*Statement) SetRelation

func (statement *Statement) SetRelation(r *core.Relation)

func (*Statement) Table

func (statement *Statement) Table(tableNameOrBean interface{}) *Statement

Table tempororily set table name, the parameter could be a string or a pointer of struct

func (*Statement) TableName

func (statement *Statement) TableName() string

TableName return current tableName

func (*Statement) Top

func (statement *Statement) Top(limit int) *Statement

Top generate LIMIT limit statement

func (*Statement) Unscoped

func (statement *Statement) Unscoped() *Statement

Unscoped always disable struct tag "deleted"

func (*Statement) UseBool

func (statement *Statement) UseBool(columns ...string) *Statement

UseBool indicates that use bool fields as update contents and query contiditions

func (*Statement) Where

func (statement *Statement) Where(query interface{}, args ...interface{}) *Statement

Where add Where statment

type SyslogLogger

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

SyslogLogger will be depricated

func NewSyslogLogger

func NewSyslogLogger(w *syslog.Writer) *SyslogLogger

func (*SyslogLogger) Debug

func (s *SyslogLogger) Debug(v ...interface{})

func (*SyslogLogger) Debugf

func (s *SyslogLogger) Debugf(format string, v ...interface{})

func (*SyslogLogger) Error

func (s *SyslogLogger) Error(v ...interface{})

func (*SyslogLogger) Errorf

func (s *SyslogLogger) Errorf(format string, v ...interface{})

func (*SyslogLogger) Info

func (s *SyslogLogger) Info(v ...interface{})

func (*SyslogLogger) Infof

func (s *SyslogLogger) Infof(format string, v ...interface{})

func (*SyslogLogger) IsShowSQL

func (s *SyslogLogger) IsShowSQL() bool

func (*SyslogLogger) Level

func (s *SyslogLogger) Level() core.LogLevel

func (*SyslogLogger) SetLevel

func (s *SyslogLogger) SetLevel(l core.LogLevel)

SetLevel always return error, as current log/syslog package doesn't allow to set priority level after syslog.Writer created

func (*SyslogLogger) ShowSQL

func (s *SyslogLogger) ShowSQL(show ...bool)

func (*SyslogLogger) Warn

func (s *SyslogLogger) Warn(v ...interface{})

func (*SyslogLogger) Warnf

func (s *SyslogLogger) Warnf(format string, v ...interface{})

type TABLE_NAME

type TABLE_NAME interface {
	TABLE_NAME() string
}

type TLogger

type TLogger struct {
	SQL   *CLogger
	Event *CLogger
	Cache *CLogger
	ETime *CLogger
	Base  *CLogger
	Other *CLogger
	// contains filtered or unexported fields
}

func NewTLogger

func NewTLogger(logger core.ILogger) *TLogger

func (*TLogger) Close

func (t *TLogger) Close(tags ...string)

func (*TLogger) Min

func (t *TLogger) Min() time.Duration

func (*TLogger) Open

func (t *TLogger) Open(tags ...string)

func (*TLogger) SetLogger

func (t *TLogger) SetLogger(logger core.ILogger)

func (*TLogger) SetMin

func (t *TLogger) SetMin(min time.Duration) *TLogger

func (*TLogger) SetProcessor

func (t *TLogger) SetProcessor(processor func(tag string, format string, args []interface{}) (string, []interface{}))

func (*TLogger) SetStatusByName

func (t *TLogger) SetStatusByName(tag string, status bool)

type Table

type Table struct {
	*core.Table
	Name string
}

Table table struct

type TableName

type TableName interface {
	TableName() string
}

TableName table name interface to define customerize table name

Directories

Path Synopsis
Package builder is a simple and powerful sql builder for Go.
Package builder is a simple and powerful sql builder for Go.
cmd
[SWH|+] 关联关系
[SWH|+] 关联关系
driver
godbc
Package odbc implements database/sql driver to access data via odbc interface.
Package odbc implements database/sql driver to access data via odbc interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL