Documentation ¶
Index ¶
- Constants
- Variables
- func SQLType2Type(st SQLType) reflect.Type
- func SQLTypeName(tp string) string
- type Collation
- type Column
- type DBType
- type Index
- type PK
- type Quoter
- func (q Quoter) IsEmpty() bool
- func (q Quoter) Join(a []string, sep string) string
- func (q Quoter) JoinWrite(b *strings.Builder, a []string, sep string) error
- func (q Quoter) Quote(s string) string
- func (q Quoter) QuoteTo(buf *strings.Builder, value string) error
- func (q Quoter) Replace(sql string) string
- func (q Quoter) Strings(s []string) []string
- func (q Quoter) Trim(s string) string
- type SQLType
- type Table
- func (table *Table) AddColumn(col *Column)
- func (table *Table) AddIndex(index *Index)
- func (table *Table) AutoIncrColumn() *Column
- func (table *Table) ColumnType(name string) reflect.Type
- func (table *Table) Columns() []*Column
- func (table *Table) ColumnsSeq() []string
- func (table *Table) DeletedColumn() *Column
- func (table *Table) GetColumn(name string) *Column
- func (table *Table) GetColumnIdx(name string, idx int) *Column
- func (table *Table) IDOfV(rv reflect.Value) (PK, error)
- func (table *Table) PKColumns() []*Column
- func (table *Table) UpdatedColumn() *Column
- func (table *Table) VersionColumn() *Column
- type Version
Constants ¶
const ( TWOSIDES = iota + 1 ONLYTODB ONLYFROMDB )
enumerates all database mapping way
const ( IndexType = iota + 1 UniqueType )
enumerate all index types
const ( UNKNOW_TYPE = iota TEXT_TYPE BLOB_TYPE TIME_TYPE NUMERIC_TYPE ARRAY_TYPE BOOL_TYPE )
enumerates all columns types
Variables ¶
var ( // AlwaysNoReserve always think it's not a reverse word AlwaysNoReserve = func(string) bool { return false } // AlwaysReserve always reverse the word AlwaysReserve = func(string) bool { return true } // CommanQuoteMark represnets the common quote mark CommanQuoteMark byte = '`' // CommonQuoter represetns a common quoter CommonQuoter = Quoter{CommanQuoteMark, CommanQuoteMark, AlwaysReserve} )
var ( Bit = "BIT" UnsignedBit = "UNSIGNED BIT" TinyInt = "TINYINT" UnsignedTinyInt = "UNSIGNED TINYINT" SmallInt = "SMALLINT" UnsignedSmallInt = "UNSIGNED SMALLINT" MediumInt = "MEDIUMINT" UnsignedMediumInt = "UNSIGNED MEDIUMINT" Int = "INT" UnsignedInt = "UNSIGNED INT" Integer = "INTEGER" BigInt = "BIGINT" UnsignedBigInt = "UNSIGNED BIGINT" Number = "NUMBER" Enum = "ENUM" Set = "SET" Char = "CHAR" Varchar = "VARCHAR" VARCHAR2 = "VARCHAR2" NChar = "NCHAR" NVarchar = "NVARCHAR" TinyText = "TINYTEXT" Text = "TEXT" NText = "NTEXT" Clob = "CLOB" MediumText = "MEDIUMTEXT" LongText = "LONGTEXT" Uuid = "UUID" UniqueIdentifier = "UNIQUEIDENTIFIER" SysName = "SYSNAME" Date = "DATE" DateTime = "DATETIME" SmallDateTime = "SMALLDATETIME" Time = "TIME" TimeStamp = "TIMESTAMP" TimeStampz = "TIMESTAMPZ" Year = "YEAR" Decimal = "DECIMAL" Numeric = "NUMERIC" Money = "MONEY" SmallMoney = "SMALLMONEY" Real = "REAL" Float = "FLOAT" UnsignedFloat = "UNSIGNED FLOAT" Double = "DOUBLE" Binary = "BINARY" VarBinary = "VARBINARY" TinyBlob = "TINYBLOB" Blob = "BLOB" MediumBlob = "MEDIUMBLOB" LongBlob = "LONGBLOB" Bytea = "BYTEA" Bool = "BOOL" Boolean = "BOOLEAN" Serial = "SERIAL" BigSerial = "BIGSERIAL" Json = "JSON" Jsonb = "JSONB" XML = "XML" Array = "ARRAY" SqlTypes = map[string]int{ Bit: NUMERIC_TYPE, UnsignedBit: NUMERIC_TYPE, TinyInt: NUMERIC_TYPE, UnsignedTinyInt: NUMERIC_TYPE, SmallInt: NUMERIC_TYPE, UnsignedSmallInt: NUMERIC_TYPE, MediumInt: NUMERIC_TYPE, UnsignedMediumInt: NUMERIC_TYPE, Int: NUMERIC_TYPE, UnsignedInt: NUMERIC_TYPE, Integer: NUMERIC_TYPE, BigInt: NUMERIC_TYPE, UnsignedBigInt: NUMERIC_TYPE, Number: NUMERIC_TYPE, Enum: TEXT_TYPE, Set: TEXT_TYPE, Json: TEXT_TYPE, Jsonb: TEXT_TYPE, XML: TEXT_TYPE, Char: TEXT_TYPE, NChar: TEXT_TYPE, Varchar: TEXT_TYPE, VARCHAR2: TEXT_TYPE, NVarchar: TEXT_TYPE, TinyText: TEXT_TYPE, Text: TEXT_TYPE, NText: TEXT_TYPE, MediumText: TEXT_TYPE, LongText: TEXT_TYPE, Uuid: TEXT_TYPE, Clob: TEXT_TYPE, SysName: TEXT_TYPE, Date: TIME_TYPE, DateTime: TIME_TYPE, Time: TIME_TYPE, TimeStamp: TIME_TYPE, TimeStampz: TIME_TYPE, SmallDateTime: TIME_TYPE, Year: TIME_TYPE, Decimal: NUMERIC_TYPE, Numeric: NUMERIC_TYPE, Real: NUMERIC_TYPE, Float: NUMERIC_TYPE, UnsignedFloat: NUMERIC_TYPE, Double: NUMERIC_TYPE, Money: NUMERIC_TYPE, SmallMoney: NUMERIC_TYPE, Binary: BLOB_TYPE, VarBinary: BLOB_TYPE, TinyBlob: BLOB_TYPE, Blob: BLOB_TYPE, MediumBlob: BLOB_TYPE, LongBlob: BLOB_TYPE, Bytea: BLOB_TYPE, UniqueIdentifier: BLOB_TYPE, Bool: BOOL_TYPE, Boolean: BOOL_TYPE, Serial: NUMERIC_TYPE, BigSerial: NUMERIC_TYPE, "INT8": NUMERIC_TYPE, Array: ARRAY_TYPE, } )
enumerates all the database column types
var ( IntType = reflect.TypeOf((*int)(nil)).Elem() Int8Type = reflect.TypeOf((*int8)(nil)).Elem() Int16Type = reflect.TypeOf((*int16)(nil)).Elem() Int32Type = reflect.TypeOf((*int32)(nil)).Elem() Int64Type = reflect.TypeOf((*int64)(nil)).Elem() UintType = reflect.TypeOf((*uint)(nil)).Elem() Uint8Type = reflect.TypeOf((*uint8)(nil)).Elem() Uint16Type = reflect.TypeOf((*uint16)(nil)).Elem() Uint32Type = reflect.TypeOf((*uint32)(nil)).Elem() Uint64Type = reflect.TypeOf((*uint64)(nil)).Elem() Float32Type = reflect.TypeOf((*float32)(nil)).Elem() Float64Type = reflect.TypeOf((*float64)(nil)).Elem() Complex64Type = reflect.TypeOf((*complex64)(nil)).Elem() Complex128Type = reflect.TypeOf((*complex128)(nil)).Elem() StringType = reflect.TypeOf((*string)(nil)).Elem() BoolType = reflect.TypeOf((*bool)(nil)).Elem() ByteType = reflect.TypeOf((*byte)(nil)).Elem() BytesType = reflect.SliceOf(ByteType) TimeType = reflect.TypeOf((*time.Time)(nil)).Elem() BigFloatType = reflect.TypeOf((*big.Float)(nil)).Elem() NullFloat64Type = reflect.TypeOf((*sql.NullFloat64)(nil)).Elem() NullStringType = reflect.TypeOf((*sql.NullString)(nil)).Elem() NullInt32Type = reflect.TypeOf((*sql.NullInt32)(nil)).Elem() NullInt64Type = reflect.TypeOf((*sql.NullInt64)(nil)).Elem() NullBoolType = reflect.TypeOf((*sql.NullBool)(nil)).Elem() )
enumerates all types
Functions ¶
func SQLType2Type ¶
SQLType2Type convert default sql type change to go types
func SQLTypeName ¶ added in v1.2.2
SQLTypeName returns sql type name
Types ¶
type Column ¶
type Column struct { Name string TableName string FieldName string // Available only when parsed from a struct FieldIndex []int // Available only when parsed from a struct SQLType SQLType IsJSON bool Length int64 Length2 int64 Nullable bool Default string Indexes map[string]int IsPrimaryKey bool IsAutoIncrement bool MapType int IsCreated bool IsUpdated bool IsDeleted bool IsCascade bool IsVersion bool DefaultIsEmpty bool // false means column has no default set, but not default value is empty EnumOptions map[string]int SetOptions map[string]int DisableTimeZone bool TimeZone *time.Location // column specified time zone Comment string Collation string }
Column defines database column
type Index ¶
Index represents a database index
type PK ¶
type PK []interface{}
PK represents primary key values
func (*PK) FromString ¶
FromString reads content to load primary keys
type Quoter ¶
Quoter represents a quoter to the SQL table name and column name
func (Quoter) QuoteTo ¶
QuoteTo quotes the table or column names. i.e. if the quotes are [ and ]
name -> [name] `name` -> [name] [name] -> [name] schema.name -> [schema].[name] `schema`.`name` -> [schema].[name] `schema`.name -> [schema].[name] schema.`name` -> [schema].[name] [schema].name -> [schema].[name] schema.[name] -> [schema].[name] name AS a -> [name] AS a schema.name AS a -> [schema].[name] AS a
type SQLType ¶
SQLType represents SQL types
func Type2SQLType ¶
Type2SQLType generate SQLType acorrding Go's type
type Table ¶
type Table struct { Name string Type reflect.Type Indexes map[string]*Index PrimaryKeys []string AutoIncrement string Created map[string]bool Updated string Deleted string Version string StoreEngine string Charset string Comment string Collation string // contains filtered or unexported fields }
Table represents a database table
func (*Table) AutoIncrColumn ¶
AutoIncrColumn returns autoincrement column
func (*Table) ColumnType ¶
ColumnType returns a column's type
func (*Table) ColumnsSeq ¶
ColumnsSeq returns table's column names according sequence
func (*Table) DeletedColumn ¶
DeletedColumn returns deleted column's information
func (*Table) GetColumn ¶
GetColumn returns column according column name, if column not found, return nil
func (*Table) GetColumnIdx ¶
GetColumnIdx returns column according name and idx
func (*Table) UpdatedColumn ¶
UpdatedColumn returns updated column's information
func (*Table) VersionColumn ¶
VersionColumn returns version column's information