forgejo/vendor/xorm.io/xorm/schemas/column.go

111 lines
2.8 KiB
Go
Raw Normal View History

// Copyright 2019 The Xorm Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package schemas
2016-11-03 23:16:01 +01:00
import (
"errors"
2016-11-03 23:16:01 +01:00
"reflect"
"strconv"
2016-11-03 23:16:01 +01:00
"time"
)
2021-05-14 21:17:06 +02:00
// enumerates all database mapping way
2016-11-03 23:16:01 +01:00
const (
TWOSIDES = iota + 1
ONLYTODB
ONLYFROMDB
)
// Column defines database column
2016-11-03 23:16:01 +01:00
type Column struct {
Name string
TableName string
2021-07-04 15:10:46 +02:00
FieldName string // Available only when parsed from a struct
FieldIndex []int // Available only when parsed from a struct
2016-11-03 23:16:01 +01:00
SQLType SQLType
IsJSON bool
2016-11-03 23:16:01 +01:00
Length int
Length2 int
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
2016-11-03 23:16:01 +01:00
EnumOptions map[string]int
SetOptions map[string]int
DisableTimeZone bool
TimeZone *time.Location // column specified time zone
Comment string
2016-11-03 23:16:01 +01:00
}
// NewColumn creates a new column
2016-11-03 23:16:01 +01:00
func NewColumn(name, fieldName string, sqlType SQLType, len1, len2 int, nullable bool) *Column {
return &Column{
Name: name,
2021-01-05 07:28:51 +01:00
IsJSON: sqlType.IsJson(),
2016-11-03 23:16:01 +01:00
TableName: "",
FieldName: fieldName,
SQLType: sqlType,
Length: len1,
Length2: len2,
Nullable: nullable,
Default: "",
Indexes: make(map[string]int),
IsPrimaryKey: false,
IsAutoIncrement: false,
MapType: TWOSIDES,
IsCreated: false,
IsUpdated: false,
IsDeleted: false,
IsCascade: false,
IsVersion: false,
DefaultIsEmpty: true, // default should be no default
2016-11-03 23:16:01 +01:00
EnumOptions: make(map[string]int),
Comment: "",
2016-11-03 23:16:01 +01:00
}
}
// ValueOf returns column's filed of struct's value
2016-11-03 23:16:01 +01:00
func (col *Column) ValueOf(bean interface{}) (*reflect.Value, error) {
dataStruct := reflect.Indirect(reflect.ValueOf(bean))
return col.ValueOfV(&dataStruct)
}
// ValueOfV returns column's filed of struct's value accept reflevt value
2016-11-03 23:16:01 +01:00
func (col *Column) ValueOfV(dataStruct *reflect.Value) (*reflect.Value, error) {
2021-07-04 15:10:46 +02:00
var v = *dataStruct
for _, i := range col.FieldIndex {
if v.Kind() == reflect.Ptr {
if v.IsNil() {
v.Set(reflect.New(v.Type().Elem()))
2016-11-03 23:16:01 +01:00
}
2021-07-04 15:10:46 +02:00
v = v.Elem()
2016-11-03 23:16:01 +01:00
}
2021-07-04 15:10:46 +02:00
v = v.FieldByIndex([]int{i})
2016-11-03 23:16:01 +01:00
}
2021-07-04 15:10:46 +02:00
return &v, nil
2016-11-03 23:16:01 +01:00
}
// ConvertID converts id content to suitable type according column type
func (col *Column) ConvertID(sid string) (interface{}, error) {
if col.SQLType.IsNumeric() {
n, err := strconv.ParseInt(sid, 10, 64)
if err != nil {
return nil, err
}
return n, nil
} else if col.SQLType.IsText() {
return sid, nil
}
return nil, errors.New("not supported")
}