com.illumon.iris.db.tables.appendable.local

Class LocalTableWriter

java.lang.Object

com.illumon.iris.db.tables.appendable.local.LocalTableWriter

All Implemented Interfaces:

Entry, Record, Row, TableWriter, BufferedAppendable

Direct Known Subclasses:

DiskTableWriter

public class LocalTableWriter
extends Object
implements TableWriter, BufferedAppendable

TableWriter for concurrently-readable table writing to a local table location.

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.binarystore.Row

Row.Flags

Nested classes/interfaces inherited from interface com.illumon.iris.binarystore.Record

Record.RecordSetter<T extends RecordData>

Field Summary

Fields inherited from interface com.illumon.iris.binarystore.TableWriter

NULL_SETTER

Constructor Summary

Constructors

Constructor and Description
LocalTableWriter(LocalAppendableTable table) Construct a writer for the supplied table.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the writer.
boolean	dirty() Test if there is data to flush.
void	flush() Flushes data out.
void	force() Force all flushed data to be persisted to permanent storage.
String[]	getColumnNames() Gets the column names for the table.
Class[]	getColumnTypes() Gets the column types for the table.
Row	getRowWriter() Get a writer for a Row entries.
RowSetter	getSetter(String columnName) Gets a setter for a column.
boolean	inTransaction()
void	maybeAbortTransaction() Abort a transaction if one is in progress.
void	prepareCheckpoint() Optional operation.
void	release() Release any resources held.
void	setFlags(Row.Flags flags)
void	setImportDetails(Properties importDetails) Set a trivial import state object wrapping the supplied import details to be part of checkpoints for the output table.
void	setImportState(ImportState importState) Set an import state object to be part of checkpoints for the output table.
long	size() Number of rows written out.
boolean	supportAllTypes() True if all data types can be written out; false otherwise.
void	updateImportState(UnaryOperator<ImportState> updater) Set the import state object (as in LocalTableWriter.setImportState(ImportState)) after applying the supplied updater function to the existing import state object.
void	writeRow() Writes out a new row (values set using setters).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.binarystore.TableWriter

getRecordSetter, getRecordSetter, getRecordWriter, getSetter, writeRecord

Constructor Detail

LocalTableWriter

public LocalTableWriter(@NotNull
                        LocalAppendableTable table)

Construct a writer for the supplied table.

Parameters:

table - The table to write to

Method Detail

supportAllTypes

public boolean supportAllTypes()

Description copied from interface: TableWriter

True if all data types can be written out; false otherwise.

Specified by:

supportAllTypes in interface TableWriter

Returns:

true if all data types can be written out; false otherwise.

getColumnNames

public String[] getColumnNames()

Description copied from interface: TableWriter

Gets the column names for the table.

Specified by:

getColumnNames in interface TableWriter

Returns:

column names for the table.

getColumnTypes

public Class[] getColumnTypes()

Description copied from interface: TableWriter

Gets the column types for the table.

Specified by:

getColumnTypes in interface TableWriter

Returns:

column types for the table.

size

public long size()

Description copied from interface: Row

Number of rows written out.

Specified by:

size in interface Row

Returns:

number of rows written out.

getRowWriter

public Row getRowWriter()

Description copied from interface: TableWriter

Get a writer for a Row entries. This is likely to be newly created, so callers should cache this value. In practice, TableWriter implementations generally cache the result of the first call to this method as a primary writer.

Specified by:

getRowWriter in interface TableWriter

Returns:

a Row, likely newly created

getSetter

public RowSetter getSetter(@NotNull
                           String columnName)

Description copied from interface: TableWriter

Gets a setter for a column.

The implementation is likely to delegate to Row.getSetter(String) in a default Row instance.

Specified by:

getSetter in interface Row

Specified by:

getSetter in interface TableWriter

Parameters:

columnName - column name

Returns:

setter for the column.

setFlags

public void setFlags(@NotNull
                     Row.Flags flags)

Description copied from interface: TableWriter

The implementation is likely to delegate to Row.setFlags(Flags) in a default Row instance.

Specified by:

setFlags in interface Row

Specified by:

setFlags in interface TableWriter

inTransaction

public boolean inTransaction()

maybeAbortTransaction

public void maybeAbortTransaction()

Abort a transaction if one is in progress.

writeRow

public void writeRow()
              throws IOException

Description copied from interface: TableWriter

Writes out a new row (values set using setters).

The implementation is likely to delegate to Row.writeRow() in a default Row instance.

Specified by:

writeRow in interface Row

Specified by:

writeRow in interface TableWriter

Throws:

IOException - problem writing the row

dirty

public boolean dirty()

Test if there is data to flush.

Returns:

Whether there is data to flush

flush

public void flush()

Description copied from interface: TableWriter

Flushes data out.

Specified by:

flush in interface TableWriter

Specified by:

flush in interface BufferedAppendable

prepareCheckpoint

public void prepareCheckpoint()

Description copied from interface: BufferedAppendable

Optional operation. Prepare a checkpoint snapshot for the next call to BufferedAppendable.force(). Should be called directly after BufferedAppendable.flush(), with no intervening modification operations.

Specified by:

prepareCheckpoint in interface BufferedAppendable

force

public void force()

Description copied from interface: BufferedAppendable

Force all flushed data to be persisted to permanent storage. Will consistently and atomically persist the last prepared checkpoint in implementations that implement BufferedAppendable.prepareCheckpoint(). Does not imply BufferedAppendable.flush(), as this is a distinct operation in all implementations. May be called concurrently by threads other than the "writing thread".

Specified by:

force in interface BufferedAppendable

close

public void close()

Description copied from interface: TableWriter

Closes the writer.

Specified by:

close in interface TableWriter

Specified by:

close in interface BufferedAppendable

release

public void release()

Description copied from interface: BufferedAppendable

Release any resources held. Called after an error in preparation for termination. For external callers, this should be done as the final access to this column with the exception of any asynchronous BufferedAppendable.force() operations.

Specified by:

release in interface BufferedAppendable

updateImportState

public void updateImportState(@NotNull
                              UnaryOperator<ImportState> updater)

Set the import state object (as in LocalTableWriter.setImportState(ImportState)) after applying the supplied updater function to the existing import state object.

Parameters:

updater - The import state updater

setImportState

public void setImportState(ImportState importState)

Set an import state object to be part of checkpoints for the output table.

Parameters:

importState - The import state

setImportDetails

public void setImportDetails(Properties importDetails)

Set a trivial import state object wrapping the supplied import details to be part of checkpoints for the output table.

Parameters:

importDetails - The import details