sqlca

package module
v2.1.1 Latest Latest
Warning

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

 Go to latest Published: May 16, 2022 License: MIT Imports: 25 Imported by: 7

README

author

lory.li

email

civet148@126.com

QQ

93864947

sqlca

a enhancement database and cache tool based on sqlx and redigogo which based on redigo and go-redis-cluster

中文

中文文档

Overview

  • Almost full-featured ORM
  • Multiple databases (MySQL/Postgres/MS-SQLSERVER), read/write splitting
  • Multiple model type struct, slice, built-in types, map
  • Batch insert
  • Query/Insert/Update
  • Upsert by customization [only MySQL/Postgres]
  • Transactions wrapper (auto rollback or commit)
  • Slow query warning
  • Json column query and unmarshal to sub struct nested in data model
  • GEO HASH
  • Nearby query by lng+lat+distance
  • Built-in db, protobuf, json tag fetching
  • Read only column(s) specified by sqlca:"readonly" tag
  • Case...when syntax
  • Decimal, sqlca.Decimal instead of float64 for high precision calculation
  • Where condition required when UPDATE/DELETE
  • db2go command line tool generate table schema output to .go or .proto file
  • Custom sql.Scanner implement fetching
  • SSH tunnel
  • Query results marshal to json string (QueryJson)
  • Simply and developer friendly more than other ORM

tests

mysql schema

test cases

Documentation

Index

Constants

