checker

package

v0.0.0-...-73f8a9c Latest Latest Go to latest Published: Jan 31, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nooncall/owls

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func IndexMach(info *task.DBInfo, sql string) (bool, error)
func InitRuleStatus()
func IsAlterIndexOperate(sql string) bool
func IsBanned(column []sql_util.Column, old string, newFieldType byte, NewFieldLen int) bool
func IsBreakRule(name string) bool
func SetRuleStatusDao(impl RuleStatusDao)
func UpdateRuleStatus(name, action string) (err error)
type Audit
- func NewAudit(sql, charset, collation string) (*Audit, error)
type CheckerService
- func (CheckerService) ListRules() interface{}
- func (CheckerService) SqlCheck(sql, charset, collation string, info *task.DBInfo) (pass bool, suggestion string, affectRow int)
type KeysInfo
type OwlRuleStatus
type Rule
- func ListRules(info request.SortPageInfo) ([]Rule, int)
type RuleStatusDao

Constants ¶

View Source

const (
	Update opType = iota + 1
	Delete
)

View Source

const (
	RuleCreate001 = "Create.001"
	RuleCreate002 = "Create.002"
	RuleCreate003 = "Create.003"
	RuleCreate004 = "Create.004"
	RuleCreate005 = "Create.005"
	RuleCreate006 = "Create.006"
	RuleCreate007 = "Create.007"
	RuleCreate008 = "Create.008"
	RuleCreate009 = "Create.009"
	RuleCreate010 = "Create.010"
	RuleCreate011 = "Create.011"
	RuleCreate012 = "Create.012"
	RuleCreate013 = "Create.013"
	RuleCreate014 = "Create.014"
	RuleCreate015 = "Create.015"
	RuleCreate016 = "Create.016"
	RuleCreate017 = "Create.017"
	RuleCreate018 = "Create.018"
	RuleCreate019 = "Create.019"

	RuleAlter001 = "Alter.001"
	RuleAlter002 = "Alter.002"
	RuleAlter003 = "Alter.003"
	RuleAlter004 = "Alter.004"
	RuleAlter005 = "Alter.005"

	RuleDml001 = "DML.001"
	RuleDml002 = "DML.002"
	RuleDml003 = "DML.003"
	RuleDml004 = "DML.004"
	RuleDml005 = "DML.005"
	RuleDml006 = "DML.006"
	RuleDml007 = "DML.007"
	RuleDml008 = "DML.008"
	RuleDml009 = "DML.009"
)

Variables ¶

View Source

var Rules []Rule

Functions ¶

func IndexMach ¶

func IndexMach(info *task.DBInfo, sql string) (bool, error)

func InitRuleStatus ¶

func InitRuleStatus()

func IsAlterIndexOperate ¶

func IsAlterIndexOperate(sql string) bool

index str : unique,primary ,fulltext + index/key alter语句，判断是不是对索引的操作

func IsBanned ¶

func IsBanned(column []sql_util.Column, old string, newFieldType byte, NewFieldLen int) bool

* 判断是否为禁止的操作规则要求: alter change/modify操作，禁止以下动作： 1）int/bigint --> varchar 2) bigint --> int 3) varchar --> bigint/int 4) varchar(n) --> varchar(m) 其中n>m

* sql 类型和mysql.type 对应关系 varchar varchar int long bigint longlong

func IsBreakRule ¶

func IsBreakRule(name string) bool

func SetRuleStatusDao ¶

func SetRuleStatusDao(impl RuleStatusDao)

func UpdateRuleStatus ¶

func UpdateRuleStatus(name, action string) (err error)

Types ¶

type Audit ¶

type Audit struct {
	Query  string              // 查询语句
	Stmt   sqlparser.Statement // 通过Vitess解析出的抽象语法树
	TiStmt []ast.StmtNode      // 通过TiDB解析出的抽象语法树
}

Audit 待评审的SQL结构体，由原SQL和其对应的抽象语法树组成

func NewAudit ¶

func NewAudit(sql, charset, collation string) (*Audit, error)

NewQuery4Audit return a struct for Audit

type CheckerService ¶

type CheckerService struct {
}

var Checker CheckerService

func (CheckerService) ListRules ¶

func (CheckerService) ListRules() interface{}

func (CheckerService) SqlCheck ¶

func (CheckerService) SqlCheck(sql, charset, collation string, info *task.DBInfo) (pass bool, suggestion string, affectRow int)

type KeysInfo ¶

type KeysInfo struct {
	KeyName    string `bdb:"Key_name"`
	SeqInIndex int    `bdb:"Seq_in_index"` // index,索引 即key，
	ColumnName string `bdb:"Column_name"`
}

type OwlRuleStatus ¶

type OwlRuleStatus struct {
	Name  string `json:"name" gorm:"column:name"`
	Close int    `json:"close" gorm:"column:close"`
}

type Rule ¶

type Rule struct {
	Item     string `json:"item"`     // 规则代号
	Name     string `json:"name"`     // 规则名称
	Summary  string `json:"summary"`  // 规则摘要
	Content  string `json:"content"`  // 规则解释
	Case     string `json:"case"`     // SQL示例
	Position int    `json:"position"` // 建议所处SQL字符位置，默认0表示全局建议
	Open     bool   `json:"open"`     // 是否禁用，

	CheckFunc func(*Rule, *Audit, *task.DBInfo) (pass bool, newSummary string, affectRows int) `json:"-"` // 函数名
}

