internal

Documentation

Index

• Constants
• func CheckSchemaDiff(cfg *Config)
• func RemoveTableSchemaConfig(schema string) string
• type AlterIgnoreTable
• type Config
  • func LoadConfig(confPath string) *Config
  • func (cfg *Config) Check()
  • func (cfg *Config) CheckMatchIgnoreTables(name string) bool
  • func (cfg *Config) CheckMatchTables(name string) bool
  • func (cfg *Config) IsIgnoreField(table string, name string) bool
  • func (cfg *Config) IsIgnoreForeignKey(table string, name string) bool
  • func (cfg *Config) IsIgnoreIndex(table string, name string) bool
  • func (cfg *Config) SendMailFail(errStr string)
  • func (cfg *Config) SetTables(tables []string)
  • func (cfg *Config) SetTablesIgnore(tables []string)
  • func (cfg *Config) String() string
• type DbIndex
  • func (idx *DbIndex) String() string
• type EmailStruct
  • func (m *EmailStruct) SendMail(title string, body string)
• type MyDb
  • func NewMyDb(dsn string, dbType string) *MyDb
  • func (db *MyDb) GetTableNames() []string
  • func (db *MyDb) GetTableSchema(name string) (schema string)
  • func (db *MyDb) Query(query string, args ...any) (*sql.Rows, error)
• type MySchema
  • func ParseSchema(schema string) *MySchema
  • func (mys *MySchema) GetFieldNames() []string
  • func (mys *MySchema) RelationTables() []string
  • func (mys *MySchema) String() string
• type SchemaDiff
  • func (sdiff *SchemaDiff) RelationTables() []string
• type SchemaSync
  • func NewSchemaSync(config *Config) *SchemaSync
  • func (sc *SchemaSync) GetNewTableNames() []string
  • func (sc *SchemaSync) GetTableNames() []string
  • func (sc *SchemaSync) SyncSQL4Dest(sqlStr string, sqls []string) error
• type TableAlterData
  • func (ta *TableAlterData) Split() []*TableAlterData
  • func (ta *TableAlterData) String() string

Constants

const AppURL = "https://github.com/hidu/mysql-schema-sync/"

AppURL site

const Version = "20220925.3"

Version 版本号，格式：更新日期(8位).更新次数(累加)

Functions

func CheckSchemaDiff

func CheckSchemaDiff(cfg *Config)

CheckSchemaDiff 执行最终的 diff

func RemoveTableSchemaConfig

func RemoveTableSchemaConfig(schema string) string

RemoveTableSchemaConfig 删除表创建引擎信息，编码信息，分区信息，已修复同步表结构遇到分区表异常退出问题， 对于分区表，只会同步字段，索引，主键，外键的变更

Types

type AlterIgnoreTable

type AlterIgnoreTable struct {
	Column []string `json:"column"`
	Index  []string `json:"index"`

	// 外键
	ForeignKey []string `json:"foreign"`
}

AlterIgnoreTable table's ignore info

type Config

type Config struct {
	// AlterIgnore 忽略配置， eg:   "tb1*":{"column":["aaa","a*"],"index":["aa"],"foreign":[]}
	AlterIgnore map[string]*AlterIgnoreTable `json:"alter_ignore"`

	// Email 完成同步后发送同步信息的邮件账号信息
	Email *EmailStruct `json:"email"`

	// SourceDSN 同步的源头
	SourceDSN string `json:"source"`

	// DestDSN 将被同步
	DestDSN string `json:"dest"`

	ConfigPath string

	// Tables 同步表的白名单，若为空，则同步全库
	Tables []string `json:"tables"`

	// TablesIgnore 不同步的表
	TablesIgnore []string `json:"tables_ignore"`

	// Sync 是否真正的执行同步操作
	Sync bool

	// Drop 若目标数据库表比源头多了字段、索引，是否删除
	Drop bool

	// HTTPAddress 生成站点报告的地址，如 :8080
	HTTPAddress string

	// SingleSchemaChange 生成sql ddl语言每条命令只会进行单个修改操作
	SingleSchemaChange bool `json:"single_schema_change"`
}

Config config struct

func LoadConfig

func LoadConfig(confPath string) *Config

LoadConfig load config file

func (*Config) Check

func (cfg *Config) Check()

Check check config

func (*Config) CheckMatchIgnoreTables

