Module datarush.library

Package com.pervasive.datarush.ports.record

Class DatasetOptions

java.lang.Object

com.pervasive.datarush.ports.record.DatasetOptions

public final class DatasetOptions
extends Object

Can be used to provide tuning parameters that control how iterative operators stage their data. DatasetOptions are specified via the method RecordPort.setIterationStagingOptions(com.pervasive.datarush.operators.IterativeMetadataContext, com.pervasive.datarush.ports.record.DatasetOptions). This is primarily used by iterative operators that need to access a small subset of the columns with each pass; for those operators, a columar staging format can provide a large performance speedup. Note that if columnar is used, the operator must also use a filtered port during iteration in order to indicate to the framework which columns are to be accessed in each pass.

Field Summary

Fields

Modifier and Type	Field	Description
static final DatasetOptions	DEFAULT	By default, we use the DatasetStorageFormat.COMPACT_ROW and a block size of 64.

Constructor Summary

Constructors

Constructor	Description
DatasetOptions(DatasetStorageFormat format, int blockSize)	Specify options for staging iterative datasets.

Method Summary

Modifier and Type	Method	Description
int	getBlockSize()	Returns the block size to use for writing the dataset.
DatasetStorageFormat	getFormat()	Returns the format to use for writing the dataset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT

public static final DatasetOptions DEFAULT

By default, we use the DatasetStorageFormat.COMPACT_ROW and a block size of 64.

Constructor Details

DatasetOptions

public DatasetOptions(DatasetStorageFormat format,
 int blockSize)

Specify options for staging iterative datasets.

Parameters:

format - the format.

blockSize - the block size.

Method Details

getFormat

public DatasetStorageFormat getFormat()

Returns the format to use for writing the dataset.

Returns:

the format

getBlockSize

public int getBlockSize()

Returns the block size to use for writing the dataset.

Returns:

the block size