statistics

Documentation

Index

• type Builder
  • func (b *Builder) NewTable() (*Table, error)
• type Column
  • func (c *Column) String() string
• type FMSketch
  • func NewFMSketch(maxSize int) *FMSketch
  • func (s *FMSketch) InsertValue(value types.Datum) error
  • func (s *FMSketch) NDV() int64
• type Handle
  • func NewHandle(ctx context.Context) *Handle
  • func (h *Handle) Clear()
  • func (h *Handle) GetTableStats(tblInfo *model.TableInfo) *Table
  • func (h *Handle) SaveToStorage(ctx context.Context, t *Table) error
  • func (h *Handle) TableStatsFromStorage(ctx context.Context, info *model.TableInfo, count int64) (*Table, error)
  • func (h *Handle) Update(is infoschema.InfoSchema) error
  • func (h *Handle) UpdateTableStats(tables []*Table)
• type Histogram
  • func (hg *Histogram) BetweenRowCount(sc *variable.StatementContext, a, b types.Datum) (int64, error)
  • func (hg *Histogram) EqualRowCount(sc *variable.StatementContext, value types.Datum) (int64, error)
  • func (hg *Histogram) GreaterRowCount(sc *variable.StatementContext, value types.Datum) (int64, error)
  • func (hg *Histogram) LessRowCount(sc *variable.StatementContext, value types.Datum) (int64, error)
• type Index
  • func (idx *Index) String() string
• type Table
  • func PseudoTable(ti *model.TableInfo) *Table
  • func (t *Table) ColumnBetweenRowCount(sc *variable.StatementContext, a, b types.Datum, colInfo *model.ColumnInfo) (int64, error)
  • func (t *Table) ColumnEqualRowCount(sc *variable.StatementContext, value types.Datum, colInfo *model.ColumnInfo) (int64, error)
  • func (t *Table) ColumnGreaterRowCount(sc *variable.StatementContext, value types.Datum, colInfo *model.ColumnInfo) (int64, error)
  • func (t *Table) ColumnIsInvalid(colInfo *model.ColumnInfo) bool
  • func (t *Table) ColumnLessRowCount(sc *variable.StatementContext, value types.Datum, colInfo *model.ColumnInfo) (int64, error)
  • func (t *Table) String() string

Types

type Builder

type Builder struct {
	Ctx           context.Context  // Ctx is the context.
	TblInfo       *model.TableInfo // TblInfo is the table info of the table.
	StartTS       int64            // StartTS is the start timestamp of the statistics table builder.
	Count         int64            // Count is the total rows in the table.
	NumBuckets    int64            // NumBuckets is the number of buckets a column histogram has.
	ColumnSamples [][]types.Datum  // ColumnSamples is the sample of columns.
	ColIDs        []int64          // ColIDs is the id of columns in the table.
	ColNDVs       []int64          // ColNDVs is the NDV of columns.
	IdxRecords    []ast.RecordSet  // IdxRecords is the record set of index columns.
	IdxIDs        []int64          // IdxIDs is the id of indices in the table.
	PkRecords     ast.RecordSet    // PkRecords is the record set of primary key of integer type.
	PkID          int64            // PkID is the id of primary key with integer type in the table.
	// contains filtered or unexported fields
}

Builder describes information needed by NewTable

func (*Builder) NewTable

func (b *Builder) NewTable() (*Table, error)

NewTable creates a table statistics.

type Column

type Column struct {
	Histogram
}

Column represents a column histogram.

func (*Column) String

func (c *Column) String() string

type FMSketch

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

FMSketch is used to count the number of distinct elements in a set.

func NewFMSketch

func NewFMSketch(maxSize int) *FMSketch

NewFMSketch returns a new FM sketch.

func (*FMSketch) InsertValue

func (s *FMSketch) InsertValue(value types.Datum) error

InsertValue inserts a value into the FM sketch.

func (*FMSketch) NDV

func (s *FMSketch) NDV() int64

NDV returns the ndv of the sketch.

type Handle

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

Handle can update stats info periodically.