View Source 
const (
	JoinType_Inner = 0 //inner join
	JoinType_Left  = 1 //left join
	JoinType_Right = 2 //right join
)
View Source 
const (
	TAG_NAME_DB       = "db"
	TAG_NAME_JSON     = "json"
	TAG_NAME_PROTOBUF = "protobuf"
	TAG_NAME_SQLCA    = "sqlca"
)
View Source 
const (
	SQLCA_TAG_VALUE_AUTO_INCR = "autoincr" //auto increment
	SQLCA_TAG_VALUE_READ_ONLY = "readonly" //read only (eg. created_at)
	SQLCA_TAG_VALUE_IGNORE    = "-"        //ignore
)
View Source 
const (
	PROTOBUF_VALUE_NAME = "name"
	SQLCA_CHAR_ASTERISK = "*"
)
View Source 
const (
	DRIVER_NAME_MYSQL    = "mysql"
	DRIVER_NAME_POSTGRES = "postgres"
	DRIVER_NAME_SQLITE   = "sqlite3"
	DRIVER_NAME_MSSQL    = "mssql"
	DRIVER_NAME_REDIS    = "redis"
)
View Source 
const (
	DATABASE_KEY_NAME_WHERE      = "WHERE"
	DATABASE_KEY_NAME_UPDATE     = "UPDATE"
	DATABASE_KEY_NAME_SET        = "SET"
	DATABASE_KEY_NAME_FROM       = "FROM"
	DATABASE_KEY_NAME_DELETE     = "DELETE"
	DATABASE_KEY_NAME_SELECT     = "SELECT"
	DATABASE_KEY_NAME_DISTINCT   = "DISTINCT"
	DATABASE_KEY_NAME_IN         = "IN"
	DATABASE_KEY_NAME_NOT_IN     = "NOT IN"
	DATABASE_KEY_NAME_OR         = "OR"
	DATABASE_KEY_NAME_AND        = "AND"
	DATABASE_KEY_NAME_INSERT     = "INSERT INTO"
	DATABASE_KEY_NAME_VALUE      = "VALUE"
	DATABASE_KEY_NAME_VALUES     = "VALUES"
	DATABASE_KEY_NAME_FOR_UPDATE = "FOR UPDATE"
	DATABASE_KEY_NAME_ORDER_BY   = "ORDER BY"
	DATABASE_KEY_NAME_ASC        = "ASC"
	DATABASE_KEY_NAME_DESC       = "DESC"
	DATABASE_KEY_NAME_HAVING     = "HAVING"
	DATABASE_KEY_NAME_CASE       = "CASE"
	DATABASE_KEY_NAME_WHEN       = "WHEN"
	DATABASE_KEY_NAME_THEN       = "THEN"
	DATABASE_KEY_NAME_ELSE       = "ELSE"
	DATABASE_KEY_NAME_END        = "END"
	DATABASE_KEY_NAME_ON         = "ON"
	DATABASE_KEY_NAME_INNER_JOIN = "INNER JOIN"
	DATABASE_KEY_NAME_LEFT_JOIN  = "LEFT JOIN"
	DATABASE_KEY_NAME_RIGHT_JOIN = "RIGHT JOIN"
	DATABASE_KEY_NAME_FULL_JOIN  = "FULL OUTER JOIN" //MSSQL-SERVER
	DATABASE_KEY_NAME_SUM        = "SUM"
	DATABASE_KEY_NAME_AVG        = "AVG"
	DATABASE_KEY_NAME_MIN        = "MIN"
	DATABASE_KEY_NAME_MAX        = "MAX"
	DATABASE_KEY_NAME_COUNT      = "COUNT"
	DATABASE_KEY_NAME_ROUND      = "ROUND"
)
View Source 
const (
	ORDER_BY_ASC                  = "asc"
	ORDER_BY_DESC                 = "desc"
	DEFAULT_CAHCE_EXPIRE_SECONDS  = 24 * 60 * 60
	DEFAULT_PRIMARY_KEY_NAME      = "id"
	DEFAULT_SLOW_QUERY_ALERT_TIME = 500 //milliseconds
)
View Source 
const (
	ModelType_Struct   = 1
	ModelType_Slice    = 2
	ModelType_Map      = 3
	ModelType_BaseType = 4
)
View Source 
const (
	URL_SCHEME_SEP    = "://"
	URL_QUERY_SLAVE   = "slave"
	URL_QUERY_MAX     = "max"
	URL_QUERY_IDLE    = "idle"
	URL_QUERY_CHARSET = "charset"
)
View Source 
const (
	//DSN no windows authentication: "Provider=SQLOLEDB;port=1433;server=127.0.0.1\SQLEXPRESS;database=test;user id=sa;password=123456"
	//DSN with windows authentication: "Provider=SQLOLEDB;integrated security=SSPI;port=1433;Data Source=127.0.0.1;database=mydb"
	WINDOWS_DSN_PROVIDER_SQLOLEDB        = "Provider=SQLOLEDB"
	WINDOWS_DSN_PORT                     = "Port"
	WINDOWS_DSN_DATA_SOURCE              = "Server"
	WINDOWS_DSN_INITIAL_CATALOG          = "Database"
	WINDOWS_DSN_USER_ID                  = "User Id"
	WINDOWS_DSN_PASSWORD                 = "Password"
	WINDOWS_DSN_INTEGRATED_SECURITY_SSPI = "Integrated Security=SSPI"
)
View Source 
const (
	SSH_TUNNEL_PORT = 6033 //
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AdapterType 

type AdapterType int
const (
	AdapterSqlx_MySQL    AdapterType = 1  //mysql
	AdapterSqlx_Postgres AdapterType = 2  //postgresql
	AdapterSqlx_Sqlite   AdapterType = 3  //sqlite
	AdapterSqlx_Mssql    AdapterType = 4  //mssql server
	AdapterCache_Redis   AdapterType = 11 //redis
)

func (AdapterType) DriverName 

func (a AdapterType) DriverName() string

func (AdapterType) GoString 

func (a AdapterType) GoString() string

func (AdapterType) String 

func (a AdapterType) String() string

type CaseWhen 

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

func (*CaseWhen) Case 

func (c *CaseWhen) Case(strThen string, strWhen string, args ...interface{}) *CaseWhen

func (*CaseWhen) Else 

func (c *CaseWhen) Else(strElse string) *CaseWhen

func (*CaseWhen) End 

func (c *CaseWhen) End(strName string) *Engine

type Decimal 

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

func NewDecimal 

func NewDecimal(v interface{}) (d Decimal)

func (Decimal) Abs 

func (d Decimal) Abs() Decimal

Abs returns the absolute value of the decimal.

func (Decimal) Add 

func (d Decimal) Add(d2 Decimal) Decimal

Add returns d + d2

func (Decimal) Cmp 

func (d Decimal) Cmp(d2 Decimal) int

Cmp compares the numbers represented by d and d2 and returns: 

-1 if d <  d2
 0 if d == d2
+1 if d >  d2

func (Decimal) Cos 

func (d Decimal) Cos() Decimal

Cos returns the cosine of the radian argument x.

func (Decimal) Div 

func (d Decimal) Div(d2 Decimal) Decimal

Div returns d / d2. If it doesn't divide exactly, the result will have DivisionPrecision digits after the decimal point.

func (Decimal) Equal 

func (d Decimal) Equal(d2 Decimal) bool

Equal returns whether the numbers represented by d and d2 are equal.

func (Decimal) Float64 

func (d Decimal) Float64() (f float64)

Float64 returns the nearest float64 value for d and a bool indicating whether f represents d exactly.

func (*Decimal) FromFloat 

func (d *Decimal) FromFloat(v float64)

func (*Decimal) FromInt 

func (d *Decimal) FromInt(v int64)

func (*Decimal) FromString 

func (d *Decimal) FromString(v string)

func (Decimal) GreaterThan 

func (d Decimal) GreaterThan(d2 Decimal) bool

GreaterThan (GT) returns true when d is greater than d2.

func (Decimal) GreaterThanOrEqual 

func (d Decimal) GreaterThanOrEqual(d2 Decimal) bool

GreaterThanOrEqual (GTE) returns true when d is greater than or equal to d2.

func (Decimal) IntPart 

func (d Decimal) IntPart() int64

IntPart returns the integer component of the decimal.

func (Decimal) IsNegative 

func (d Decimal) IsNegative() bool

IsNegative return 

true if d < 0
false if d == 0
false if d > 0

func (Decimal) IsPositive 

func (d Decimal) IsPositive() bool

IsPositive return 

true if d > 0
false if d == 0
false if d < 0

func (Decimal) IsZero 

func (d Decimal) IsZero() bool

IsZero return 

true if d == 0
false if d > 0
false if d < 0

func (Decimal) LessThan 

func (d Decimal) LessThan(d2 Decimal) bool

LessThan (LT) returns true when d is less than d2.

func (Decimal) LessThanOrEqual 

func (d Decimal) LessThanOrEqual(d2 Decimal) bool

LessThanOrEqual (LTE) returns true when d is less than or equal to d2.

func (Decimal) MarshalBinary 

func (d Decimal) MarshalBinary() (data []byte, err error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (Decimal) MarshalJSON 

func (d Decimal) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (Decimal) MarshalText 

func (d Decimal) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface for XML serialization.

func (Decimal) Max 

func (d Decimal) Max(rest ...Decimal) Decimal

Max returns the largest Decimal that was passed in the arguments. To call this function with an array, you must do: This makes it harder to accidentally call Max with 0 arguments.

func (Decimal) Min 

func (d Decimal) Min(rest ...Decimal) Decimal

Min returns the smallest Decimal that was passed in the arguments. To call this function with an array, you must do: This makes it harder to accidentally call Min with 0 arguments.

func (Decimal) Mod 

func (d Decimal) Mod(d2 Decimal) Decimal

Mod returns d % d2.

func (Decimal) Mul 

func (d Decimal) Mul(d2 Decimal) Decimal

Mul returns d * d2.

func (Decimal) Neg 

func (d Decimal) Neg() Decimal

Neg returns -d.

func (Decimal) Pow 

func (d Decimal) Pow(d2 Decimal) Decimal

Pow returns d to the power d2

func (Decimal) Round 

func (d Decimal) Round(places int32) Decimal

Round rounds the decimal to places decimal places. If places < 0, it will round the integer part to the nearest 10^(-places).

Example: 

NewFromFloat(5.45).Round(1).String() // output: "5.5"
NewFromFloat(545).Round(-1).String() // output: "550"

func (*Decimal) Scan 

func (d *Decimal) Scan(src interface{}) error

Scan implements the sql.Scanner interface for database deserialization.

func (Decimal) Sign 

func (d Decimal) Sign() int

Sign returns: 

-1 if d <  0
 0 if d == 0
+1 if d >  0

func (Decimal) Sin 

func (d Decimal) Sin() Decimal

Sin returns the sine of the radian argument x.

func (Decimal) String 

func (d Decimal) String() string

String returns the string representation of the decimal with the fixed point.

Example: 

d := New(-12345, -3)
println(d.String())

Output: 

-12.345

func (Decimal) StringFixed 

func (d Decimal) StringFixed(places int32) string

StringFixed returns a rounded fixed-point string with places digits after the decimal point.

Example: 

NewFromFloat(0).StringFixed(2) // output: "0.00"
NewFromFloat(0).StringFixed(0) // output: "0"
NewFromFloat(5.45).StringFixed(0) // output: "5"
NewFromFloat(5.45).StringFixed(1) // output: "5.5"
NewFromFloat(5.45).StringFixed(2) // output: "5.45"
NewFromFloat(5.45).StringFixed(3) // output: "5.450"
NewFromFloat(545).StringFixed(-1) // output: "550"

func (Decimal) StringScaled 

func (d Decimal) StringScaled(exp int32) string

StringScaled first scales the decimal then calls .String() on it. NOTE: buggy, unintuitive, and DEPRECATED! Use StringFixed instead.

func (Decimal) Sub 

func (d Decimal) Sub(d2 Decimal) Decimal

Sub returns d - d2.

func (Decimal) Sum 

func (d Decimal) Sum(rest ...Decimal) Decimal

Sum returns the combined total of the provided first and rest Decimals

func (Decimal) Tan 

func (d Decimal) Tan() Decimal

Tan returns the tangent of the radian argument x.

func (Decimal) Truncate 

func (d Decimal) Truncate(precision int32) Decimal

Truncate truncates off digits from the number, without rounding.

NOTE: precision is the last digit that will not be truncated (must be >= 0).

Example: 

decimal.NewFromString("123.456").Truncate(2).String() // "123.45"

func (*Decimal) UnmarshalBinary 

func (d *Decimal) UnmarshalBinary(data []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface. As a string representation is already used when encoding to text, this method stores that string as []byte

func (*Decimal) UnmarshalJSON 

func (d *Decimal) UnmarshalJSON(decimalBytes []byte) error

UnmarshalJSON implements the json.Unmarshaler interface.

func (*Decimal) UnmarshalText 

func (d *Decimal) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for XML deserialization.

func (Decimal) Value 

func (d Decimal) Value() (driver.Value, error)

Value implements the driver.Valuer interface for database serialization.

type Engine 

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

func NewEngine 

func NewEngine(args ...interface{}) (*Engine, error)

func (*Engine) And 

func (e *Engine) And(strFmt string, args ...interface{}) *Engine

func (*Engine) Asc 

func (e *Engine) Asc(strColumns ...string) *Engine

order by [field1,field2...] asc

func (*Engine) Attach 

func (e *Engine) Attach(strDatabaseName string, db *sqlx.DB) *Engine

attach from a exist sqlx db instance

func (*Engine) AutoRollback 

func (e *Engine) AutoRollback() *Engine

func (*Engine) Avg 

func (e *Engine) Avg(strColumn string, strAS ...string) *Engine

func (*Engine) Case 

func (e *Engine) Case(strThen string, strWhen string, args ...interface{}) *CaseWhen

func (*Engine) Count 

func (e *Engine) Count(strColumn string, strAS ...string) *Engine

func (*Engine) Counter 

func (e *Engine) Counter() *counter

func (*Engine) Debug 

func (e *Engine) Debug(ok bool)

log debug mode on or off

func (*Engine) Delete 

func (e *Engine) Delete() (rowsAffected int64, err error)

orm delete record(s) from db and cache

func (*Engine) Desc 

func (e *Engine) Desc(strColumns ...string) *Engine

order by [field1,field2...] desc

func (*Engine) Distinct 

func (e *Engine) Distinct() *Engine

set distinct when select

func (*Engine) Equal added in v2.0.14 

func (e *Engine) Equal(strColumn string, value interface{}) *Engine

func (*Engine) Exclude 

func (e *Engine) Exclude(strColumns ...string) *Engine

orm select/update columns

func (*Engine) ExecRaw 

func (e *Engine) ExecRaw(strQuery string, args ...interface{}) (rowsAffected, lastInsertId int64, err error)

use raw sql to insert/update database, results can not be cached to redis/memcached/memory... return rows affected and error, if err is not nil must be something wrong

func (*Engine) Find 

func (e *Engine) Find(conditions map[string]interface{}) (rowsAffected int64, err error)

orm find with customer conditions (map[string]interface{})

func (*Engine) Force 

func (e *Engine) Force() *Engine

force update/insert read only column(s)

func (*Engine) GeoHash 

func (e *Engine) GeoHash(lng, lat float64, precision int) (strGeoHash string, strNeighbors []string)

encode geo hash string (precision 1~8) returns geo hash and neighbors areas

func (*Engine) GetAdapter 

func (e *Engine) GetAdapter() AdapterType

func (*Engine) GetPkName 

func (e *Engine) GetPkName() string

func (*Engine) GraterEqual added in v2.0.14 

func (e *Engine) GraterEqual(strColumn string, value interface{}) *Engine

func (*Engine) GraterThan added in v2.0.14 

func (e *Engine) GraterThan(strColumn string, value interface{}) *Engine

func (*Engine) GroupBy 

func (e *Engine) GroupBy(strColumns ...string) *Engine

group by [field1,field2...]

func (*Engine) Having 

func (e *Engine) Having(strFmt string, args ...interface{}) *Engine

having [condition]

func (*Engine) Id 

func (e *Engine) Id(value interface{}) *Engine

set orm primary key's value

func (*Engine) In 

func (e *Engine) In(strColumn string, args ...interface{}) *Engine

`field_name` IN ('1','2',...)

func (*Engine) InnerJoin 

func (e *Engine) InnerJoin(strTableName string) *Join

func (*Engine) Insert 

func (e *Engine) Insert() (lastInsertId int64, err error)

orm insert return last insert id and error, if err is not nil must be something wrong NOTE: Model function is must be called before call this function

func (*Engine) JsonMarshal 

func (e *Engine) JsonMarshal(v interface{}) (strJson string)

func (*Engine) JsonUnmarshal 

func (e *Engine) JsonUnmarshal(strJson string, v interface{}) (err error)

func (*Engine) LeftJoin 

func (e *Engine) LeftJoin(strTableName string) *Join

func (*Engine) LessEqual added in v2.0.14 

func (e *Engine) LessEqual(strColumn string, value interface{}) *Engine

func (*Engine) LessThan added in v2.0.14 

func (e *Engine) LessThan(strColumn string, value interface{}) *Engine

func (*Engine) Like added in v2.0.14 

func (e *Engine) Like(strColumn, strSub string) *Engine

func (*Engine) Limit 

func (e *Engine) Limit(args ...int) *Engine

query limit Limit(10) - query records limit 10 (mysql/postgres)

func (*Engine) Max 

func (e *Engine) Max(strColumn string, strAS ...string) *Engine

func (*Engine) Min 

func (e *Engine) Min(strColumn string, strAS ...string) *Engine

func (*Engine) Model 

func (e *Engine) Model(args ...interface{}) *Engine

orm model use to get result set, support single struct object or slice [pointer type] notice: will clone a new engine object for orm operations(query/update/insert/upsert)

func (*Engine) NearBy 

func (e *Engine) NearBy(strLngCol, strLatCol, strAS string, lng, lat, distance float64) *Engine
-- select geo point as distance where distance <= n km (float64)

SELECT 

a.*,
(
6371 * ACOS (
COS( RADIANS( a.lat ) ) * COS( RADIANS( 28.8039097230 ) ) * COS(
  RADIANS( 121.5619236231 ) - RADIANS( a.lng )
 ) + SIN( RADIANS( a.lat ) ) * SIN( RADIANS( 28.8039097230 ) )
)
) AS distance

FROM 

t_address a

HAVING distance <= 200 -- less than or equal 200km ORDER BY 

distance
LIMIT 10

func (*Engine) NoVerbose added in v2.0.8 

func (e *Engine) NoVerbose() *Engine

func (*Engine) Not 

func (e *Engine) Not(strColumn string, args ...interface{}) *Engine

`field_name` NOT IN ('1','2',...)

func (*Engine) Offset 

func (e *Engine) Offset(offset int) *Engine

query offset (for mysql/postgres)

func (*Engine) OnConflict 

func (e *Engine) OnConflict(strColumns ...string) *Engine

set the conflict columns for upsert only for postgresql

func (*Engine) Open 

func (e *Engine) Open(strUrl string, options ...interface{}) (*Engine, error)

open a database or cache connection pool strUrl:

  1. data source name

    [mysql] Open("mysql://root:123456@127.0.0.1:3306/test?charset=utf8mb4&slave=false&max=100&idle=1") [postgres] Open("postgres://root:123456@127.0.0.1:5432/test?sslmode=disable&slave=false&max=100&idle=1") [mssql] Open("mssql://sa:123456@127.0.0.1:1433/mydb?instance=SQLExpress&windows=false&max=100&idle=1") [sqlite] Open("sqlite:///var/lib/test.db")

  2. cache config [redis-alone] Open("redis://123456@127.0.0.1:6379/cluster?db=0") [redis-cluster] Open("redis://123456@127.0.0.1:6379/cluster?db=0&replicate=127.0.0.1:6380,127.0.0.1:6381")

options:

  1. specify master or slave, MySQL/Postgres (Options)
  2. cache data expire seconds, just for redis (Integer)

func (*Engine) Or 

func (e *Engine) Or(strFmt string, args ...interface{}) *Engine

func (*Engine) OrderBy 

func (e *Engine) OrderBy(strColumns ...string) *Engine

order by [field1,field2...] [ASC]

func (*Engine) Page 

func (e *Engine) Page(pageNo, pageSize int) *Engine

page query SELECT ... FROM ... WHERE ... LIMIT (pageNo*pageSize), pageSize

func (*Engine) Ping 

func (e *Engine) Ping() (err error)

ping database

func (*Engine) Query 

func (e *Engine) Query() (rowsAffected int64, err error)

orm query return rows affected and error, if err is not nil must be something wrong NOTE: Model function is must be called before call this function if slave == true, try query from a slave connection, if not exist query from master

func (*Engine) QueryEx 

func (e *Engine) QueryEx() (rowsAffected, total int64, err error)

orm query with total count return rows affected and error, if err is not nil must be something wrong NOTE: Model function is must be called before call this function if slave == true, try query from a slave connection, if not exist query from master

func (*Engine) QueryJson 

func (e *Engine) QueryJson() (s string, err error)

query result marshal to json

func (*Engine) QueryMap 

func (e *Engine) QueryMap(strQuery string, args ...interface{}) (rowsAffected int64, err error)

use raw sql to query results into a map slice (model type is []map[string]string) return results and error NOTE: Model function is must be called before call this function

func (*Engine) QueryRaw 

func (e *Engine) QueryRaw(strQuery string, args ...interface{}) (rowsAffected int64, err error)

use raw sql to query results return rows affected and error, if err is not nil must be something wrong NOTE: Model function is must be called before call this function

func (*Engine) RightJoin 

func (e *Engine) RightJoin(strTableName string) *Join

func (*Engine) Round added in v2.0.13 

func (e *Engine) Round(strColumn string, round int, strAS ...string) *Engine

func (*Engine) Select 

func (e *Engine) Select(strColumns ...string) *Engine

orm select/update columns

func (*Engine) SetCustomTag 

func (e *Engine) SetCustomTag(tagNames ...string) *Engine

set your customer tag for db query/insert/update (eg. go structure generated by protobuf not contain 'db' tag) this function must calls before Model()

func (*Engine) SetLogFile 

func (e *Engine) SetLogFile(strPath string)

set log file

func (*Engine) SetPkName 

func (e *Engine) SetPkName(strName string) *Engine

set orm primary key's name, default named 'id'

func (*Engine) SetReadOnly 

func (e *Engine) SetReadOnly(columns ...string)

set read only columns

func (*Engine) Slave 

func (e *Engine) Slave() *Engine

orm query from a slave db

func (*Engine) SlowQuery 

func (e *Engine) SlowQuery(on bool, ms int)

slow query alert on or off on -> true/false ms -> milliseconds (can be 0 if on is false)

func (*Engine) Sum 

func (e *Engine) Sum(strColumn string, strAS ...string) *Engine

func (*Engine) Table 

func (e *Engine) Table(strNames ...string) *Engine

set orm query table name(s) when your struct type name is not a table name

func (*Engine) ToSQL 

func (e *Engine) ToSQL(operType OperType) (strSql string)

make SQL from orm model and operation type

func (*Engine) TxBegin 

func (e *Engine) TxBegin() (*Engine, error)

func (*Engine) TxCommit 

func (e *Engine) TxCommit() error

func (*Engine) TxExec 

func (e *Engine) TxExec(strQuery string, args ...interface{}) (lastInsertId, rowsAffected int64, err error)

func (*Engine) TxFunc 

func (e *Engine) TxFunc(fn func(tx *Engine) error) (err error)

execute transaction by customize function auto rollback when function return error

func (*Engine) TxFuncContext 

func (e *Engine) TxFuncContext(ctx context.Context, fn func(ctx context.Context, tx *Engine) error) (err error)

execute transaction by customize function with context auto rollback when function return error

func (*Engine) TxGet 

func (e *Engine) TxGet(dest interface{}, strQuery string, args ...interface{}) (count int64, err error)

func (*Engine) TxHandle 

func (e *Engine) TxHandle(handler TxHandler) (err error)

execute transaction by customize handler auto rollback when handler return error

func (*Engine) TxRollback 

func (e *Engine) TxRollback() error

func (*Engine) Update 

func (e *Engine) Update() (rowsAffected int64, err error)

orm update from model strColumns... if set, columns will be updated, if none all columns in model will be updated except primary key return rows affected and error, if err is not nil must be something wrong NOTE: Model function is must be called before call this function

func (*Engine) Upsert 

func (e *Engine) Upsert(strCustomizeUpdates ...string) (lastInsertId int64, err error)

orm insert or update if key(s) conflict return last insert id and error, if err is not nil must be something wrong, if your primary key is not a int/int64 type, maybe id return 0 NOTE: Model function is must be called before call this function and call OnConflict function when you are on postgresql updates -> customize updates condition when key(s) conflict [MySQL] INSERT INTO messages(id, message_type, unread_count) VALUES('10000', '2', '1', '3') ON DUPLICATE KEY UPDATE message_type=values(message_type), unread_count=unread_count+values(unread_count) --------------------------------------------------------------------------------------------------------------------------------------- e.Model(&do).Table("messages").Upsert("message_type=values(message_type)", "unread_count=unread_count+values(unread_count)") ---------------------------------------------------------------------------------------------------------------------------------------

func (*Engine) Where 

func (e *Engine) Where(strWhere string, args ...interface{}) *Engine

orm where condition

type Fetcher 

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

type Join 

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

func (*Join) On 

func (j *Join) On(strOn string, args ...interface{}) *Engine

type JoinType 

type JoinType int

func (JoinType) GoString 

func (t JoinType) GoString() string

func (JoinType) String 

func (t JoinType) String() string

func (JoinType) ToKeyWord 

func (t JoinType) ToKeyWord() string

type ModelReflector 

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

func (*ModelReflector) ToMap 

func (s *ModelReflector) ToMap(tagNames ...string) map[string]interface{}

parse struct tag and value to map

type ModelType 

type ModelType int

func (ModelType) GoString 

func (m ModelType) GoString() string

func (ModelType) String 

func (m ModelType) String() string

type OperType 

type OperType int
const (
	OperType_Query     OperType = 1  // orm: query sql
	OperType_Update    OperType = 2  // orm: update sql
	OperType_Insert    OperType = 3  // orm: insert sql
	OperType_Upsert    OperType = 4  // orm: insert or update sql
	OperType_Tx        OperType = 5  // orm: tx sql
	OperType_QueryRaw  OperType = 6  // raw: query sql into model
	OperType_ExecRaw   OperType = 7  // raw: insert/update sql
	OperType_QueryMap  OperType = 8  // raw: query sql into map
	OperType_Delete    OperType = 9  // orm: delete sql
	OperType_ForUpdate OperType = 10 // orm: select ... for update sql
)

func (OperType) GoString 

func (o OperType) GoString() string

func (OperType) String 

func (o OperType) String() string

type Options 

type Options struct {
	Debug bool //enable debug mode
	Max   int  //max active connections
	Idle  int  //max idle connections
	Slave bool //is a slave DSN ?
	SSH   *SSH //SSH tunnel server config
}

type SSH 

type SSH struct {
	User       string //SSH tunnel server login account
	Password   string //SSH tunnel server login password
	PrivateKey string //SSH tunnel server private key, eg. "/home/test/.ssh/private-key.pem"
	Host       string //SSH tunnel server host [ip or domain], default port 22 if not specified
	// contains filtered or unexported fields
}

func (*SSH) GoString 

func (s *SSH) GoString() string

func (*SSH) String 

func (s *SSH) String() string

type TxHandler 

type TxHandler interface {
	OnTransaction(tx *Engine) error
}

type UrlInfo 

type UrlInfo struct {
	Scheme     string
	Host       string // host name and port like '127.0.0.1:3306'
	User       string
	Password   string
	Path       string
	Fragment   string
	Opaque     string
	ForceQuery bool
	Queries    map[string]string
}

func ParseUrl 

func ParseUrl(strUrl string) (ui *UrlInfo)

URL have some special characters in password(支持URL中密码包含特殊字符)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.