database

Documentation

Overview

Copyright 2016 Wenhui Shen <www.webx.top>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2016 Wenhui Shen <www.webx.top>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type Orm
  • func NewOrm(engine string, dsn string) (db *Orm, err error)
  • func (this *Orm) Close()
  • func (this *Orm) EqField(field string, keywords string) string
  • func (this *Orm) RangeField(idField string, keywords string) string
  • func (this *Orm) SearchField(field string, keywords string, idFields ...string) string
  • func (this *Orm) SetCacher(cs core.CacheStore) *Orm
  • func (this *Orm) SetLogger(out io.Writer) *Orm
  • func (this *Orm) SetPrefix(prefix string) *Orm
  • func (this *Orm) SetTimezone(timezone string) *Orm
  • func (this *Orm) T(noPrefixTableName string) string
  • func (this *Orm) VerifyField(v interface{}, field string) string
  • func (this *Orm) VerifyFields(v interface{}, fields ...string) []string
  • func (this *Orm) VerifyTblField(v interface{}, field string) string
  • func (this *Orm) VerifyTblFields(v interface{}, fields ...string) []string
• type Ormer

Variables

var CacheDir string = "data/cache"

Types

type Orm

type Orm struct {
	*Engine
	CacheStore   interface{}
	PrefixMapper core.PrefixMapper
}

func NewOrm

func NewOrm(engine string, dsn string) (db *Orm, err error)

func (*Orm) Close

func (this *Orm) Close()

func (*Orm) EqField

func (this *Orm) EqField(field string, keywords string) string

func (*Orm) RangeField

func (this *Orm) RangeField(idField string, keywords string) string

func (*Orm) SearchField

func (this *Orm) SearchField(field string, keywords string, idFields ...string) string

*

• 搜索某个字段
• @param field 字段名。支持搜索多个字段，各个字段之间用半角逗号“,”隔开
• @param keywords 关键词
• @param idFields 如要搜索id字段需要提供id字段名
• @return sql
• @author swh <swh@admpub.com>

func (*Orm) SetCacher

func (this *Orm) SetCacher(cs core.CacheStore) *Orm

func (*Orm) SetLogger

func (this *Orm) SetLogger(out io.Writer) *Orm

func (*Orm) SetPrefix

func (this *Orm) SetPrefix(prefix string) *Orm

func (*Orm) SetTimezone

func (this *Orm) SetTimezone(timezone string) *Orm

func (*Orm) T

func (this *Orm) T(noPrefixTableName string) string

取得完整的表名

func (*Orm) VerifyField

func (this *Orm) VerifyField(v interface{}, field string) string

验证模型结构体字段

func (*Orm) VerifyFields

func (this *Orm) VerifyFields(v interface{}, fields ...string) []string

验证模型结构体字段并返回有效的字段切片

func (*Orm) VerifyTblField

func (this *Orm) VerifyTblField(v interface{}, field string) string

验证数据表字段

func (*Orm) VerifyTblFields

func (this *Orm) VerifyTblFields(v interface{}, fields ...string) []string

验证数据表字段并返回有效的字段切片

type Ormer