Rule 评审规则元数据结构

func ListRules ¶

func ListRules(info request.SortPageInfo) ([]Rule, int)

func (*Rule) RuleAffectRows ¶

func (q *Rule) RuleAffectRows(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

func (*Rule) RuleAlterTableColumnExist ¶

func (q *Rule) RuleAlterTableColumnExist(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleAlterTableColumnExist DML.007

func (*Rule) RuleAlterTableDrop ¶

func (q *Rule) RuleAlterTableDrop(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleAlterTableDrop Alter.002

func (*Rule) RuleAlterTableDropColumn ¶

func (q *Rule) RuleAlterTableDropColumn(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleAlterTableDropColumn Alter.001

func (*Rule) RuleAlterTableExist ¶

func (q *Rule) RuleAlterTableExist(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleAlterTableExist DML.006

func (*Rule) RuleAutoIncrementLimit ¶

func (q *Rule) RuleAutoIncrementLimit(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

func (*Rule) RuleBanAddMulti ¶

func (q *Rule) RuleBanAddMulti(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

Alter.004

func (*Rule) RuleColCommentCheck ¶

func (q *Rule) RuleColCommentCheck(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleColCommentCheck Create.004

func (*Rule) RuleCreateTableCharset ¶

func (q *Rule) RuleCreateTableCharset(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableCharset Create.001

func (*Rule) RuleCreateTableCoIndexEx ¶

func (q *Rule) RuleCreateTableCoIndexEx(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableCoIndexEx Create.013

func (*Rule) RuleCreateTableCoIndexOrder ¶

func (q *Rule) RuleCreateTableCoIndexOrder(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableCoIndexOrder Create.012

func (*Rule) RuleCreateTableComment ¶

func (q *Rule) RuleCreateTableComment(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableComment Create.002

func (*Rule) RuleCreateTableDupIndex ¶

func (q *Rule) RuleCreateTableDupIndex(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableDupIndex Create.009

func (*Rule) RuleCreateTableIndex ¶

func (q *Rule) RuleCreateTableIndex(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableIndex Create.003

func (*Rule) RuleCreateTableIndexColNum ¶

func (q *Rule) RuleCreateTableIndexColNum(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableIndexNum Create.007

func (*Rule) RuleCreateTableIndexLen ¶

func (q *Rule) RuleCreateTableIndexLen(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableIndexLen Create.014

func (*Rule) RuleCreateTableIndexNum ¶

func (q *Rule) RuleCreateTableIndexNum(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableIndexNum Create.008

func (*Rule) RuleCreateTableNormalIndex ¶

func (q *Rule) RuleCreateTableNormalIndex(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableNormalIndex Create.006

func (*Rule) RuleCreateTableNotNullValue ¶

func (q *Rule) RuleCreateTableNotNullValue(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleAddNotNullValue Create.010

func (*Rule) RuleCreateTableNotUseKeyWorld ¶

func (q *Rule) RuleCreateTableNotUseKeyWorld(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableTextColNum Create.016

func (*Rule) RuleCreateTableSetColCharset ¶

func (q *Rule) RuleCreateTableSetColCharset(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableSetColCharset Create.011

func (*Rule) RuleCreateTableTextColNum ¶

func (q *Rule) RuleCreateTableTextColNum(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableTextColNum Create.015

func (*Rule) RuleCreateTableUniqIndex ¶

func (q *Rule) RuleCreateTableUniqIndex(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableUniqIndex Create.005

func (*Rule) RuleDMLTableNoWhere ¶

func (q *Rule) RuleDMLTableNoWhere(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleDMLTableNoWhere DML.001

func (*Rule) RuleDmlIndexMatch ¶

func (q *Rule) RuleDmlIndexMatch(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

IndexMatch DML008

func (*Rule) RuleDmlNoMoreThan100 ¶

func (q *Rule) RuleDmlNoMoreThan100(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

IndexMatch DML009

func (*Rule) RuleInsertColDef ¶

func (q *Rule) RuleInsertColDef(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleInsertColDef DML.004

func (*Rule) RuleInsertColValueEqual ¶

func (q *Rule) RuleInsertColValueEqual(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleInsertColValueEqual DML.005

func (*Rule) RuleMeaninglessWhere ¶

func (q *Rule) RuleMeaninglessWhere(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleMeaninglessWhere DML.002

func (*Rule) RuleMultiDeleteUpdate ¶

func (q *Rule) RuleMultiDeleteUpdate(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleMultiDeleteUpdate DML.003

func (*Rule) RuleNotUseIntAsPrimaryKey ¶

func (q *Rule) RuleNotUseIntAsPrimaryKey(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableTextColNum Create.017

func (*Rule) RuleOK ¶

func (q *Rule) RuleOK(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleOK OK

func (*Rule) RuleUnsupportedType ¶

func (q *Rule) RuleUnsupportedType(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

Alter.005

func (*Rule) RuleVarcharLengthLimit ¶

func (q *Rule) RuleVarcharLengthLimit(audit *Audit, info *task.DBInfo) (pass bool, newSummary string, affectRows int)

RuleCreateTableTextColNum Create.018

type RuleStatusDao ¶

type RuleStatusDao interface {
	ListAllStatus() ([]OwlRuleStatus, error)
	UpdateRuleStatus(ruleStatus *OwlRuleStatus) error
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL