model

Documentation

Index

• Constants
• func PriorityValueToName(value uint64) string
• type CIStr
  • func NewCIStr(s string) (cs CIStr)
  • func (cis *CIStr) Equals(other any) bool
  • func (cis *CIStr) Hash64(h types.IHasher)
  • func (cis *CIStr) MemoryUsage() (sum int64)
  • func (cis CIStr) String() string
  • func (cis *CIStr) UnmarshalJSON(b []byte) error
• type ColumnChoice
  • func (s ColumnChoice) String() string
• type IndexType
  • func (t IndexType) String() string
• type PartitionType
  • func (p PartitionType) String() string
• type PrimaryKeyType
  • func (p PrimaryKeyType) String() string
• type ReferOptionType
  • func (r ReferOptionType) String() string
• type RunawayActionType
  • func (t RunawayActionType) String() string
• type RunawayOptionType
• type RunawayWatchType
  • func (t RunawayWatchType) String() string
• type TableLockType
  • func (t TableLockType) String() string
• type ViewAlgorithm
  • func (v *ViewAlgorithm) String() string
• type ViewCheckOption
  • func (v *ViewCheckOption) String() string
• type ViewSecurity
  • func (v *ViewSecurity) String() string

Constants

const (
	LowPriorityValue    = 1
	MediumPriorityValue = 8
	HighPriorityValue   = 16
)

Priority values.

Functions

func PriorityValueToName

func PriorityValueToName(value uint64) string

PriorityValueToName converts the priority value to corresponding name

Types

type CIStr

type CIStr struct {
	O string `json:"O"` // Original string.
	L string `json:"L"` // Lower case string.
}

CIStr is case insensitive string.

func NewCIStr

func NewCIStr(s string) (cs CIStr)

NewCIStr creates a new CIStr.

func (*CIStr) Equals

func (cis *CIStr) Equals(other any) bool

Equals implements HashEquals interface.

func (*CIStr) Hash64

func (cis *CIStr) Hash64(h types.IHasher)

Hash64 implements HashEquals interface.

func (*CIStr) MemoryUsage

func (cis *CIStr) MemoryUsage() (sum int64)

MemoryUsage return the memory usage of CIStr

func (CIStr) String

func (cis CIStr) String() string

String implements fmt.Stringer interface.

func (*CIStr) UnmarshalJSON

func (cis *CIStr) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the user defined unmarshal method. CIStr can be unmarshaled from a single string, so PartitionDefinition.Name in this change https://github.com/pingcap/tidb/pull/6460/files would be compatible during TiDB upgrading.

type ColumnChoice

type ColumnChoice byte

ColumnChoice is the type of the column choice.

const (
	DefaultChoice ColumnChoice = iota
	AllColumns
	PredicateColumns
	ColumnList
)

ColumnChoice values.

func (ColumnChoice) String

func (s ColumnChoice) String() string

String implements fmt.Stringer interface.

type IndexType

type IndexType int

IndexType is the type of index

const (
	IndexTypeInvalid IndexType = iota
	IndexTypeBtree
	IndexTypeHash
	IndexTypeRtree
	IndexTypeHypo
	IndexTypeHNSW
)

IndexTypes

func (IndexType) String

func (t IndexType) String() string

String implements Stringer interface.

type PartitionType

type PartitionType int

PartitionType is the type for PartitionInfo

const (
	// Actually non-partitioned, but during DDL keeping the table as
	// a single partition
	PartitionTypeNone PartitionType = 0

	PartitionTypeRange      PartitionType = 1
	PartitionTypeHash       PartitionType = 2
	PartitionTypeList       PartitionType = 3
	PartitionTypeKey        PartitionType = 4
	PartitionTypeSystemTime PartitionType = 5
)

PartitionType types.

func (PartitionType) String

func (p PartitionType) String() string

String implements fmt.Stringer interface.

type PrimaryKeyType

type PrimaryKeyType int8

PrimaryKeyType is the type of primary key. Available values are "clustered", "nonclustered", and ""(default).