type Ormer interface {
	// Method Init reset the session as the init status.
	Init()

	// Method Close release the connection from pool
	Close()

	// Prepare
	Prepare() *Session

	// Method 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.
	Sql(querystring string, args ...interface{}) *Session

	// Method Where provides custom query condition.
	Where(querystring string, args ...interface{}) *Session

	// Method Where provides custom query condition.
	And(querystring string, args ...interface{}) *Session

	// Method Where provides custom query condition.
	Or(querystring string, args ...interface{}) *Session

	// Method Id provides converting id as a query condition
	Id(id interface{}) *Session

	// Apply before Processor, affected bean is passed to closure arg
	Before(closures func(interface{})) *Session

	// Apply after Processor, affected bean is passed to closure arg
	After(closures func(interface{})) *Session

	// Method core.Table can input a string or pointer to struct for special a table to operate.
	Table(tableNameOrBean interface{}) *Session

	// set the table alias
	Alias(alias string) *Session

	// Method In provides a query string like "id in (1, 2, 3)"
	In(column string, args ...interface{}) *Session

	// Method In provides a query string like "count = count + 1"
	Incr(column string, arg ...interface{}) *Session

	// Method Decr provides a query string like "count = count - 1"
	Decr(column string, arg ...interface{}) *Session

	// Method SetExpr provides a query string like "column = {expression}"
	SetExpr(column string, expression string) *Session

	// Method Cols provides some columns to special
	Select(str string) *Session

	// Method Cols provides some columns to special
	Cols(columns ...string) *Session

	AllCols() *Session

	MustCols(columns ...string) *Session

	NoCascade() *Session

	// 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
	UseBool(columns ...string) *Session

	// 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
	Distinct(columns ...string) *Session

	// Set Read/Write locking for UPDATE
	ForUpdate() *Session

	// Only not use the paramters as select or update columns
	Omit(columns ...string) *Session

	// Set null when column is zero-value and nullable for update
	Nullable(columns ...string) *Session

	// Method NoAutoTime means do not automatically give created field and updated field
	// the current time on the current session temporarily
	NoAutoTime() *Session

	NoAutoCondition(no ...bool) *Session

	// Method Limit provide limit and offset query condition
	Limit(limit int, start ...int) *Session

	// Method OrderBy provide order by query condition, the input parameter is the content
	// after order by on a sql statement.
	OrderBy(order string) *Session

	// Method Desc provide desc order by query condition, the input parameters are columns.
	Desc(colNames ...string) *Session

	// Method Asc provide asc order by query condition, the input parameters are columns.
	Asc(colNames ...string) *Session

	// Method StoreEngine is only avialble mysql dialect currently
	StoreEngine(storeEngine string) *Session

	// Method Charset is only avialble mysql dialect currently
	Charset(charset string) *Session

	// Method Cascade indicates if loading sub Struct
	Cascade(trueOrFalse ...bool) *Session

	// Method NoCache ask this session do not retrieve data from cache system and
	// get data from database directly.
	NoCache() *Session

	//The join_operator should be one of INNER, LEFT OUTER, CROSS etc - this will be prepended to JOIN
	Join(join_operator string, tablename interface{}, condition string) *Session

	// Generate Group By statement
	GroupBy(keys string) *Session

	// Generate Having statement
	Having(conditions string) *Session

	DB() *core.DB

	// Begin a transaction
	Begin() error

	// When using transaction, you can rollback if any error
	Rollback() error

	// When using transaction, Commit will commit all operations.
	Commit() error

	// Exec raw sql
	Exec(sqlStr string, args ...interface{}) (sql.Result, error)

	// this function create a table according a bean
	CreateTable(bean interface{}) error

	// create indexes
	CreateIndexes(bean interface{}) error

	// create uniques
	CreateUniques(bean interface{}) error

	// drop indexes
	DropIndexes(bean interface{}) error

	// drop table will drop table if exist, if drop failed, it will return error
	DropTable(beanOrTableName interface{}) error

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

	// Return sql.Rows compatible Rows obj, as a forward Iterator object for iterating record by record, bean's non-empty fields
	// are conditions.
	Rows(bean interface{}) (*Rows, 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
	Iterate(bean interface{}, fun IterFunc) error

	// get retrieve one record from database, bean's non-empty fields
	// will be as conditions
	Get(bean interface{}) (bool, error)

	// Count counts the records. bean's non-empty fields
	// are conditions.
	Count(bean interface{}) (int64, error)

	// Find retrieve records from table, condiBeans's non-empty fields
	// are conditions. beans could be []Struct, []*Struct, map[int64]Struct
	// map[int64]*Struct
	Find(rowsSlicePtr interface{}, condiBean ...interface{}) error

	// Test if database is ok
	Ping() error

	IsTableExist(beanOrTableName interface{}) (bool, error)

	IsTableEmpty(bean interface{}) (bool, error)

	// Exec a raw sql and return records as []map[string][]byte
	Query(sqlStr string, paramStr ...interface{}) (resultsSlice []map[string][]byte, err error)

	// insert one or more beans
	Insert(beans ...interface{}) (int64, error)

	// Insert multiple records
	InsertMulti(rowsSlicePtr interface{}) (int64, error)

	// Method 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
	InsertOne(bean 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
	Update(bean interface{}, condiBean ...interface{}) (int64, error)

	// Delete records, bean's non-empty fields are conditions
	Delete(bean interface{}) (int64, error)

	// LastSQL returns last query information
	LastSQL() (string, []interface{})

	Sync2(beans ...interface{}) error

	// Always disable struct tag "deleted"
	Unscoped() *Session
}