Package io.deephaven.enterprise.table

Class ReadBinlogOptions

java.lang.Object

io.deephaven.enterprise.table.ReadBinlogOptions

@Immutable
public abstract class ReadBinlogOptions
extends Object

The options to read binary log file(s).

See Also:

• EnterpriseTableTools.readBin(ReadBinlogOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReadBinlogOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BATCH_SIZE_DEFAULT
static final String	BATCH_SIZE_PROPERTY
static final int	BUFFER_SIZE_DEFAULT
static final String	BUFFER_SIZE_PROPERTY
static final int	MIN_BATCH_SIZE
static final int	MIN_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
ReadBinlogOptions()

Method Summary

Modifier and Type	Method	Description
int	batchSize()	The batch size.
int	bufferSize()	The size of ByteBuffer used to read from path.
static ReadBinlogOptions.Builder	builder()	Construct a new builder.
static Schema	determineSchema(Path path)	Assuming the path filename starts with a Namespace.TableName. pattern, lookup the latest schema via the default Schema Service.
static ReadBinlogOptions	of(String namespace, String tableName, String... paths)	Constructs the options by looking up the latest Schema via the default Schema Service.
static ReadBinlogOptions	of(Path path)	Constructs the options assuming the path filename starts with a Namespace.TableName. pattern, which will be used to lookup the latest Schema via the default Schema Service.
abstract List<Path>	paths()	The binary log paths.
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

Field Details

BUFFER_SIZE_PROPERTY

public static final String BUFFER_SIZE_PROPERTY

See Also:

• Constant Field Values

BATCH_SIZE_PROPERTY

public static final String BATCH_SIZE_PROPERTY

See Also:

• Constant Field Values

BUFFER_SIZE_DEFAULT

public static final int BUFFER_SIZE_DEFAULT

See Also:

• Constant Field Values

MIN_BUFFER_SIZE

public static final int MIN_BUFFER_SIZE

See Also:

• Constant Field Values

BATCH_SIZE_DEFAULT

public static final int BATCH_SIZE_DEFAULT

See Also:

• Constant Field Values

MIN_BATCH_SIZE

public static final int MIN_BATCH_SIZE

See Also:

• Constant Field Values

Constructor Details

ReadBinlogOptions

public ReadBinlogOptions()

Method Details

builder

public static ReadBinlogOptions.Builder builder()

Construct a new builder.

Returns:

the builder

of

public static ReadBinlogOptions of(Path path)

Constructs the options assuming the path filename starts with a Namespace.TableName. pattern, which will be used to lookup the latest Schema via the default Schema Service.

Parameters:

path - the source path

Returns:

the options

determineSchema

public static Schema determineSchema(Path path)

Assuming the path filename starts with a Namespace.TableName. pattern, lookup the latest schema via the default Schema Service.

Parameters:

path - the source path

Returns:

the schema

of

public static ReadBinlogOptions of(String namespace,
 String tableName,
 String... paths)

Constructs the options by looking up the latest Schema via the default Schema Service.

Parameters:

namespace - the namespace

tableName - the tableName

paths - the binary log paths

Returns:

the options

paths

public abstract List<Path> paths()

The binary log paths.

Returns:

the binary log paths

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 1.

Returns:

the batch size