schema

package
v1.0.8 Latest Latest
Warning

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

 Go to latest Published: Sep 18, 2021 License: BSD-2-Clause Imports: 21 Imported by: 47

Documentation

Index

Constants

View Source 
const (
	InvalidRelation = iota
	HasOneRelation
	BelongsToRelation
	HasManyRelation
	ManyToManyRelation
)

Variables

This section is empty.

Functions

func Append 

func Append(fmter Formatter, b []byte, v interface{}, custom CustomAppender) []byte

func AppendBoolValue added in v0.1.6 

func AppendBoolValue(fmter Formatter, b []byte, v reflect.Value) []byte

func AppendFloat32Value added in v0.1.6 

func AppendFloat32Value(fmter Formatter, b []byte, v reflect.Value) []byte

func AppendFloat64Value added in v0.1.6 

func AppendFloat64Value(fmter Formatter, b []byte, v reflect.Value) []byte

func AppendIntValue 

func AppendIntValue(fmter Formatter, b []byte, v reflect.Value) []byte

func AppendJSONValue added in v0.3.4 

func AppendJSONValue(fmter Formatter, b []byte, v reflect.Value) []byte

func AppendQueryAppender 

func AppendQueryAppender(fmter Formatter, b []byte, app QueryAppender) []byte

func AppendStringValue added in v0.3.4 

func AppendStringValue(fmter Formatter, b []byte, v reflect.Value) []byte

func AppendUintValue 

func AppendUintValue(fmter Formatter, b []byte, v reflect.Value) []byte

func DiscoverSQLType added in v0.1.17 

func DiscoverSQLType(typ reflect.Type) string

func SetTableNameInflector 

func SetTableNameInflector(fn func(string) string)

SetTableNameInflector overrides the default func that pluralizes model name to get table name, e.g. my_article becomes my_articles.

Types

type AfterScanHook 

type AfterScanHook interface {
	AfterScan(context.Context) error
}

type AppenderFunc 

type AppenderFunc func(fmter Formatter, b []byte, v reflect.Value) []byte

func Appender 

func Appender(typ reflect.Type, custom CustomAppender) AppenderFunc

func FieldAppender 

func FieldAppender(dialect Dialect, field *Field) AppenderFunc

func PtrAppender added in v1.0.3 

func PtrAppender(fn AppenderFunc) AppenderFunc

type BaseModel added in v0.3.1 

type BaseModel struct{}

type BeforeScanHook 

type BeforeScanHook interface {
	BeforeScan(context.Context) error
}

type ColumnsAppender 

type ColumnsAppender interface {
	AppendColumns(fmter Formatter, b []byte) ([]byte, error)
}

type CustomAppender added in v0.3.4 

type CustomAppender func(typ reflect.Type) AppenderFunc

type Dialect 

type Dialect interface {
	Init(db *sql.DB)

	Name() dialect.Name
	Features() feature.Feature

	Tables() *Tables
	OnTable(table *Table)

	IdentQuote() byte
	Append(fmter Formatter, b []byte, v interface{}) []byte
	Appender(typ reflect.Type) AppenderFunc
	FieldAppender(field *Field) AppenderFunc
	Scanner(typ reflect.Type) ScannerFunc
}

type Field 

type Field struct {
	StructField reflect.StructField

	Tag          tagparser.Tag
	IndirectType reflect.Type
	Index        []int

	Name    string // SQL name, .e.g. id
	SQLName Safe   // escaped SQL name, e.g. "id"
	GoName  string // struct field name, e.g. Id

	DiscoveredSQLType  string
	UserSQLType        string
	CreateTableSQLType string
	SQLDefault         string

	OnDelete string
	OnUpdate string

	IsPK          bool
	NotNull       bool
	NullZero      bool
	AutoIncrement bool

	Append AppenderFunc
	Scan   ScannerFunc
	IsZero IsZeroerFunc
}

func (*Field) AppendValue 

func (f *Field) AppendValue(fmter Formatter, b []byte, strct reflect.Value) []byte

func (*Field) Clone 

func (f *Field) Clone() *Field

func (*Field) HasZeroValue 

func (f *Field) HasZeroValue(v reflect.Value) bool

func (*Field) ScanValue 

func (f *Field) ScanValue(strct reflect.Value, src interface{}) error

func (*Field) ScanWithCheck 

func (f *Field) ScanWithCheck(fv reflect.Value, src interface{}) error

func (*Field) String 

func (f *Field) String() string

func (*Field) Value 

func (f *Field) Value(strct reflect.Value) reflect.Value

type Formatter 

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

func NewFormatter 

func NewFormatter(dialect Dialect) Formatter

func NewNopFormatter 

func NewNopFormatter() Formatter

func (Formatter) AppendIdent 

func (f Formatter) AppendIdent(b []byte, ident string) []byte

func (Formatter) AppendQuery 

func (f Formatter) AppendQuery(dst []byte, query string, args ...interface{}) []byte

func (Formatter) AppendValue 

func (f Formatter) AppendValue(b []byte, v reflect.Value) []byte

func (Formatter) Dialect 

func (f Formatter) Dialect() Dialect

func (Formatter) FormatQuery 

func (f Formatter) FormatQuery(query string, args ...interface{}) string

func (Formatter) HasFeature 

func (f Formatter) HasFeature(feature feature.Feature) bool

func (Formatter) IdentQuote 

