schema

Documentation

Index

• Variables
• func ParseTagSetting(str string, sep string) map[string]string
• func ToString(value interface{}) string
• type DataType
• type Field
• type Namer
• type NamingStrategy
  • func (ns NamingStrategy) ColumnName(table, column string) string
  • func (ns NamingStrategy) IndexName(table, column string) string
  • func (ns NamingStrategy) SchemaName(table string) string
  • func (ns NamingStrategy) TableName(str string) string
• type Replacer
• type Schema
  • func Parse(dest interface{}, cacheStore *sync.Map, namer Namer) (*Schema, error)
  • func (schema Schema) LookUpField(name string) *Field
  • func (schema *Schema) ParseField(fieldStruct reflect.StructField) *Field

Variables

var ErrUnsupportedDataType = errors.New("unsupported data type")

ErrUnsupportedDataType unsupported data type

var TimeReflectType = reflect.TypeOf(time.Time{})

Functions

func ParseTagSetting

func ParseTagSetting(str string, sep string) map[string]string

func ToString

func ToString(value interface{}) string

Types

type DataType

type DataType string

const (
	Bool   DataType = "bool"
	Int    DataType = "int"
	Uint   DataType = "uint"
	Float  DataType = "float"
	String DataType = "string"
	Time   DataType = "time"
	Bytes  DataType = "bytes"
)

type Field

type Field struct {
	Name              string
	DBName            string
	BindNames         []string
	DataType          DataType
	Precision         int
	FieldType         reflect.Type
	IndirectFieldType reflect.Type
	StructField       reflect.StructField
	TagSettings       map[string]string
	ReflectValueOf    func(reflect.Value) reflect.Value
	ValueOf           func(reflect.Value) (value interface{}, zero bool)
	Set               func(reflect.Value, interface{}) error
}

type Namer

type Namer interface {
	TableName(table string) string
	SchemaName(table string) string
	ColumnName(table, column string) string
	IndexName(table, column string) string
}

type NamingStrategy

type NamingStrategy struct {
	TablePrefix  string
	NameReplacer Replacer
}

func (NamingStrategy) ColumnName

func (ns NamingStrategy) ColumnName(table, column string) string

func (NamingStrategy) IndexName

func (ns NamingStrategy) IndexName(table, column string) string

func (NamingStrategy) SchemaName

func (ns NamingStrategy) SchemaName(table string) string

func (NamingStrategy) TableName

func (ns NamingStrategy) TableName(str string) string

type Replacer

type Replacer interface {
	Replace(name string) string
}

type Schema

type Schema struct {
	Name           string
	Table          string
	ModelType      reflect.Type
	FieldsByName   map[string]*Field
	FieldsByDBName map[string]*Field
	Fields         []*Field
	DBNames        []string
	// contains filtered or unexported fields
}

func Parse

func Parse(dest interface{}, cacheStore *sync.Map, namer Namer) (*Schema, error)

func (Schema) LookUpField

func (schema Schema) LookUpField(name string) *Field

func (*Schema) ParseField

func (schema *Schema) ParseField(fieldStruct reflect.StructField) *Field