LcsRowScanExecStreamParams Struct Reference

Parameters specific to the row scan execution stream, including the type of scan (full table scan versus specific rid reads) and whether residual filtering should be performed. More...

#include <LcsRowScanExecStream.h>

Inheritance diagram for LcsRowScanExecStreamParams:

List of all members.


Public Attributes
bool	isFullScan
	If true, this scan performs a full table scan.
bool	hasExtraFilter
	If true, this ExecStream contains extra residual filters that should be applied during the scan.
TupleProjection	residualFilterCols
	contains an array of column id corresponding to each filter column
TableSamplingMode	samplingMode
	The configured sampling mode for this row scan: off, Bernoulli or system.
float	samplingRate
	Percentage of rows to return as a sample.
bool	samplingIsRepeatable
	Flag indicating whether sample results should be repeatable (assuming no changes to the structure or contents of the table.
int32_t	samplingRepeatableSeed
	Seed value for random number generators to be used for repeatable sampling.
int32_t	samplingClumps
	Number of sample clumps to produce during system-mode sampling.
int64_t	samplingRowCount
	Number of rows in the table, to support system-mode sampling.
LcsClusterScanDefList	lcsClusterScanDefs
	Ordered list of cluster scans.
TupleProjection	outputProj
	projection from scan
Static Public Attributes
static int32_t	defaultSystemSamplingClumps

Detailed Description

Parameters specific to the row scan execution stream, including the type of scan (full table scan versus specific rid reads) and whether residual filtering should be performed.

Definition at line 41 of file LcsRowScanExecStream.h.

Member Data Documentation

int32_t LcsRowScanExecStreamParams::defaultSystemSamplingClumps [static]

Definition at line 44 of file LcsRowScanExecStream.h.

Referenced by ExecStreamSubFactory_lu::visit().

bool LcsRowScanExecStreamParams::isFullScan

If true, this scan performs a full table scan.

In that case, the first input into the stream will be those rids that are to be excluded from the scan. Otherwise, if this is false, the first input to the stream contains the list of rids that the stream should read.

Definition at line 52 of file LcsRowScanExecStream.h.

Referenced by LcsRowScanExecStream::prepare(), LcsMultiClusterAppendTest::scanCols(), LcsRowScanExecStreamTest::testFilterCols(), LcsRowScanExecStreamTest::testSampleScanCols(), LcsRowScanExecStreamTest::testScanCols(), LcsClusterAppendExecStreamTest::testScanMultiCol(), LcsClusterAppendExecStreamTest::testScanSingleCol(), LcsClusterReplaceExecStreamTest::verifyCluster(), and ExecStreamSubFactory_lu::visit().

bool LcsRowScanExecStreamParams::hasExtraFilter

If true, this ExecStream contains extra residual filters that should be applied during the scan.

If n columns contain filters, then those filters are contained in input streams 1 through n, where each stream contains only those filters specific to each column.

Definition at line 60 of file LcsRowScanExecStream.h.

TupleProjection LcsRowScanExecStreamParams::residualFilterCols

contains an array of column id corresponding to each filter column

Definition at line 65 of file LcsRowScanExecStream.h.

Referenced by LcsRowScanExecStream::buildOutputProj(), LcsRowScanExecStream::prepareResidualFilters(), LcsRowScanExecStreamTest::testFilterCols(), and ExecStreamSubFactory_lu::visit().

TableSamplingMode LcsRowScanExecStreamParams::samplingMode

The configured sampling mode for this row scan: off, Bernoulli or system.

Definition at line 71 of file LcsRowScanExecStream.h.

float LcsRowScanExecStreamParams::samplingRate

Percentage of rows to return as a sample.

Expressed as a fraction between 0.0 and 1.0.

Definition at line 77 of file LcsRowScanExecStream.h.

Referenced by LcsRowScanExecStream::prepare(), LcsRowScanExecStreamTest::testSampleScanCols(), and ExecStreamSubFactory_lu::visit().

bool LcsRowScanExecStreamParams::samplingIsRepeatable

Flag indicating whether sample results should be repeatable (assuming no changes to the structure or contents of the table.

Definition at line 83 of file LcsRowScanExecStream.h.

Referenced by LcsRowScanExecStream::prepare(), LcsRowScanExecStreamTest::testSampleScanCols(), and ExecStreamSubFactory_lu::visit().

int32_t LcsRowScanExecStreamParams::samplingRepeatableSeed

Seed value for random number generators to be used for repeatable sampling.

Definition at line 89 of file LcsRowScanExecStream.h.

Referenced by LcsRowScanExecStream::prepare(), LcsRowScanExecStreamTest::testSampleScanCols(), and ExecStreamSubFactory_lu::visit().

int32_t LcsRowScanExecStreamParams::samplingClumps

Number of sample clumps to produce during system-mode sampling.

Definition at line 94 of file LcsRowScanExecStream.h.

Referenced by LcsRowScanExecStream::prepare(), LcsRowScanExecStreamTest::testSampleScanCols(), and ExecStreamSubFactory_lu::visit().

int64_t LcsRowScanExecStreamParams::samplingRowCount

Number of rows in the table, to support system-mode sampling.

This field is NOT a count of the number of rows in the expected sample. The term "sampling" in the field's name refers to its use as a parameter specific to sampling.

Definition at line 102 of file LcsRowScanExecStream.h.

Referenced by LcsRowScanExecStream::prepare(), LcsRowScanExecStreamTest::testSampleScanCols(), and ExecStreamSubFactory_lu::visit().

LcsClusterScanDefList LcsRowScanBaseExecStreamParams::lcsClusterScanDefs [inherited]

Ordered list of cluster scans.

Definition at line 57 of file LcsRowScanBaseExecStream.h.

Referenced by LbmSearchTest::initClusterScanDef(), LbmLoadBitmapTest::initClusterScanDef(), LcsRowScanBaseExecStream::prepare(), LbmGeneratorExecStream::prepare(), LcsRowScanExecStream::prepareResidualFilters(), ExecStreamSubFactory_lu::readClusterScan(), LcsMultiClusterAppendTest::scanCols(), LcsRowScanExecStreamTest::testFilterCols(), LcsRowScanExecStreamTest::testSampleScanCols(), LcsRowScanExecStreamTest::testScanCols(), LcsClusterAppendExecStreamTest::testScanMultiCol(), LcsClusterAppendExecStreamTest::testScanSingleCol(), and LcsClusterReplaceExecStreamTest::verifyCluster().