func (cfg *Config) CheckMatchIgnoreTables(name string) bool

CheckMatchIgnoreTables check table_Ignore is match

func (*Config) CheckMatchTables

func (cfg *Config) CheckMatchTables(name string) bool

CheckMatchTables check table is match

func (*Config) IsIgnoreField

func (cfg *Config) IsIgnoreField(table string, name string) bool

IsIgnoreField isIgnore

func (*Config) IsIgnoreForeignKey

func (cfg *Config) IsIgnoreForeignKey(table string, name string) bool

IsIgnoreForeignKey 检查外键是否忽略掉

func (*Config) IsIgnoreIndex

func (cfg *Config) IsIgnoreIndex(table string, name string) bool

IsIgnoreIndex is index ignore

func (*Config) SendMailFail

func (cfg *Config) SendMailFail(errStr string)

SendMailFail send fail mail

func (*Config) SetTables

func (cfg *Config) SetTables(tables []string)

func (*Config) SetTablesIgnore

func (cfg *Config) SetTablesIgnore(tables []string)

SetTablesIgnore 设置忽略

func (*Config) String

func (cfg *Config) String() string

type DbIndex

type DbIndex struct {
	IndexType indexType
	Name      string
	SQL       string

	// 相关联的表
	RelationTables []string
}

DbIndex db index

func (*DbIndex) String

func (idx *DbIndex) String() string

type EmailStruct

type EmailStruct struct {
	SMTPHost     string `json:"smtp_host"`
	From         string `json:"from"`
	Password     string `json:"password"`
	To           string `json:"to"`
	SendMailAble bool   `json:"send_mail"`
}

EmailStruct email conf info

func (*EmailStruct) SendMail

func (m *EmailStruct) SendMail(title string, body string)

SendMail send mail

type MyDb

type MyDb struct {
	Db *sql.DB
	// contains filtered or unexported fields
}

MyDb db struct

func NewMyDb

func NewMyDb(dsn string, dbType string) *MyDb

NewMyDb parse dsn

func (*MyDb) GetTableNames

func (db *MyDb) GetTableNames() []string

GetTableNames table names

func (*MyDb) GetTableSchema

func (db *MyDb) GetTableSchema(name string) (schema string)

GetTableSchema table schema

func (*MyDb) Query

func (db *MyDb) Query(query string, args ...any) (*sql.Rows, error)

Query execute sql query

type MySchema

type MySchema struct {
	Fields     *orderedmap.OrderedMap
	IndexAll   map[string]*DbIndex
	ForeignAll map[string]*DbIndex
	SchemaRaw  string
}

MySchema table schema

func ParseSchema

func ParseSchema(schema string) *MySchema

ParseSchema parse table's schema

func (*MySchema) GetFieldNames

func (mys *MySchema) GetFieldNames() []string

GetFieldNames table names

func (*MySchema) RelationTables

func (mys *MySchema) RelationTables() []string

func (*MySchema) String

func (mys *MySchema) String() string

type SchemaDiff

type SchemaDiff struct {
	Source *MySchema
	Dest   *MySchema
	Table  string
}

func (*SchemaDiff) RelationTables

func (sdiff *SchemaDiff) RelationTables() []string

type SchemaSync

type SchemaSync struct {
	Config   *Config
	SourceDb *MyDb
	DestDb   *MyDb
}

SchemaSync 配置文件

func NewSchemaSync

func NewSchemaSync(config *Config) *SchemaSync

NewSchemaSync 对一个配置进行同步

func (*SchemaSync) GetNewTableNames

func (sc *SchemaSync) GetNewTableNames() []string

GetNewTableNames 获取所有新增加的表名

func (*SchemaSync) GetTableNames

func (sc *SchemaSync) GetTableNames() []string

合并源数据库和目标数据库的表名

func (*SchemaSync) SyncSQL4Dest

func (sc *SchemaSync) SyncSQL4Dest(sqlStr string, sqls []string) error

SyncSQL4Dest sync schema change

type TableAlterData

type TableAlterData struct {
	SchemaDiff *SchemaDiff
	Table      string
	Comment    string
	SQL        []string
	Type       alterType
}

TableAlterData 表的变更情况

func (*TableAlterData) Split

func (ta *TableAlterData) Split() []*TableAlterData

func (*TableAlterData) String

func (ta *TableAlterData) String() string