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

# Functions

AppendCellFromRawData appends the cell from raw data.
Compare compares the value with ad.
CopyExpectedRowsWithRowIDFunc copies the expected rows in srcCol to dstCol.
CopyRows copies all rows in srcCol to dstCol.
CopySelectedJoinRowsDirect directly copies the selected joined rows from the source Chunk to the destination Chunk.
CopySelectedJoinRowsWithSameOuterRows copies the selected joined rows from the source Chunk to the destination Chunk.
CopySelectedRows copies the selected rows in srcCol to dstCol.
CopySelectedRowsWithRowIDFunc copies the selected rows in srcCol to dstCol.
EstimateTypeWidth estimates the average width of values of the type.
GetCompareFunc gets a compare function for the field type.
GetFixedLen get the memory size of a fixed-length type.
InitChunkAllocSize init the maximum cache size.
MutRowFromDatums creates a MutRow from a datum slice.
MutRowFromTypes creates a MutRow from a FieldType slice, each Column is initialized to zero value.
MutRowFromValues creates a MutRow from a interface slice.
New creates a new chunk.
NewAllocator creates an Allocator.
NewChunkFromPoolWithCapacity creates a new chunk with field types and capacity from the pool.
NewChunkWithCapacity creates a new chunk with field types and capacity.
NewCodec creates a new Codec object for encode or decode a Chunk.
NewColumn creates a new column with the specific type and capacity.
NewColumnSwapHelper creates a new ColumnSwapHelper.
NewDataInDiskByChunks creates a new DataInDiskByChunks with field types.
NewDataInDiskByRows creates a new DataInDiskByRows with field types.
NewDecoder creates a new Decoder object for decode a Chunk.
NewEmptyAllocator creates an empty pool, which will always call `chunk.New` to create a new chunk.
NewEmptyChunk creates an empty chunk.
NewEmptyColumn creates a new column with nothing.
NewIterator4Chunk returns a iterator for Chunk.
NewIterator4List returns a Iterator for List.
NewIterator4RowContainer create a new iterator for RowContainer.
NewIterator4RowPtr returns a Iterator for RowPtrs.
NewIterator4Slice returns a *Iterator4Slice for Row slice.
NewList creates a new List with field types, init chunk size and max chunk size.
NewListWithMemTracker creates a new List with field types, init chunk size, max chunk size and memory tracker.
NewMultiIterator creates a new multiIterator.
NewPool creates a new Pool.
NewReaderWithCache returns a ReaderWithCache.
NewReuseHookAllocator creates an allocator, which will call the function `f` when the first reused chunk is allocated.
NewRowContainer creates a new RowContainer in memory.
NewRowContainerReader creates a forward only iterator for row container.
NewSortedRowContainer creates a new SortedRowContainer in memory.
NewSyncAllocator creates the synchronized version of the `alloc`.
Renew creates a new Chunk based on an existing Chunk.

# Constants

Capacity constants.
RowPtrSize shows the size of RowPtr.
RowSize is the size of `Row{}`.
SignalCheckpointForSort indicates the times of row comparation that a signal detection will be triggered.
VarElemLen indicates this Column is a variable length Column.
Capacity constants.

# Variables

ErrCannotAddBecauseSorted indicate that the SortPartition is sorted and prohibit inserting data.
MaxCachedLen Maximum cacheable length.

# Structs

Chunk stores multiple rows of data in columns.
Codec is used to: 1.
Column stores one column of data in Apache Arrow format.
ColumnSwapHelper is used to help swap columns in a chunk.
DataInDiskByChunks represents some data stored in temporary disk.
DataInDiskByRows represents some data stored in temporary disk.
Decoder decodes the data returned from the coprocessor and stores the result in Chunk.
DefaultColumnAllocator is the default implementation of ColumnAllocator.
Iterator4Chunk is used to iterate rows inside a chunk.
Iterator4Slice is used to iterate rows inside a slice.
List holds a slice of chunks, use to append rows with max chunk size properly handled.
Pool is the Column pool.
ReaderWithCache helps to read data that has not be flushed to underlying layer.
Row represents a row of data, can be used to access values.
RowContainer provides a place for many rows, so many that we might want to spill them into disk.
RowPtr is used to get a row from a list.
SortAndSpillDiskAction implements memory.ActionOnExceed for chunk.List.
SortedRowContainer provides a place for many rows, so many that we might want to sort and spill them into disk.
SpillDiskAction implements memory.ActionOnExceed for chunk.List.

# Interfaces

Allocator is an interface defined to reduce object allocation.
ColumnAllocator defines an allocator for Column.
Iterator is used to iterate a number of rows.
RowContainerReader is a forward-only iterator for the row container.

# Type aliases

CompareFunc is a function to compare the two values in Row, the two columns must have the same type.
ListWalkFunc is used to walk the list.
MutRow represents a mutable Row.