db

type ColumnDescription struct {
	DbName                string // name in database. Blank if this is a "virtual" table for sql tables. i.e. an association or virtual attribute query
	GoName                string
	NativeType            string       // type of table based on native description of table
	GoType                GoColumnType // represents a basic go type
	MaxCharLength         uint64       // To help fields limit the number of characters or bytes they will accept, when its known
	DefaultValue          interface{}  // gets cast to the goType
	MaxValue              interface{}
	MinValue              interface{}
	IsId                  bool // Is this a unique identifier that is generated by the database system?
	IsPk                  bool // A primary key. Could be generated by us.
	IsNullable            bool
	IsIndexed             bool // Does it have a single index on itself. Will generate a LoadBy function
	IsUnique              bool
	IsAutoUpdateTimestamp bool // Database is auto updating this timestamp, or
	ShouldUpdateTimestamp bool // We should generate code to auto update this timestamp.
	Comment               string

	// Filled in by analyzer
	Options    *maps.SliceMap
	ForeignKey *ForeignKeyType
	ModelName  string // code generating convenience. The internal name in the model corresponding to this column.
}

type Copier interface {
	Copy() interface{}
}

type DatabaseDescription struct {
	// The database key corresponding to its key in the global database cluster
	DbKey  string
	Tables []*TableDescription
	// Type tables contain a description of an enumerated type
	TypeTables []*TypeTableDescription
	// The prefix for related objects.
	AssociatedObjectPrefix string

	// Text to strip off the end of foreign key references when converting to names. Defaults to "_id"
	ForeignKeySuffix string
	// contains filtered or unexported fields
}

type DatabaseI interface {
	Describe() *DatabaseDescription

	// For codegen
	GoStructPrefix() string
	AssociatedObjectPrefix() string

	// Aid to build queries and deletes
	NewBuilder() QueryBuilderI

	Update(ctx context.Context, table string, fields map[string]interface{}, pkName string, pkValue string)
	Insert(ctx context.Context, table string, fields map[string]interface{}) string
	Delete(ctx context.Context, table string, pkName string, pkValue interface{})

	Begin(ctx context.Context) TransactionID
	Commit(ctx context.Context, txid TransactionID)
	Rollback(ctx context.Context, txid TransactionID)
}

type Describer interface {
	Describe() *DatabaseDescription
}

type FKAction int

type ForeignKeyDescription struct {
	KeyName        string
	Columns        []string
	RelationSchema string
	RelationTable  string
	// contains filtered or unexported fields
}

type ForeignKeyType struct {
	//DbKey string	// We don't support cross database foreign keys yet. Someday maybe.
	TableName    string
	ColumnName   string
	UpdateAction FKAction
	DeleteAction FKAction
	GoName       string // The name we should use to refer to the related object
	GoType       string // The type of the related object
	IsType       bool
	RR           *ReverseReference // Filled in by analyzer, the corresponding
}

type IndexDescription struct {
	KeyName     string
	IsUnique    bool
	IsPrimary   bool
	ColumnNames []string
}

type LoaderFunc func(QueryBuilderI, map[string]interface{})

type ManyManyReference struct {
	// NoSQL: The originating table. SQL: The association table
	AssnTableName string
	// NoSQL: The table storing the array of ids on the other end. SQL: the table in the association table pointing towards us.
	AssnColumnName string

	// NoSQL & SQL: The table we are joining to
	AssociatedTableName string
	// NoSQL: table point backwards to us. SQL: Column in association table pointing forwards to refTable
	AssociatedColumnName string

	AssociatedObjectName string

	// The virtual table names used to describe the objects on the other end of the association
	GoName   string
	GoPlural string

	IsTypeAssociation bool
	Options           maps.SliceMap

	MM *ManyManyReference // ManyManyReference pointing back towards this one
}

type Mysql5 struct {
	SqlDb
	// contains filtered or unexported fields
}

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

type ProfileEntry struct {
	DbKey     string
	BeginTime time.Time
	EndTime   time.Time
	Typ       string
	Sql       string
}

type ReverseReference struct {
	DbTable              string
	DbColumn             string
	AssociatedTableName  string
	AssociatedColumnName string
	GoName               string
	GoPlural             string
	GoType               string
	IsUnique             bool
}

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

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

type SqlDbI interface {
	Exec(ctx context.Context, sql string, args ...interface{}) (r sql.Result, err error)
	Query(ctx context.Context, sql string, args ...interface{}) (r *sql.Rows, err error)
	TypeTableSuffix() string
	AssociationTableSuffix() string
	// contains filtered or unexported methods
}

type SqlReceiver struct {
	R interface{}
}

type TableDescription struct {
	// Key used to find database in the global database cluster
	DbKey string
	// The name of the database table or object
	DbName string
	// The literal name of the object when describing it to the world. Use the "literalName" option in the comment to override the default. Should be lower case.
	LiteralName string
	// The plural name of the object. Use the "literalPlural" option in the comment to override the default. Should be lower case.
	LiteralPlural string
	// The name of the struct when referring to it in go code. Use the "goName" option in the comment to override the default.
	GoName string
	// The name of a collection of these objects when referring to them in go code. Use the "goPlural" option in the comment to override the default.
	GoPlural string
	// same as GoName, but with first letter lower case
	LcGoName string
	Columns  []*ColumnDescription

	Indexes       []IndexDescription // Creates LoadBy functions. Mapped by index name.
	Options       maps.SliceMap
	IsType        bool
	IsAssociation bool
	Comment       string

	// The following items are filled in by the analyze process
	ManyManyReferences []*ManyManyReference
	ReverseReferences  []*ReverseReference
	HasDateTime        bool
	PrimaryKeyColumn   *ColumnDescription

	// Do not process this table
	Skip bool
	// contains filtered or unexported fields
}

type TransactionID int

type TypeTableDescription struct {
	// Key used to find database in the global database cluster
	DbKey string
	// Name in the database
	DbName string
	// The english name of the object when describing it to the world. Use the "literalName" option in the comment to override the default.
	EnglishName string
	// The plural english name of the object. Use the "literalPlural" option in the comment to override the default.
	EnglishPlural string
	// The name of the item as a go type name.
	GoName     string
	GoPlural   string
	LcGoName   string
	FieldNames []string // The first field name MUST be the name of the id field, and 2nd MUST be the name of the name field, the others are optional extra fields
	FieldTypes map[string]GoColumnType
	Values     []map[string]interface{}

	PkField string

	// Filled in by analyzer
	Constants map[uint]string
}

type ValueMap map[string]interface{}