func NewHandle

func NewHandle(ctx context.Context) *Handle

NewHandle creates a Handle for update stats.

func (*Handle) Clear

func (h *Handle) Clear()

Clear the statsCache, only for test.

func (*Handle) GetTableStats

func (h *Handle) GetTableStats(tblInfo *model.TableInfo) *Table

GetTableStats retrieves the statistics table from cache, and the cache will be updated by a goroutine.

func (*Handle) SaveToStorage

func (h *Handle) SaveToStorage(ctx context.Context, t *Table) error

SaveToStorage saves stats table to storage.

func (*Handle) TableStatsFromStorage

func (h *Handle) TableStatsFromStorage(ctx context.Context, info *model.TableInfo, count int64) (*Table, error)

TableStatsFromStorage loads table stats info from storage.

func (*Handle) Update

func (h *Handle) Update(is infoschema.InfoSchema) error

Update reads stats meta from store and updates the stats map.

func (*Handle) UpdateTableStats

func (h *Handle) UpdateTableStats(tables []*Table)

UpdateTableStats updates the statistics table cache using copy on write.

type Histogram

type Histogram struct {
	ID  int64 // Column ID.
	NDV int64 // Number of distinct values.

	Buckets []bucket
}

Histogram represents statistics for a column or index.

func (*Histogram) BetweenRowCount

func (hg *Histogram) BetweenRowCount(sc *variable.StatementContext, a, b types.Datum) (int64, error)

BetweenRowCount estimates the row count where column greater or equal to a and less than b.

func (*Histogram) EqualRowCount

func (hg *Histogram) EqualRowCount(sc *variable.StatementContext, value types.Datum) (int64, error)

EqualRowCount estimates the row count where the column equals to value.

func (*Histogram) GreaterRowCount

func (hg *Histogram) GreaterRowCount(sc *variable.StatementContext, value types.Datum) (int64, error)

GreaterRowCount estimates the row count where the column greater than value.

func (*Histogram) LessRowCount

func (hg *Histogram) LessRowCount(sc *variable.StatementContext, value types.Datum) (int64, error)

LessRowCount estimates the row count where the column less than value.

type Index

type Index struct {
	Histogram
	NumColumns int
}

Index represents an index histogram.

func (*Index) String

func (idx *Index) String() string

type Table

type Table struct {
	Info    *model.TableInfo
	Columns map[int64]*Column
	Indices map[int64]*Index
	Count   int64 // Total row count in a table.
	Pseudo  bool
}

Table represents statistics for a table.

func PseudoTable

func PseudoTable(ti *model.TableInfo) *Table

PseudoTable creates a pseudo table statistics when statistic can not be found in KV store.

func (*Table) ColumnBetweenRowCount

func (t *Table) ColumnBetweenRowCount(sc *variable.StatementContext, a, b types.Datum, colInfo *model.ColumnInfo) (int64, error)

ColumnBetweenRowCount estimates the row count where column greater or equal to a and less than b.

func (*Table) ColumnEqualRowCount

func (t *Table) ColumnEqualRowCount(sc *variable.StatementContext, value types.Datum, colInfo *model.ColumnInfo) (int64, error)

ColumnEqualRowCount estimates the row count where the column equals to value.

func (*Table) ColumnGreaterRowCount

func (t *Table) ColumnGreaterRowCount(sc *variable.StatementContext, value types.Datum, colInfo *model.ColumnInfo) (int64, error)

ColumnGreaterRowCount estimates the row count where the column greater than value.

func (*Table) ColumnIsInvalid

func (t *Table) ColumnIsInvalid(colInfo *model.ColumnInfo) bool

ColumnIsInvalid checks if this column is invalid. Exported for test.

func (*Table) ColumnLessRowCount

func (t *Table) ColumnLessRowCount(sc *variable.StatementContext, value types.Datum, colInfo *model.ColumnInfo) (int64, error)

ColumnLessRowCount estimates the row count where the column less than value.

func (*Table) String

func (t *Table) String() string

String implements Stringer interface.