package
6.7.0-alpha+incompatible
Repository: https://github.com/pingcap/tidb.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

AllocAutoIncrementValue allocates an auto_increment value for a new row.
AllocBatchAutoIncrementValue allocates batch auto_increment value for rows, returning firstID, increment and err.
CastValue casts a value based on column type.
CheckNotNull checks if row has nil value set to a column with NotNull flag set.
CheckOnce checks if there are duplicated column names in cols.
ColDescFieldNames returns the fields name in result set for desc and show columns.
EvalColDefaultExpr eval default expr node to explicit default value.
FillVirtualColumnValue will calculate the virtual column value by evaluating generated expression using rows from a chunk, and then fill this value into the chunk.
FindCol finds column in cols by name.
FindColLowerCase finds column in cols by name.
FindCols finds columns in cols by names.
FindColumns finds columns in cols by names with a better performance than FindCols().
FindOnUpdateCols finds columns which have OnUpdateNow flag.
GetColDefaultValue gets default value of the column.
GetColOriginDefaultValue gets default value of the column from original default value.
GetZeroValue gets zero value for given column type.
NewColDesc returns a new ColDesc for a column.
OptionalFsp convert a FieldType.GetDecimal() to string.
ToColumn converts a *model.ColumnInfo to *Column.
WithCtx returns a CreateIdxFunc.

# Constants

ClusterTable contains the `VirtualTable` in the all cluster tidb nodes.
NormalTable stores data in tikv, mocktikv and so on.
VirtualTable stores no data, just extract data from the memory struct.

# Variables

ErrColumnCantNull is used for inserting null to a not null column.
ErrColumnStateCantNone returns for column none state.
ErrColumnStateNonPublic returns for column non-public state.
ErrIndexOutBound returns for index column offset out of bound.
ErrIndexStateCantNone returns for index none state.
ErrInvalidRecordKey returns for invalid record key.
ErrLockOrActiveTransaction returns when execute unsupported statement in a lock session or an active transaction.
ErrNoDefaultValue is used when insert a row, the column value is not given, and the column has not null flag and it doesn't have a default value.
ErrNoPartitionForGivenValue returns table has no partition for value.
ErrOptOnCacheTable returns when exec unsupported opt at cache mode.
ErrRowDoesNotMatchGivenPartitionSet returns when the destination partition conflict with the partition selection.
ErrRowNotFound returns for row not found.
ErrSequenceHasRunOut returns when sequence has run out.
ErrTableStateCantNone returns for table none state.
ErrTempTableFull returns a table is full error, it's used by temporary table now.
ErrTruncatedWrongValueForField returns for truncate wrong value for field.
ErrUnknownColumn is returned when accessing an unknown column.
ErrUnknownPartition returns unknown partition error.
ErrUnsupportedOp returns for unsupported operation.
FromBackfill indicates that the index is created by DDL backfill worker.
IndexIsUntouched uses to indicate the index kv is untouched.
IsUpdate is a defined value for AddRecordOptFunc.
MockTableFromMeta only serves for test.
TableFromMeta builds a table.Table from *model.TableInfo.
WithIgnoreAssertion uses to indicate the process can ignore assertion.

# Structs

AddRecordOpt contains the options will be used when adding a record.
ColDesc describes column information like MySQL desc and show columns do.
Column provides meta data describing a table column.
CreateIdxOpt contains the options will be used when creating an index.

# Interfaces

AddRecordOption is defined for the AddRecord() method of the Table interface.
CachedTable is a Table, and it has a UpdateLockForRead() method UpdateLockForRead() according to the reasons for not meeting the read conditions, update the lock information, And at the same time reload data from the original table.
Index is the interface for index data on KV store.
IndexIter is index kvs iter.
IndexIterator is the interface for iterator of index data on KV store.
PartitionedTable is a Table, and it has a GetPartition() method.
PhysicalTable is an abstraction for two kinds of table representation: partition or non-partitioned table.
Table is used to retrieve and modify rows in table.

# Type aliases

CreateIdxOptFunc is defined for the Create() method of Index interface.
RecordIterFunc is used for low-level record iteration.
Type is used to distinguish between different tables that store data in different ways.
WithReserveAutoIDHint tells the AddRecord operation to reserve a batch of auto ID in the stmtctx.