net.quasardb.qdb.ts

Class Writer

java.lang.Object

net.quasardb.qdb.ts.Writer

All Implemented Interfaces:

Flushable, AutoCloseable

Direct Known Subclasses:

AutoFlushWriter, ExpWriter, PinnedWriter

public class Writer
extends Object
implements AutoCloseable, Flushable

High-performance bulk writer for a QuasarDB timeseries table. Usage of instances of this class is not thread-safe. Use a Writer instance per Thread in multi-threaded situations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Writer.PushMode Determines which mode of operation to use when flushing the writer.
static class	Writer.TableColumn Helper class to represent a table and column pair, which we need because we need to lay out all columns as flat array.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Writer.TableColumn>	columns
protected long	pointsSinceFlush

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Writer(Session session, Table[] tables)
protected	Writer(Session session, Table[] tables, Writer.PushMode mode)

Method Summary

Modifier and Type	Method and Description
void	append(Integer offset, java.time.LocalDateTime timestamp, Value[] values) Append a new row to the local table cache.
void	append(Integer offset, Timespec timestamp, Value[] values) Append a new row to the local table cache.
void	append(Integer offset, Timestamp timestamp, Value[] values) Append a new row to the local table cache.
void	append(Integer offset, WritableRow row) Append a new row to the local table cache.
void	append(java.time.LocalDateTime timestamp, Value[] values) Append a new row to the local table cache.
void	append(String tableName, java.time.LocalDateTime timestamp, Value[] values) Append a new row to the local table cache.
void	append(String tableName, Timespec timestamp, Value[] values) Append a new row to the local table cache.
void	append(String tableName, Timestamp timestamp, Value[] values) Append a new row to the local table cache.
void	append(String tableName, WritableRow row) Append a new row to the local table cache.
void	append(Timespec timestamp, Value[] values) Append a new row to the local table cache.
void	append(Timestamp timestamp, Value[] values) Append a new row to the local table cache.
void	append(WritableRow row) Append a new row to the local table cache.
void	close() Closes the timeseries table and local cache so that memory can be reclaimed.
void	extraTables(Table table)
void	extraTables(Table[] tables) After a writer is already initialized, this function allows extra tables to be added to the internal state.
protected void	finalize() Cleans up the internal representation of the batch table.
void	flush() Flush current local cache to server.
void	flush(TimeRange range) Flush with specific time range, only useful in the context of a truncate push mode.
void	flush(TimeRange[] ranges) Flush with specific time range, only useful in the context of a truncate push mode.
Writer.PushMode	pushMode()
protected Table	tableByIndex(int index) Reverse of tableIndexByName, based on a (column) index, resolves the table.
int	tableIndexByName(String name) Utility function that looks up a table's index with the batch being written by its name.
protected void	trackMinMaxTimestamp(Timespec timestamp)

Methods inherited from class java.lang.Object

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

Field Detail

pointsSinceFlush

protected long pointsSinceFlush

columns

protected List<Writer.TableColumn> columns

Constructor Detail

Writer

protected Writer(Session session,
                 Table[] tables)

Writer

protected Writer(Session session,
                 Table[] tables,
                 Writer.PushMode mode)

Method Detail

extraTables

public void extraTables(Table[] tables)

After a writer is already initialized, this function allows extra tables to be added to the internal state. Blocking function that needs to communicate with the QuasarDB daemon to retrieve metadata.

extraTables

public void extraTables(Table table)

tableIndexByName

public int tableIndexByName(String name)

Utility function that looks up a table's index with the batch being written by its name. The first table starts with column 0, but depending upon the amount of columns in other tables, it can influence the offset of the table within the batch. If possible, you are encouraged to cache this value so that recurring writes of rows to the same table only do this lookup once.

tableByIndex

protected Table tableByIndex(int index)

Reverse of tableIndexByName, based on a (column) index, resolves the table. May be removed in the future.

finalize

protected void finalize()
                 throws Throwable

Cleans up the internal representation of the batch table.

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()
           throws IOException

Closes the timeseries table and local cache so that memory can be reclaimed. Flushes all remaining output.

Specified by:

close in interface AutoCloseable

Throws:

IOException

pushMode

public Writer.PushMode pushMode()

flush

public void flush()
           throws IOException

Flush current local cache to server.

Specified by:

flush in interface Flushable

Throws:

IOException

flush

public void flush(TimeRange range)
           throws IOException

Flush with specific time range, only useful in the context of a truncate push mode.

Throws:

IOException

flush

public void flush(TimeRange[] ranges)
           throws IOException

Flush with specific time range, only useful in the context of a truncate push mode.

Throws:

IOException

append

public void append(Integer offset,
                   Timespec timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used.

Parameters:

offset - Relative offset of the table inside the batch. Use #tableIndexByName to determine the appropriate value.

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

trackMinMaxTimestamp

protected void trackMinMaxTimestamp(Timespec timestamp)

append

public void append(String tableName,
                   Timespec timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This function automatically looks up a table's offset by its name. For performance reason, you are encouraged to manually invoke and cache the value of #tableIndexByName whenever possible.

Parameters:

tableName - Name of the table to insert to.

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(Timespec timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This is a convenience function that assumes only one table is being inserted to and should not be used when inserts to multiple tables are being batched.

Parameters:

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(Integer offset,
                   WritableRow row)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used.

Parameters:

offset - Relative offset of the table inside the batch. Use #tableIndexByName to determine the appropriate value.

row - Row being inserted.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(String tableName,
                   WritableRow row)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This function automatically looks up a table's offset by its name. For performance reason, you are encouraged to manually invoke and cache the value of #tableIndexByName whenever possible.

Parameters:

tableName - Name of the table to insert to.

row - Row being inserted.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(WritableRow row)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This is a convenience function that assumes only one table is being inserted to and should not be used when inserts to multiple tables are being batched.

Parameters:

row - Row being inserted.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(Integer offset,
                   java.time.LocalDateTime timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used.

Parameters:

offset - Relative offset of the table inside the batch. Use #tableIndexByName to determine the appropriate value.

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(String tableName,
                   java.time.LocalDateTime timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This function automatically looks up a table's offset by its name. For performance reason, you are encouraged to manually invoke and cache the value of #tableIndexByName whenever possible.

Parameters:

tableName - Name of the table to insert to.

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(java.time.LocalDateTime timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This is a convenience function that assumes only one table is being inserted to and should not be used when inserts to multiple tables are being batched.

Parameters:

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(Integer offset,
                   Timestamp timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used.

Parameters:

offset - Relative offset of the table inside the batch. Use #tableIndexByName to determine the appropriate value.

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(String tableName,
                   Timestamp timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This function automatically looks up a table's offset by its name. For performance reason, you are encouraged to manually invoke and cache the value of #tableIndexByName whenever possible.

Parameters:

tableName - Name of the table to insert to.

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)

append

public void append(Timestamp timestamp,
                   Value[] values)
            throws IOException

Append a new row to the local table cache. Should be periodically flushed, unless an AutoFlushWriter is used. This is a convenience function that assumes only one table is being inserted to and should not be used when inserts to multiple tables are being batched.

Parameters:

timestamp - Timestamp of the row

values - Values being inserted, mapped to columns by their relative offset.

Throws:

IOException

See Also:

tableIndexByName(java.lang.String), flush(), Table.autoFlushWriter(net.quasardb.qdb.Session, java.lang.String)