Package io.deephaven.enterprise.table

Class ReadBinlogDirectoryOptions

java.lang.Object

io.deephaven.enterprise.table.ReadBinlogDirectoryOptions

@Immutable
public abstract class ReadBinlogDirectoryOptions
extends Object

The options to read binary log files from a directory.

See Also:

• EnterpriseTableTools.readBin(ReadBinlogDirectoryOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReadBinlogDirectoryOptions.Builder

Constructor Summary

Constructors

Constructor	Description
ReadBinlogDirectoryOptions()

Method Summary

Modifier and Type	Method	Description
int	batchSize()	The batch size.
int	bufferSize()	The size of ByteBuffer used to read from path.
static ReadBinlogDirectoryOptions.Builder	builder()	Construct a new builder.
abstract Path	dir()	The binary log directory.
String	glob()	The globbing pattern used to discover the binary log files.
static ReadBinlogDirectoryOptions	of(Path dirPath, String namespace, String tableName)	Constructs the options.
static ReadBinlogDirectoryOptions	of(Path dirPath, String namespace, String tableName, String glob)	Constructs the options using glob instead of the default glob.
abstract Schema	schema()	The schema.
abstract Optional<TableDefinition>	tableDefinition()	The table definition, used to limit the desired columns.

Methods inherited from class java.lang.Object

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

Constructor Details

ReadBinlogDirectoryOptions

public ReadBinlogDirectoryOptions()

Method Details

builder

public static ReadBinlogDirectoryOptions.Builder builder()

Construct a new builder.

Returns:

the builder

of

public static ReadBinlogDirectoryOptions of(Path dirPath,
 String namespace,
 String tableName)

Constructs the options. The latest Schema will be looked up via the default Schema Service.

Parameters:

dirPath - the directory path

namespace - the namespace

tableName - the table name

Returns:

the options

of

public static ReadBinlogDirectoryOptions of(Path dirPath,
 String namespace,
 String tableName,
 String glob)

Constructs the options using glob instead of the default glob. The latest Schema will be looked up via the default Schema Service.

Parameters:

dirPath - the directory path

namespace - the namespace

tableName - the table name

glob - the glob

Returns:

the options

dir

public abstract Path dir()

The binary log directory.

Returns:

the binary log directory

glob

@Default
public String glob()

The globbing pattern used to discover the binary log files. The files will be processed lexicographically, as provided by Path.compareTo(Path).

The globbing pattern is specified by the getPathMatcher method.

By default, is Namespace.TableName., guided by schema(), which will match the canonical binary log filenames.

Returns:

the globbing pattern

schema

public abstract Schema schema()

The schema.

Returns:

the schema

tableDefinition

public abstract Optional<TableDefinition> tableDefinition()

The table definition, used to limit the desired columns.

Returns:

the table definition

bufferSize

@Default
public int bufferSize()

The size of ByteBuffer used to read from path. By default, is 8388608, which can be overridden via "ReadBinlogOptions.bufferSize". Must be at least 8192.

Returns:

the buffer size

batchSize

@Default
public int batchSize()

The batch size. By default, is 2048, which can be overridden via "ReadBinlogOptions.batchSize". Must be at least 8192.

Returns:

the batch size