const (
	PrimaryKeyTypeDefault PrimaryKeyType = iota
	PrimaryKeyTypeClustered
	PrimaryKeyTypeNonClustered
)

PrimaryKeyType values.

func (PrimaryKeyType) String

func (p PrimaryKeyType) String() string

String implements fmt.Stringer interface.

type ReferOptionType

type ReferOptionType int

ReferOptionType is the type for refer options.

const (
	ReferOptionNoOption ReferOptionType = iota
	ReferOptionRestrict
	ReferOptionCascade
	ReferOptionSetNull
	ReferOptionNoAction
	ReferOptionSetDefault
)

Refer option types.

func (ReferOptionType) String

func (r ReferOptionType) String() string

String implements fmt.Stringer interface.

type RunawayActionType

type RunawayActionType int32

RunawayActionType is the type of runaway action.

const (
	RunawayActionNone RunawayActionType = iota
	RunawayActionDryRun
	RunawayActionCooldown
	RunawayActionKill
	RunawayActionSwitchGroup
)

RunawayActionType values.

func (RunawayActionType) String

func (t RunawayActionType) String() string

String implements fmt.Stringer interface.

type RunawayOptionType

type RunawayOptionType int

RunawayOptionType is the runaway's option type.

const (
	RunawayRule RunawayOptionType = iota
	RunawayAction
	RunawayWatch
)

RunawayOptionType values.

type RunawayWatchType

type RunawayWatchType int32

RunawayWatchType is the type of runaway watch.

const (
	WatchNone RunawayWatchType = iota
	WatchExact
	WatchSimilar
	WatchPlan
)

RunawayWatchType values.

func (RunawayWatchType) String

func (t RunawayWatchType) String() string

String implements fmt.Stringer interface.

type TableLockType

type TableLockType byte

TableLockType is the type of the table lock.

const (
	// TableLockNone means this table lock is absent.
	TableLockNone TableLockType = iota
	// TableLockRead means the session with this lock can read the table (but not write it).
	// Multiple sessions can acquire a READ lock for the table at the same time.
	// Other sessions can read the table without explicitly acquiring a READ lock.
	TableLockRead
	// TableLockReadLocal is not supported.
	TableLockReadLocal
	// TableLockReadOnly is used to set a table into read-only status,
	// when the session exits, it will not release its lock automatically.
	TableLockReadOnly
	// TableLockWrite means only the session with this lock has write/read permission.
	// Only the session that holds the lock can access the table. No other session can access it until the lock is released.
	TableLockWrite
	// TableLockWriteLocal means the session with this lock has write/read permission, and the other session still has read permission.
	TableLockWriteLocal
)

func (TableLockType) String

func (t TableLockType) String() string

String implements fmt.Stringer interface.

type ViewAlgorithm

type ViewAlgorithm int

ViewAlgorithm is VIEW's SQL ALGORITHM characteristic. See https://dev.mysql.com/doc/refman/5.7/en/view-algorithms.html

const (
	AlgorithmUndefined ViewAlgorithm = iota
	AlgorithmMerge
	AlgorithmTemptable
)

ViewAlgorithm values.

func (*ViewAlgorithm) String

func (v *ViewAlgorithm) String() string

String implements fmt.Stringer interface.

type ViewCheckOption

type ViewCheckOption int

ViewCheckOption is VIEW's WITH CHECK OPTION clause part. See https://dev.mysql.com/doc/refman/5.7/en/view-check-option.html

const (
	CheckOptionLocal ViewCheckOption = iota
	CheckOptionCascaded
)

ViewCheckOption values.

func (*ViewCheckOption) String

func (v *ViewCheckOption) String() string

String implements fmt.Stringer interface.

type ViewSecurity

type ViewSecurity int

ViewSecurity is VIEW's SQL SECURITY characteristic. See https://dev.mysql.com/doc/refman/5.7/en/create-view.html

const (
	SecurityDefiner ViewSecurity = iota
	SecurityInvoker
)

ViewSecurity values.

func (*ViewSecurity) String

func (v *ViewSecurity) String() string

String implements fmt.Stringer interface.