Documentation
¶
Index ¶
- Variables
- func GetIdentityFieldValuesMap(ctx context.Context, reflectValue reflect.Value, fields []*Field) (map[string][]reflect.Value, [][]interface{})
- func GetIdentityFieldValuesMapFromValues(ctx context.Context, values []interface{}, fields []*Field) (map[string][]reflect.Value, [][]interface{})
- func GetRelationsValues(ctx context.Context, reflectValue reflect.Value, rels []*Relationship) (reflectResults reflect.Value)
- func ParseTagSetting(str string, sep string) map[string]string
- func RegisterSerializer(name string, serializer SerializerInterface)
- func ToQueryValues(table string, foreignKeys []string, foreignValues [][]interface{}) (interface{}, []interface{})
- type Check
- type Constraint
- type CreateClausesInterface
- type DataType
- type DeleteClausesInterface
- type Field
- type FieldNewValuePool
- type GobSerializer
- type GormDataTypeInterface
- type Index
- type IndexOption
- type JSONSerializer
- type Namer
- type NamingStrategy
- func (ns NamingStrategy) CheckerName(table, column string) string
- func (ns NamingStrategy) ColumnName(table, column string) string
- func (ns NamingStrategy) IndexName(table, column string) string
- func (ns NamingStrategy) JoinTableName(str string) string
- func (ns NamingStrategy) RelationshipFKName(rel Relationship) string
- func (ns NamingStrategy) SchemaName(table string) string
- func (ns NamingStrategy) TableName(str string) string
- type Polymorphic
- type QueryClausesInterface
- type Reference
- type Relationship
- type RelationshipType
- type Relationships
- type Replacer
- type Schema
- func (schema *Schema) LookIndex(name string) *Index
- func (schema Schema) LookUpField(name string) *Field
- func (schema Schema) MakeSlice() reflect.Value
- func (schema *Schema) ParseCheckConstraints() map[string]Check
- func (schema *Schema) ParseField(fieldStruct reflect.StructField) *Field
- func (schema *Schema) ParseIndexes() map[string]Index
- func (schema Schema) String() string
- type SerializerInterface
- type SerializerValuerInterface
- type Tabler
- type TablerWithNamer
- type TimeType
- type UnixSecondSerializer
- type UpdateClausesInterface
Constants ¶
This section is empty.
Variables ¶
var ( TimeReflectType = reflect.TypeOf(time.Time{}) TimePtrReflectType = reflect.TypeOf(&time.Time{}) ByteReflectType = reflect.TypeOf(uint8(0)) )
special types' reflect type
var ErrUnsupportedDataType = errors.New("unsupported data type")
ErrUnsupportedDataType unsupported data type
Functions ¶
func GetIdentityFieldValuesMap ¶
func GetIdentityFieldValuesMap(ctx context.Context, reflectValue reflect.Value, fields []*Field) (map[string][]reflect.Value, [][]interface{})
GetIdentityFieldValuesMap get identity map from fields
func GetIdentityFieldValuesMapFromValues ¶
func GetIdentityFieldValuesMapFromValues(ctx context.Context, values []interface{}, fields []*Field) (map[string][]reflect.Value, [][]interface{})
GetIdentityFieldValuesMapFromValues get identity map from fields
func GetRelationsValues ¶
func GetRelationsValues(ctx context.Context, reflectValue reflect.Value, rels []*Relationship) (reflectResults reflect.Value)
GetRelationsValues get relations's values from a reflect value
func RegisterSerializer ¶
func RegisterSerializer(name string, serializer SerializerInterface)
RegisterSerializer register serializer
func ToQueryValues ¶
func ToQueryValues(table string, foreignKeys []string, foreignValues [][]interface{}) (interface{}, []interface{})
ToQueryValues to query values
Types ¶
type Constraint ¶
type CreateClausesInterface ¶
CreateClausesInterface create clauses interface
type DeleteClausesInterface ¶
DeleteClausesInterface delete clauses interface
type Field ¶
type Field struct {
Name string
DBName string
BindNames []string
DataType DataType
GORMDataType DataType
PrimaryKey bool
AutoIncrement bool
AutoIncrementIncrement int64
Creatable bool
Updatable bool
Readable bool
AutoCreateTime TimeType
AutoUpdateTime TimeType
HasDefaultValue bool
DefaultValue string
DefaultValueInterface interface{}
NotNull bool
Unique bool
Comment string
Size int
Precision int
Scale int
IgnoreMigration bool
FieldType reflect.Type
IndirectFieldType reflect.Type
StructField reflect.StructField
Tag reflect.StructTag
TagSettings map[string]string
Schema *Schema
EmbeddedSchema *Schema
OwnerSchema *Schema
ReflectValueOf func(context.Context, reflect.Value) reflect.Value
ValueOf func(context.Context, reflect.Value) (value interface{}, zero bool)
Set func(context.Context, reflect.Value, interface{}) error
Serializer SerializerInterface
NewValuePool FieldNewValuePool
}
Field is the representation of model schema's field
type FieldNewValuePool ¶
type FieldNewValuePool interface {
Get() interface{}
Put(interface{})
}
FieldNewValuePool field new scan value pool
type GobSerializer ¶
type GobSerializer struct {
}
GobSerializer gob serializer
type GormDataTypeInterface ¶
type GormDataTypeInterface interface {
GormDataType() string
}
GormDataTypeInterface gorm data type interface
type IndexOption ¶
type JSONSerializer ¶
type JSONSerializer struct {
}
JSONSerializer json serializer
type Namer ¶
type Namer interface {
TableName(table string) string
SchemaName(table string) string
ColumnName(table, column string) string
JoinTableName(joinTable string) string
RelationshipFKName(Relationship) string
CheckerName(table, column string) string
IndexName(table, column string) string
}
Namer namer interface
type NamingStrategy ¶
type NamingStrategy struct {
TablePrefix string
SingularTable bool
NameReplacer Replacer
NoLowerCase bool
}
NamingStrategy tables, columns naming strategy
func (NamingStrategy) CheckerName ¶
func (ns NamingStrategy) CheckerName(table, column string) string
CheckerName generate checker name
func (NamingStrategy) ColumnName ¶
func (ns NamingStrategy) ColumnName(table, column string) string
ColumnName convert string to column name
func (NamingStrategy) IndexName ¶
func (ns NamingStrategy) IndexName(table, column string) string
IndexName generate index name
func (NamingStrategy) JoinTableName ¶
func (ns NamingStrategy) JoinTableName(str string) string
JoinTableName convert string to join table name
func (NamingStrategy) RelationshipFKName ¶
func (ns NamingStrategy) RelationshipFKName(rel Relationship) string
RelationshipFKName generate fk name for relation
func (NamingStrategy) SchemaName ¶
func (ns NamingStrategy) SchemaName(table string) string
SchemaName generate schema name from table name, don't guarantee it is the reverse value of TableName
func (NamingStrategy) TableName ¶
func (ns NamingStrategy) TableName(str string) string
TableName convert string to table name
type Polymorphic ¶
type QueryClausesInterface ¶
QueryClausesInterface query clauses interface
type Relationship ¶
type Relationship struct {
Name string
Type RelationshipType
Field *Field
Polymorphic *Polymorphic
References []*Reference
Schema *Schema
FieldSchema *Schema
JoinTable *Schema
// contains filtered or unexported fields
}
func (*Relationship) ParseConstraint ¶
func (rel *Relationship) ParseConstraint() *Constraint
func (*Relationship) ToQueryConditions ¶
func (rel *Relationship) ToQueryConditions(ctx context.Context, reflectValue reflect.Value) (conds []clause.Expression)
type RelationshipType ¶
type RelationshipType string
RelationshipType relationship type
const ( HasOne RelationshipType = "has_one" // HasOneRel has one relationship HasMany RelationshipType = "has_many" // HasManyRel has many relationship BelongsTo RelationshipType = "belongs_to" // BelongsToRel belongs to relationship Many2Many RelationshipType = "many_to_many" // Many2ManyRel many to many relationship )
type Relationships ¶
type Relationships struct {
HasOne []*Relationship
BelongsTo []*Relationship
HasMany []*Relationship
Many2Many []*Relationship
Relations map[string]*Relationship
}
type Schema ¶
type Schema struct {
Name string
ModelType reflect.Type
Table string
PrioritizedPrimaryField *Field
DBNames []string
PrimaryFields []*Field
PrimaryFieldDBNames []string
Fields []*Field
FieldsByName map[string]*Field
FieldsByDBName map[string]*Field
FieldsWithDefaultDBValue []*Field // fields with default value assigned by database
Relationships Relationships
CreateClauses []clause.Interface
QueryClauses []clause.Interface
UpdateClauses []clause.Interface
DeleteClauses []clause.Interface
BeforeCreate, AfterCreate bool
BeforeUpdate, AfterUpdate bool
BeforeDelete, AfterDelete bool
BeforeSave, AfterSave bool
AfterFind bool
// contains filtered or unexported fields
}
func ParseWithSpecialTableName ¶
func ParseWithSpecialTableName(dest interface{}, cacheStore *sync.Map, namer Namer, specialTableName string) (*Schema, error)
ParseWithSpecialTableName get data type from dialector with extra schema table
func (Schema) LookUpField ¶
func (*Schema) ParseCheckConstraints ¶
ParseCheckConstraints parse schema check constraints
func (*Schema) ParseField ¶
func (schema *Schema) ParseField(fieldStruct reflect.StructField) *Field
ParseField parses reflect.StructField to Field
func (*Schema) ParseIndexes ¶
ParseIndexes parse schema indexes
type SerializerInterface ¶
type SerializerInterface interface {
Scan(ctx context.Context, field *Field, dst reflect.Value, dbValue interface{}) error
SerializerValuerInterface
}
SerializerInterface serializer interface
func GetSerializer ¶
func GetSerializer(name string) (serializer SerializerInterface, ok bool)
GetSerializer get serializer
type SerializerValuerInterface ¶
type SerializerValuerInterface interface {
Value(ctx context.Context, field *Field, dst reflect.Value, fieldValue interface{}) (interface{}, error)
}
SerializerValuerInterface serializer valuer interface
type TablerWithNamer ¶
type UnixSecondSerializer ¶
type UnixSecondSerializer struct {
}
UnixSecondSerializer json serializer
type UpdateClausesInterface ¶
UpdateClausesInterface update clauses interface