func (f Formatter) IdentQuote() byte

func (Formatter) IsNop 

func (f Formatter) IsNop() bool

func (Formatter) WithArg 

func (f Formatter) WithArg(arg NamedArgAppender) Formatter

func (Formatter) WithNamedArg added in v0.4.3 

func (f Formatter) WithNamedArg(name string, value interface{}) Formatter

type Ident 

type Ident string

Ident represents a SQL identifier, for example, table or column name.

func (Ident) AppendQuery 

func (s Ident) AppendQuery(fmter Formatter, b []byte) ([]byte, error)

type IsZeroerFunc 

type IsZeroerFunc func(reflect.Value) bool

type NamedArgAppender added in v0.4.0 

type NamedArgAppender interface {
	AppendNamedArg(fmter Formatter, b []byte, name string) ([]byte, bool)
}

type NullTime added in v0.1.17 

type NullTime struct {
	time.Time
}

NullTime is a time.Time wrapper that marshals zero time as JSON null and SQL NULL.

func (NullTime) AppendQuery added in v0.1.17 

func (tm NullTime) AppendQuery(fmter Formatter, b []byte) ([]byte, error)

func (NullTime) MarshalJSON added in v0.1.17 

func (tm NullTime) MarshalJSON() ([]byte, error)

func (*NullTime) Scan added in v0.1.17 

func (tm *NullTime) Scan(src interface{}) error

func (*NullTime) UnmarshalJSON added in v0.1.17 

func (tm *NullTime) UnmarshalJSON(b []byte) error

type Query added in v1.0.5 

type Query interface {
	QueryAppender
	Operation() string
}

type QueryAppender 

type QueryAppender interface {
	AppendQuery(fmter Formatter, b []byte) ([]byte, error)
}

type QueryWithArgs 

type QueryWithArgs struct {
	Query string
	Args  []interface{}
}

func SafeQuery 

func SafeQuery(query string, args []interface{}) QueryWithArgs

func UnsafeIdent 

func UnsafeIdent(ident string) QueryWithArgs

func (QueryWithArgs) AppendQuery 

func (q QueryWithArgs) AppendQuery(fmter Formatter, b []byte) ([]byte, error)

func (QueryWithArgs) IsZero 

func (q QueryWithArgs) IsZero() bool

type QueryWithSep 

type QueryWithSep struct {
	QueryWithArgs
	Sep string
}

func SafeQueryWithSep 

func SafeQueryWithSep(query string, args []interface{}, sep string) QueryWithSep

type Relation 

type Relation struct {
	Type       int
	Field      *Field
	JoinTable  *Table
	BaseFields []*Field
	JoinFields []*Field

	PolymorphicField *Field
	PolymorphicValue string

	M2MTable      *Table
	M2MBaseFields []*Field
	M2MJoinFields []*Field
}

func (*Relation) String 

func (r *Relation) String() string

type Safe 

type Safe string

Safe represents a safe SQL query.

func (Safe) AppendQuery 

func (s Safe) AppendQuery(fmter Formatter, b []byte) ([]byte, error)

type ScannerFunc 

type ScannerFunc func(dest reflect.Value, src interface{}) error

func FieldScanner 

func FieldScanner(dialect Dialect, field *Field) ScannerFunc

func PtrScanner added in v1.0.3 

func PtrScanner(fn ScannerFunc) ScannerFunc

func Scanner 

func Scanner(typ reflect.Type) ScannerFunc

type Table 

type Table struct {
	Type      reflect.Type
	ZeroValue reflect.Value // reflect.Struct
	ZeroIface interface{}   // struct pointer

	TypeName  string
	ModelName string

	Name              string
	SQLName           Safe
	SQLNameForSelects Safe
	Alias             string
	SQLAlias          Safe

	Fields     []*Field // PKs + DataFields
	PKs        []*Field
	DataFields []*Field

	FieldMap map[string]*Field

	Relations map[string]*Relation
	Unique    map[string][]*Field

	SoftDeleteField       *Field
	UpdateSoftDeleteField func(fv reflect.Value, tm time.Time) error
	// contains filtered or unexported fields
}

Table represents a SQL table created from Go struct.

func (*Table) AppendNamedArg added in v0.4.3 

func (t *Table) AppendNamedArg(
	fmter Formatter, b []byte, name string, strct reflect.Value,
) ([]byte, bool)

func (*Table) CheckPKs 

func (t *Table) CheckPKs() error

func (*Table) Dialect 

func (t *Table) Dialect() Dialect

func (*Table) Field 

func (t *Table) Field(name string) (*Field, error)

func (*Table) HasAfterScanHook 

func (t *Table) HasAfterScanHook() bool

func (*Table) HasBeforeScanHook 

func (t *Table) HasBeforeScanHook() bool

func (*Table) HasField 

func (t *Table) HasField(name string) bool

func (*Table) String 

func (t *Table) String() string

type Tables 

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

func NewTables 

func NewTables(dialect Dialect) *Tables

func (*Tables) ByModel 

func (t *Tables) ByModel(name string) *Table

func (*Tables) ByName 

func (t *Tables) ByName(name string) *Table

func (*Tables) Get 

func (t *Tables) Get(typ reflect.Type) *Table

func (*Tables) Ref 

func (t *Tables) Ref(typ reflect.Type) *Table

func (*Tables) Register 

func (t *Tables) Register(models ...interface{})

Source Files

View all Source files

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.