Package io.deephaven.enterprise.database

Class SystemTableLogger

java.lang.Object

io.deephaven.enterprise.database.SystemTableLogger

public class SystemTableLogger
extends Object

Utility to log Table objects to System tables via the Log Aggregator Server.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemTableLogger.Options	Options for writing a system table using a logger.

Constructor Summary

Constructors

Constructor	Description
SystemTableLogger()

Method Summary

Modifier and Type	Method	Description
static void	logTable(@NotNull Database database, @NotNull String namespace, @NotNull String tableName, @NotNull Table tableToLog, @NotNull SystemTableLogger.Options options)	Write tableToLog to System storage.
static SafeCloseable	logTableIncremental(@NotNull Database database, @NotNull String namespace, @NotNull String tableName, @NotNull Table tableToLog, @NotNull SystemTableLogger.Options options)	Write tableToLog and its updates to System storage.
static SystemTableLogger.Options.Builder	newOptionsBuilder()	Create an options builder for use with logTable.

Methods inherited from class java.lang.Object

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

Constructor Details

SystemTableLogger

public SystemTableLogger()

Method Details

logTable

public static void logTable(@NotNull
 @NotNull Database database,
 @NotNull
 @NotNull String namespace,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull Table tableToLog,
 @NotNull
 @NotNull SystemTableLogger.Options options)

Write tableToLog to System storage.

The table is logged to Intraday storage and can be retrieved with Database.liveTable(String, String). Historical tables should be written using a merge process.

Parameters:

database - a Database object

namespace - the namespace of the table

tableName - the name of the table

tableToLog - the table to log

options - SystemTableLogger.Options that control write behavior

logTableIncremental

public static SafeCloseable logTableIncremental(@NotNull
 @NotNull Database database,
 @NotNull
 @NotNull String namespace,
 @NotNull
 @NotNull String tableName,
 @NotNull
 @NotNull Table tableToLog,
 @NotNull
 @NotNull SystemTableLogger.Options options)

Write tableToLog and its updates to System storage.

The table is logged to Intraday storage and can be retrieved with Database.liveTable(String, String). Historical tables should be written using a merge process.

No rows should be removed or modified in tableToLog. Modifications are an error. If the table is not a blink table, then removals are an error.

To stop logging and release resources, call SafeCloseable.close() on the returned value.

Parameters:

database - a Database object

namespace - the namespace of the table

tableName - the name of the table

tableToLog - the table to log

options - SystemTableLogger.Options that control write behavior

newOptionsBuilder

public static SystemTableLogger.Options.Builder newOptionsBuilder()

Create an options builder for use with logTable.

Returns:

the Options.Builder