com.illumon.iris.db.tables.databases

Interface Database

All Superinterfaces:

TableDefinitionProvider

public interface Database
extends TableDefinitionProvider

Common interface for Deephaven databases.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Database.LogHandle Handle for logged tables.

Nested classes/interfaces inherited from interface com.illumon.iris.db.tables.databases.TableDefinitionProvider

TableDefinitionProvider.MissingTableDefinitionException

Method Summary

Modifier and Type	Method and Description
default void	addColumnPartitionAndDefinition(String namespace, String tableName, String partitioningColumnName, String internalPartitionValue, String columnPartitionValue, Table data) Deprecated. Use Database.addTablePartitionAndDefinition(String, String, String, String, String, Table).
default void	addColumnPartitionAndDefinition(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table data) Deprecated. Use Database.addTablePartitionAndDefinition(String, String, String, String, Table).
void	addPartitionedTableDefinition(String namespace, String tableName, String partitioningColumnName, TableDefinition prototypeDefinition) Adds a table definition for a partitioned table.
void	addPartitionedTableDefinition(String namespace, String tableName, TableDefinition prototypeDefinition) Adds a table definition for a partitioned table.
void	addPartitionedTableDefinitionIfAbsent(String namespace, String tableName, String partitioningColumnName, TableDefinition prototypeDefinition) Adds a table definition for a partitioned table, if the table definition is absent.
void	addPartitionedTableDefinitionIfAbsent(String namespace, String tableName, String partitioningColumnName, TableDefinition prototypeDefinition, boolean checkPartitioningColumn) Adds a table definition for a partitioned table, if the table definition is absent.
void	addTable(String namespace, String tableName, Table table) Adds a table by name to the specified namespace.
void	addTableDefinition(String namespace, String tableName, TableDefinition tableDefinition) Adds a table definition to the specified namespace.
void	addTablePartition(String namespace, String tableName, String internalPartitionValue, String columnPartitionValue, Table data) Adds a single table partition (e.g.
void	addTablePartition(String namespace, String tableName, String columnPartitionValue, Table data) Adds a single table partition (e.g.
void	addTablePartitionAndDefinition(String namespace, String tableName, String partitioningColumnName, String internalPartitionValue, String columnPartitionValue, Table data) Adds a table definition and data for a partitioned table.
void	addTablePartitionAndDefinition(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table data) Adds a table definition and data for a partitioned table location.
void	appendCentral(String namespace, String tableName, String columnPartitionValue, Table table, boolean flush) Append to a table via a centralized table appender.
void	appendCentral(String namespace, String tableName, Table table, boolean flush) Append to a table via a centralized table appender.
void	appendTable(String namespace, String tableName, Table table) Appends to a table, or adds the table if it is not present.
void	appendTablePartition(String namespace, String tableName, String internalPartitionValue, String columnPartitionValue, Table data) Adds or appends to a single table location (e.g.
void	appendTablePartition(String namespace, String tableName, String columnPartitionValue, Table data) Adds or appends to a single table location (e.g.
void	closeAndDeleteCentral(String namespace, String tableName) Close all logger connections to the centralized logging for the specified table, and then atomically delete all centrally logged table data for this namespace and table name.
void	deleteMatchingTables(String namespace, String tableNameRegex) Delete all files related to the set of tables whose names match the supplied regular expression.
void	deleteNamespace(String namespace) Delete all files related to the specified namespace.
void	deleteTables(String namespace, String... tableNames) Delete all files related to a set of tables.
<T> T	executeQuery(RemoteQuery<T> remoteQuery, Class<?>... additionalClasses) Executes a DB query.
void	gc() Invoke the garbage collector for this database.
Table	getCatalog() Gets a table containing information on all tables in the DB.
String	getClientHost() Gets a client hostname.
TableWriter	getColumnPartitionTableWriter(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, TableDefinition tableDefinition, boolean append) Gets a table writer for a partitioned table.
Table	getErrorLog() Gets an error log for the DB.
List<String>	getIntradayPartitions(String namespace, String tableName) Get a list of all internal partition values available for the specified intraday table.
Table	getIntradayPartitionsAsTable(String namespace, String tableName) Get all internal partition values available for the specified intraday table, returned as table.
default Table	getIntradayTable(String namespace, String tableName) Retrieves an intraday table by namespace and name.
default Table	getIntradayTable(String namespace, String tableName, boolean live) Retrieves an intraday table by namespace and name.
default Table	getIntradayTable(String namespace, String tableName, String internalPartitionValue) Retrieves a single internal partition of the specified intraday table.
default Table	getIntradayTable(String namespace, String tableName, String internalPartitionValue, boolean live) Retrieves a single internal partition of the specified intraday table.
default Table	getIntradayTableV2(String namespace, String tableName) Retrieves an intraday table by namespace and name.
Table	getIntradayTableV2(String namespace, String tableName, boolean live) Retrieves an intraday table by namespace and name.
default Table	getIntradayTableV2(String namespace, String tableName, String internalPartitionValue) Retrieves a single internal partition of the specified intraday table.
Table	getIntradayTableV2(String namespace, String tableName, String internalPartitionValue, boolean live) Retrieves a single internal partition of the specified intraday table.
Table	getLastByTable(String namespace, String tableName) Retrieves an intraday last-by table by namespace and name.
List<String>	getNamespaces() Retrieves all namespace names from the database.
ReplayerInterface	getReplayer(DBDateTime timeStart, DBDateTime timeEnd) Creates a data replayer.
ReplayerInterface	getReplayer(DBDateTime timeStart, DBDateTime timeEnd, long interval) Creates a data replayer.
default ReplayerInterface	getReplayer(DBDateTime timeStart, DBDateTime timeEnd, String interval) Creates a data replayer.
default ReplayerInterface	getReplayer(String timeStart, String timeEnd) Creates a data replayer.
default ReplayerInterface	getReplayer(String timeStart, String timeEnd, String interval) Creates a data replayer.
String	getServerHost() Gets the server hostname.
List<String>	getSystemNamespaces() Retrieves system namespace names from the database.
default Table	getTable(String namespace, String tableName) Retrieves a table by namespace and name.
List<String>	getTableNames(String namespace) Gets all table names from the specified namespace, along with the table definitions table name and the column definitions table name.
Table	getTableV2(String namespace, String tableName) Retrieves a table by namespace and name.
TableWriter	getTableWriter(String namespace, String tableName, TableDefinition tableDefinition, boolean append) Gets a table writer for an unpartitioned table.
com.fishlib.auth.UserContext	getUserContext() Gets the user authentication context.
List<String>	getUserNamespaces() Retrieves user namespace names from the database.
String	getWorkerName() Gets the worker name.
boolean	hasImportedData(String namespace, String tableName, String columnPartitionValue) Determines if the historical table's column partition is present in the DB.
boolean	hasIntradayData(String namespace, String tableName, String columnPartitionValue) Determines if the intraday table's column partition is present in the DB.
boolean	hasIntradayTable(String namespace, String tableName) Determines if the intraday table is present in the DB.
boolean	hasNamespace(String namespace) Determines if the namespace is present in the DB.
boolean	hasTable(String namespace, String tableName) Determines if the table is present in the DB.
default Table	i(String namespace, String tableName) Retrieves an intraday table by namespace and name.
default Table	i(String namespace, String tableName, boolean live) Retrieves an intraday table by namespace and name.
default Table	i(String namespace, String tableName, String internalPartitionValue) Retrieves a single internal partition of the specified intraday table.
default Table	i(String namespace, String tableName, String internalPartitionValue, boolean live) Retrieves a single internal partition of the specified intraday table.
default Table	i2(String namespace, String tableName) Convenience method delegates to Database.getIntradayTableV2(String, String).
default Table	i2(String namespace, String tableName, boolean live) Convenience method delegates to Database.getIntradayTableV2(String, String, boolean).
default Table	i2(String namespace, String tableName, String internalPartitionValue) Convenience method delegates to Database.getIntradayTableV2(String, String, String).
default Table	i2(String namespace, String tableName, String internalPartitionValue, boolean live) Convenience method delegates to Database.getIntradayTableV2(String, String, String, boolean)
void	importClass(Class classToImport) Imports a class for use in a query.
void	importStatic(Class classToImport) Imports the static methods from a class for use in a query.
Database.LogHandle	logPartitionTableIncremental(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table table, boolean append) Writes all changes in a table to a partitioned table.
Database.LogHandle	logPartitionTableIncremental(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table table, ReplayerInterface replayer, boolean append) Writes all changes in a table to a partitioned table.
Database.LogHandle	logPartitionTableSnapshot(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table table, long logIntervalMillis, boolean append) Snapshots a table at a regular interval and writes the snapshot to a partitioned table.
Database.LogHandle	logPartitionTableSnapshot(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table table, long logIntervalMillis, ReplayerInterface replayer, boolean append) Snapshots a table at a regular interval and writes the snapshot to a partitioned table.
Database.LogHandle	logPartitionTableSnapshot(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table table, String logInterval, boolean append) Snapshots a table at a regular interval and writes the snapshot to a partitioned table.
Database.LogHandle	logPartitionTableSnapshot(String namespace, String tableName, String partitioningColumnName, String columnPartitionValue, Table table, String logInterval, ReplayerInterface replayer, boolean append) Snapshots a table at a regular interval and writes the snapshot to a partitioned table.
Table	makeRemote(Table value) Make a copy of a local table on a remote server.
Table	mr(Table value) Make a copy of a local table on a remote server.
default void	reload() Deprecated. Use Database.reloadMetadata().
void	reloadData() Reload any internally-cached data.
void	reloadMetadata() Reload any internally-cached metadata.
void	removeTable(String namespace, String tableName) Removes a table.
void	removeTableDefinition(String namespace, String tableName) Removes a table definition.
void	removeTablePartition(String namespace, String tableName, String columnPartitionValue) Removes a single table location (e.g.
void	removeTablePartition(String namespace, String tableName, String internalPartitionValue, String columnPartitionValue) Removes a single table location (e.g.
void	replaceTable(String namespace, String tableName, Table table) Replaces a table with a new table, or adds the table, if it is not already present.
void	replaceTableDefinition(String namespace, String tableName, TableDefinition tableDefinition) Replaces a table definition.
void	replaceTablePartition(String namespace, String tableName, String internalPartitionValue, String columnPartitionValue, Table data) Replaces a single table location (e.g.
void	replaceTablePartition(String namespace, String tableName, String columnPartitionValue, Table data) Removes and re-adds a single table location (e.g.
default void	rm(String namespace, String tableName) Convenience method for Database.removeTable(String, String).
int	setWatchdogMillis(int millis) Sets monitoring of delays in the LiveTableMonitor refresh loop.
void	setWatchdogTimeoutProcedure(LongConsumer watchdogTimeoutProcedure) Set the watchdog timeout procedure.
void	shutdown() Shuts this database down.
void	startup() Starts this database up.
default Table	t(String namespace, String tableName) Retrieves a table by namespace and name.
default Table	t2(String namespace, String tableName) Retrieves a table by namespace and name.
Table	timeTable(DBDateTime startTime, long periodNanos) Creates a table that adds a new row on a regular interval, starting from a specified time.
Table	timeTable(DBDateTime startTime, long periodNanos, ReplayerInterface replayer) Creates a table that adds a new row on a regular interval, starting from a specified time.
Table	timeTable(DBDateTime startTime, String period) Creates a table that adds a new row on a regular interval, starting from a specified time.
Table	timeTable(DBDateTime startTime, String period, ReplayerInterface replayer) Creates a table that adds a new row on a regular interval, starting from a specified time.
Table	timeTable(long periodNanos) Creates a table that adds a new row on a regular interval.
Table	timeTable(long periodNanos, ReplayerInterface replayer) Creates a table that adds a new row on a regular interval.
Table	timeTable(String period) Creates a table that adds a new row on a regular interval.
Table	timeTable(String startTime, long periodNanos) Creates a table that adds a new row on a regular interval, starting from a specified time.
Table	timeTable(String startTime, long periodNanos, ReplayerInterface replayer) Creates a table that adds a new row on a regular interval, starting from a specified time.
Table	timeTable(String period, ReplayerInterface replayer) Creates a table that adds a new row on a regular interval.
Table	timeTable(String startTime, String period) Creates a table that adds a new row on a regular interval, starting from a specified time.
Table	timeTable(String startTime, String period, ReplayerInterface replayer) Creates a table that adds a new row on a regular interval, starting from a specified time.

Methods inherited from interface com.illumon.iris.db.tables.databases.TableDefinitionProvider

getTableDefinition

Method Detail

getWorkerName

String getWorkerName()

Gets the worker name.

Returns:

worker name

getUserContext

com.fishlib.auth.UserContext getUserContext()
                                     throws IOException

Gets the user authentication context.

Returns:

user authentication context

Throws:

IOException - problem retrieving the context

getClientHost

String getClientHost()

Gets a client hostname.

Returns:

client hostname

getServerHost

String getServerHost()

Gets the server hostname.

Returns:

server hostname.

startup

void startup()

Starts this database up.

shutdown

void shutdown()

Shuts this database down.

reload

@Deprecated
default void reload()

Deprecated. Use Database.reloadMetadata().

reloadMetadata

void reloadMetadata()

Reload any internally-cached metadata.

Specified by:

reloadMetadata in interface TableDefinitionProvider

reloadData

void reloadData()

Reload any internally-cached data.

gc

void gc()

Invoke the garbage collector for this database.

getErrorLog

Table getErrorLog()
           throws Exception

Gets an error log for the DB. This is a real-time table.

Returns:

error log

Throws:

Exception - problems retrieving the error log.

setWatchdogMillis

int setWatchdogMillis(int millis)
               throws IOException

Sets monitoring of delays in the LiveTableMonitor refresh loop. If the LiveTableMonitor refresh loop takes longer than the specified amount of time, the watchdog timeout procedure is executed. The watchdog timeout procedure is specified by calling Database.setWatchdogTimeoutProcedure(LongConsumer).

Parameters:

millis - if LiveTableMonitor refresh loop takes longer than this amount of time, the worker will be terminated.

Returns:

the new value of the watchdog timer, in ms

Throws:

IOException - problems setting the monitor interval

setWatchdogTimeoutProcedure

void setWatchdogTimeoutProcedure(LongConsumer watchdogTimeoutProcedure)
                          throws IOException

Set the watchdog timeout procedure. If LiveTableMonitor refresh loop takes longer than the amount of time specified via Database.setWatchdogMillis(int), the timeout procedure is called.

Parameters:

watchdogTimeoutProcedure - the procedure called when the LiveTableMonitor refresh loop takes longer than watchdogMillis.

Throws:

IOException

executeQuery

<T> T executeQuery(RemoteQuery<T> remoteQuery,
                   Class<?>... additionalClasses)
            throws IOException

Executes a DB query.

Type Parameters:

T - return type

Parameters:

remoteQuery - query to execute

additionalClasses - additional classes to use during the query

Returns:

result of the query (must be serializable)

Throws:

IOException - problems executing the query or transmitting results

importClass

void importClass(Class classToImport)

Imports a class for use in a query. For example:

 db.importClass(X.class)
 t=db.t(namespace,tablename).where("X.func(A)")
 

Parameters:

classToImport - the class

importStatic

void importStatic(Class classToImport)

Imports the static methods from a class for use in a query. For example:

 db.importStaticClass(X.class)
 t=db.t(namespace,tablename).where("staticFunc(A)")
 

where staticFunc is a static function of X.

Parameters:

classToImport - The class

mr

Table mr(Table value)

Make a copy of a local table on a remote server.

Parameters:

value - local table

Returns:

remote table.

makeRemote

Table makeRemote(Table value)

Make a copy of a local table on a remote server.

Parameters:

value - local table

Returns:

remote table.

getReplayer

ReplayerInterface getReplayer(DBDateTime timeStart,
                              DBDateTime timeEnd)
                       throws IOException

Creates a data replayer.

Parameters:

timeStart - replay start time

timeEnd - replay end time

Returns:

replayer

Throws:

IOException - problems creating the replayer

getReplayer

default ReplayerInterface getReplayer(String timeStart,
                                      String timeEnd)
                               throws IOException

Creates a data replayer.

Parameters:

timeStart - replay start time

timeEnd - replay end time

Returns:

replayer

Throws:

IOException - problems creating the replayer

getReplayer

ReplayerInterface getReplayer(DBDateTime timeStart,
                              DBDateTime timeEnd,
                              long interval)
                       throws Exception

Creates a data replayer.

Parameters:

timeStart - replay start time

timeEnd - replay end time

interval - replay step size

Returns:

replayer

Throws:

IOException - problems creating the replayer

Exception

getReplayer

default ReplayerInterface getReplayer(String timeStart,
                                      String timeEnd,
                                      String interval)
                               throws Exception

Creates a data replayer.

Parameters:

timeStart - replay start time

timeEnd - replay end time

interval - replay step size

Returns:

replayer

Throws:

IOException - problems creating the replayer

Exception

getReplayer

default ReplayerInterface getReplayer(DBDateTime timeStart,
                                      DBDateTime timeEnd,
                                      String interval)
                               throws Exception

Creates a data replayer.

Parameters:

timeStart - replay start time

timeEnd - replay end time

interval - replay step size

Returns:

replayer

Throws:

IOException - problems creating the replayer

Exception

getSystemNamespaces

List<String> getSystemNamespaces()

Retrieves system namespace names from the database.

Returns:

The list of namespace names

getUserNamespaces

List<String> getUserNamespaces()

Retrieves user namespace names from the database.

Returns:

The list of namespace names

getNamespaces

List<String> getNamespaces()

Retrieves all namespace names from the database.

Returns:

The list of namespace names

hasNamespace

boolean hasNamespace(String namespace)

Determines if the namespace is present in the DB.

Parameters:

namespace - namespace

Returns:

true if the namespace exists; false otherwise.

getCatalog

Table getCatalog()

Gets a table containing information on all tables in the DB.

Returns:

table containing information on all tables in the DB

getTableNames

List<String> getTableNames(String namespace)

Gets all table names from the specified namespace, along with the table definitions table name and the column definitions table name.

Parameters:

namespace - The namespace to list the contents of

Returns:

The list of table names

hasTable

boolean hasTable(String namespace,
                 String tableName)

Determines if the table is present in the DB.

Parameters:

namespace - namespace

tableName - table name

Returns:

true if the table exists; false otherwise.

hasIntradayTable

boolean hasIntradayTable(String namespace,
                         String tableName)

Determines if the intraday table is present in the DB.

Parameters:

namespace - namespace

tableName - table name

Returns:

true if the intraday table exists; false otherwise.

getIntradayPartitions

List<String> getIntradayPartitions(String namespace,
                                   String tableName)

Get a list of all internal partition values available for the specified intraday table.

Parameters:

namespace - The namespace of the table

tableName - The table name to examine in the intraday data space

Returns:

A list of internal partition values for top-level partitioning of the intraday table. Typically represents one partition per source.

getIntradayPartitionsAsTable

Table getIntradayPartitionsAsTable(String namespace,
                                   String tableName)

Get all internal partition values available for the specified intraday table, returned as table.

Parameters:

namespace - The namespace of the table

tableName - The table name to examine in the intraday data space

Returns:

A table containing the internal partition values for top-level partitioning of the intraday table. Typically represents one partition per source.

hasImportedData

boolean hasImportedData(String namespace,
                        String tableName,
                        String columnPartitionValue)

Determines if the historical table's column partition is present in the DB.

Parameters:

namespace - namespace

tableName - table name

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

Returns:

true if the table's column partition exists; false otherwise.

hasIntradayData

boolean hasIntradayData(String namespace,
                        String tableName,
                        String columnPartitionValue)

Determines if the intraday table's column partition is present in the DB.

Parameters:

namespace - namespace

tableName - table name

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

Returns:

true if the intraday table's column partition exists; false otherwise.

getTable

default Table getTable(String namespace,
                       String tableName)

Retrieves a table by namespace and name. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

table

t

default Table t(String namespace,
                String tableName)

Retrieves a table by namespace and name. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

table

getTableV2

Table getTableV2(String namespace,
                 String tableName)

Retrieves a table by namespace and name. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

table in "v2" format

t2

default Table t2(String namespace,
                 String tableName)

Retrieves a table by namespace and name. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

table in "v2" format

getIntradayTable

default Table getIntradayTable(String namespace,
                               String tableName)

Retrieves an intraday table by namespace and name. Throws exceptions for unknown tables. Always provides a live result.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

live intraday table

i

default Table i(String namespace,
                String tableName)

Retrieves an intraday table by namespace and name. Throws exceptions for unknown tables. Always provides a live result.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

live intraday table

getIntradayTableV2

default Table getIntradayTableV2(String namespace,
                                 String tableName)

Retrieves an intraday table by namespace and name. Throws exceptions for unknown tables. Always provides a live result.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

live intraday table

i2

default Table i2(String namespace,
                 String tableName)

Convenience method delegates to Database.getIntradayTableV2(String, String).

getIntradayTable

default Table getIntradayTable(String namespace,
                               String tableName,
                               boolean live)

Retrieves an intraday table by namespace and name. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

live - true if the table should be live/updating; false otherwise

Returns:

intraday table

i

default Table i(String namespace,
                String tableName,
                boolean live)

Retrieves an intraday table by namespace and name. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

live - true if the table should be live/updating; false otherwise

Returns:

intraday table

getIntradayTableV2

Table getIntradayTableV2(String namespace,
                         String tableName,
                         boolean live)

Retrieves an intraday table by namespace and name. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

live - true if the table should be live/updating; false otherwise

Returns:

intraday table

i2

default Table i2(String namespace,
                 String tableName,
                 boolean live)

Convenience method delegates to Database.getIntradayTableV2(String, String, boolean).

getIntradayTable

default Table getIntradayTable(String namespace,
                               String tableName,
                               String internalPartitionValue)

Retrieves a single internal partition of the specified intraday table. The result may contain locations for multiple column partition values, and so a subsequent filter (e.g. on "Date") will often be desired. Throws exceptions for unknown tables. Always provides a live result.

Parameters:

namespace - namespace of the table

tableName - name of the table

internalPartitionValue - locations will be restricted to this internal partition value

Returns:

live single partition intraday table

i

default Table i(String namespace,
                String tableName,
                String internalPartitionValue)

Retrieves a single internal partition of the specified intraday table. The result may contain locations for multiple column partition values, and so a subsequent filter (e.g. on "Date") will often be desired. Throws exceptions for unknown tables. Always provides a live result.

Parameters:

namespace - namespace of the table

tableName - name of the table

internalPartitionValue - locations will be restricted to this internal partition value

Returns:

live single partition intraday table

getIntradayTableV2

default Table getIntradayTableV2(String namespace,
                                 String tableName,
                                 String internalPartitionValue)

Retrieves a single internal partition of the specified intraday table. The result may contain locations for multiple column partition values, and so a subsequent filter (e.g. on "Date") will often be desired. Throws exceptions for unknown tables. Always provides a live result.

Parameters:

namespace - namespace of the table

tableName - name of the table

internalPartitionValue - locations will be restricted to this internal partition value

Returns:

live single partition intraday table

i2

default Table i2(String namespace,
                 String tableName,
                 String internalPartitionValue)

Convenience method delegates to Database.getIntradayTableV2(String, String, String).

getIntradayTable

default Table getIntradayTable(String namespace,
                               String tableName,
                               String internalPartitionValue,
                               boolean live)

Retrieves a single internal partition of the specified intraday table. The result may contain locations for multiple column partition values, and so a subsequent filter (e.g. on "Date") will often be desired. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

internalPartitionValue - locations will be restricted to this internal partition value

live - true if the table should be live/updating; false otherwise

Returns:

single partition intraday table

i

default Table i(String namespace,
                String tableName,
                String internalPartitionValue,
                boolean live)

Retrieves a single internal partition of the specified intraday table. The result may contain locations for multiple column partition values, and so a subsequent filter (e.g. on "Date") will often be desired. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

internalPartitionValue - locations will be restricted to this internal partition value

live - true if the table should be live/updating; false otherwise

Returns:

single partition intraday table

getIntradayTableV2

Table getIntradayTableV2(String namespace,
                         String tableName,
                         String internalPartitionValue,
                         boolean live)

Retrieves a single internal partition of the specified intraday table. The result may contain locations for multiple column partition values, and so a subsequent filter (e.g. on "Date") will often be desired. Throws exceptions for unknown tables.

Parameters:

namespace - namespace of the table

tableName - name of the table

internalPartitionValue - locations will be restricted to this internal partition value

live - true if the table should be live/updating; false otherwise

Returns:

single partition intraday table

i2

default Table i2(String namespace,
                 String tableName,
                 String internalPartitionValue,
                 boolean live)

Convenience method delegates to Database.getIntradayTableV2(String, String, String, boolean)

getLastByTable

Table getLastByTable(String namespace,
                     String tableName)

Retrieves an intraday last-by table by namespace and name. Throws exceptions for unknown tables. Always provides a live result. This may not be configured on your system.

Parameters:

namespace - namespace of the table

tableName - name of the table

Returns:

live intraday last-by table

timeTable

Table timeTable(String period)
         throws Exception

Creates a table that adds a new row on a regular interval.

Parameters:

period - time interval between new row additions.

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(String period,
                ReplayerInterface replayer)
         throws Exception

Creates a table that adds a new row on a regular interval. For use with data replay.

Parameters:

period - time interval between new row additions

replayer - data replayer

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(DBDateTime startTime,
                String period)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time.

Parameters:

startTime - start time for adding new rows

period - time interval between new row additions

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(DBDateTime startTime,
                String period,
                ReplayerInterface replayer)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time. For use with data replay.

Parameters:

startTime - start time for adding new rows

period - time interval between new row additions

replayer - data replayer

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(String startTime,
                String period)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time.

Parameters:

startTime - start time for adding new rows

period - time interval between new row additions

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(String startTime,
                String period,
                ReplayerInterface replayer)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time. For use with data replay.

Parameters:

startTime - start time for adding new rows

period - time interval between new row additions

replayer - data replayer

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(long periodNanos)
         throws Exception

Creates a table that adds a new row on a regular interval.

Parameters:

periodNanos - time interval between new row additions in nanoseconds.

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(long periodNanos,
                ReplayerInterface replayer)
         throws Exception

Creates a table that adds a new row on a regular interval. For use with data replay.

Parameters:

periodNanos - time interval between new row additions in nanoseconds.

replayer - data replayer

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(DBDateTime startTime,
                long periodNanos)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time.

Parameters:

startTime - start time for adding new rows

periodNanos - time interval between new row additions in nanoseconds.

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(DBDateTime startTime,
                long periodNanos,
                ReplayerInterface replayer)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time. For use with data replay.

Parameters:

startTime - start time for adding new rows

periodNanos - time interval between new row additions in nanoseconds.

replayer - data replayer

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(String startTime,
                long periodNanos)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time.

Parameters:

startTime - start time for adding new rows

periodNanos - time interval between new row additions in nanoseconds.

Returns:

time table

Throws:

Exception - problem creating the time table

timeTable

Table timeTable(String startTime,
                long periodNanos,
                ReplayerInterface replayer)
         throws Exception

Creates a table that adds a new row on a regular interval, starting from a specified time. For use with data replay.

Parameters:

startTime - start time for adding new rows

periodNanos - time interval between new row additions in nanoseconds.

replayer - data replayer

Returns:

time table

Throws:

Exception - problem creating the time table

deleteNamespace

void deleteNamespace(String namespace)

Delete all files related to the specified namespace.

Note: This is a dangerous API - don't use it if you don't fully understand the implications.

Parameters:

namespace - namespace to be deleted.

deleteTables

void deleteTables(String namespace,
                  String... tableNames)

Delete all files related to a set of tables. Database.removeTable(String, String) is a better option, unless the underlying table is damaged.

Parameters:

namespace - table namespace

tableNames - table names to delete

deleteMatchingTables

void deleteMatchingTables(String namespace,
                          String tableNameRegex)

Delete all files related to the set of tables whose names match the supplied regular expression.

Note: This only works for tables that still have a definition file, although it need not be readable.

Note: This is a dangerous API - don't use it if you don't fully understand the implications.

Parameters:

namespace - table namespace

tableNameRegex - table names in the given namespace that match this regular expression will be cleaned up.

addTable

void addTable(String namespace,
              String tableName,
              Table table)

Adds a table by name to the specified namespace.

Parameters:

namespace - table namespace

tableName - table name

table - table to add

Throws:

RuntimeException - table already exists

appendTable

void appendTable(String namespace,
                 String tableName,
                 Table table)

Appends to a table, or adds the table if it is not present. Adds a TableDefinition if necessary.

Parameters:

namespace - table namespace

tableName - table name

table - data to add or append

rm

default void rm(String namespace,
                String tableName)

Convenience method for Database.removeTable(String, String).

removeTable

void removeTable(String namespace,
                 String tableName)

Removes a table. This method is a better choice than deleteTables, unless the underlying table no longer has consistent metadata. Throws an exception for tables that don't exist. Does not remove intraday partitions.

Parameters:

namespace - table namespace

tableName - table name

Throws:

RuntimeException - table does not exist

replaceTable

void replaceTable(String namespace,
                  String tableName,
                  Table table)

Replaces a table with a new table, or adds the table, if it is not already present. Not guaranteed to be atomic in the case of failures.

Parameters:

namespace - table namespace

tableName - table name

table - data for the replacement table

addTableDefinition

void addTableDefinition(String namespace,
                        String tableName,
                        TableDefinition tableDefinition)

Adds a table definition to the specified namespace. Throws an exception if the table definition already exists.

Parameters:

namespace - table namespace

tableName - table name

tableDefinition - table definition to add

Throws:

RuntimeException - table definition already exists

removeTableDefinition

void removeTableDefinition(String namespace,
                           String tableName)

Removes a table definition.

Parameters:

namespace - table namespace

tableName - table name

Throws:

RuntimeException - table definition does not exist

replaceTableDefinition

void replaceTableDefinition(String namespace,
                            String tableName,
                            TableDefinition tableDefinition)

Replaces a table definition. Not guaranteed to be atomic in the case of failures. Does not throw an exception for tables that don't exist.

Parameters:

namespace - table namespace

tableName - table name

tableDefinition - table definition for the replacement

addTablePartition

void addTablePartition(String namespace,
                       String tableName,
                       String columnPartitionValue,
                       Table data)

Adds a single table partition (e.g. one date) to a partitioned table. Requires that a suitable TableDefinition has already been added. This variant implicitly uses internalPartitionValue set by the iris.defaultInternalPartitionNamingFunction server configuration. Throws an exception if the partition already exists.

Parameters:

namespace - table namespace

tableName - table name

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - data for this partition. Must *not* contain the partitioning column.

Throws:

RuntimeException - if the partition already exists

addTablePartition

void addTablePartition(String namespace,
                       String tableName,
                       String internalPartitionValue,
                       String columnPartitionValue,
                       Table data)

Adds a single table partition (e.g. one date) to a partitioned table. Requires that a suitable TableDefinition has already been added. Throws an exception if the partition already exists.

Parameters:

namespace - table namespace

tableName - table name

internalPartitionValue - internal (not user-visible) partition value.

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - data for this partition. Must *not* contain the partitioning column.

Throws:

RuntimeException - if the partition already exists

appendTablePartition

void appendTablePartition(String namespace,
                          String tableName,
                          String columnPartitionValue,
                          Table data)

Adds or appends to a single table location (e.g. one date) to a partitioned table. Requires that a suitable TableDefinition has already been added. This variant implicitly uses internalPartitionName set by the iris.defaultInternalPartitionNamingFunction server configuration.

Parameters:

namespace - table namespace

tableName - table name

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - data to append to this partition. Must *not* contain the partitioning column.

appendTablePartition

void appendTablePartition(String namespace,
                          String tableName,
                          String internalPartitionValue,
                          String columnPartitionValue,
                          Table data)

Adds or appends to a single table location (e.g. one date) to a partitioned table. Requires that a suitable TableDefinition has already been added.

Parameters:

namespace - table namespace

tableName - table name

internalPartitionValue - internal (not user-visible) partition value.

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - data to append to this partition. Must *not* contain the partitioning column.

removeTablePartition

void removeTablePartition(String namespace,
                          String tableName,
                          String columnPartitionValue)

Removes a single table location (e.g. one date) from a partitioned table. Requires that a suitable TableDefinition still exists. This variant implicitly uses internalPartitionValue set by the iris.defaultInternalPartitionNamingFunction server configuration.

Parameters:

namespace - table namespace

tableName - table name

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

removeTablePartition

void removeTablePartition(String namespace,
                          String tableName,
                          String internalPartitionValue,
                          String columnPartitionValue)

Removes a single table location (e.g. one date) from a partitioned table. Requires that a suitable TableDefinition still exists.

Parameters:

namespace - table namespace

tableName - table name

internalPartitionValue - internal (not user-visible) partition value.

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

replaceTablePartition

void replaceTablePartition(String namespace,
                           String tableName,
                           String columnPartitionValue,
                           Table data)

Removes and re-adds a single table location (e.g. one date) from/to a partitioned table. Requires that a suitable TableDefinition has already been added. This variant implicitly uses internalPartitionName set by the iris.defaultInternalPartitionNamingFunction server configuration. Not guaranteed to be atomic in the case of failures.

Parameters:

namespace - table namespace

tableName - table name

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - data for this partition. Must *not* contain the partitioning column.

replaceTablePartition

void replaceTablePartition(String namespace,
                           String tableName,
                           String internalPartitionValue,
                           String columnPartitionValue,
                           Table data)

Replaces a single table location (e.g. one date) from/to a partitioned table. Requires that a suitable TableDefinition has already been added. Not guaranteed to be atomic in the case of failures.

Parameters:

namespace - table namespace

tableName - table name

internalPartitionValue - internal (not user-visible) partition value.

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - data to replace this partition. Must *not* contain the partitioning column.

addPartitionedTableDefinitionIfAbsent

void addPartitionedTableDefinitionIfAbsent(@NotNull
                                           String namespace,
                                           @NotNull
                                           String tableName,
                                           @NotNull
                                           String partitioningColumnName,
                                           @NotNull
                                           TableDefinition prototypeDefinition)

Adds a table definition for a partitioned table, if the table definition is absent.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

prototypeDefinition - prototype table definition used to generate the table definition

addPartitionedTableDefinitionIfAbsent

void addPartitionedTableDefinitionIfAbsent(@NotNull
                                           String namespace,
                                           @NotNull
                                           String tableName,
                                           @NotNull
                                           String partitioningColumnName,
                                           @NotNull
                                           TableDefinition prototypeDefinition,
                                           boolean checkPartitioningColumn)

Adds a table definition for a partitioned table, if the table definition is absent.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

prototypeDefinition - prototype table definition used to generate the table definition

checkPartitioningColumn - true to make sure the partitioning columns are the same

addPartitionedTableDefinition

void addPartitionedTableDefinition(@NotNull
                                   String namespace,
                                   @NotNull
                                   String tableName,
                                   @NotNull
                                   String partitioningColumnName,
                                   @NotNull
                                   TableDefinition prototypeDefinition)

Adds a table definition for a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

prototypeDefinition - prototype table definition used to generate the table definition

addPartitionedTableDefinition

void addPartitionedTableDefinition(@NotNull
                                   String namespace,
                                   @NotNull
                                   String tableName,
                                   @NotNull
                                   TableDefinition prototypeDefinition)

Adds a table definition for a partitioned table. The partitioning column depends on the iris.defaultColumnPartitionColumnName server configuration.

Parameters:

namespace - table namespace

tableName - table name

prototypeDefinition - prototype table definition used to generate the table definition

addTablePartitionAndDefinition

void addTablePartitionAndDefinition(@NotNull
                                    String namespace,
                                    @NotNull
                                    String tableName,
                                    @NotNull
                                    String partitioningColumnName,
                                    @NotNull
                                    String internalPartitionValue,
                                    @NotNull
                                    String columnPartitionValue,
                                    @NotNull
                                    Table data)

Adds a table definition and data for a partitioned table. This operation is not atomic.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

internalPartitionValue - internal (not user-visible) partition value.

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - table containing the data and table definition to write out

addColumnPartitionAndDefinition

@Deprecated
default void addColumnPartitionAndDefinition(@NotNull
                                                         String namespace,
                                                         @NotNull
                                                         String tableName,
                                                         @NotNull
                                                         String partitioningColumnName,
                                                         @NotNull
                                                         String internalPartitionValue,
                                                         @NotNull
                                                         String columnPartitionValue,
                                                         @NotNull
                                                         Table data)

Deprecated. Use Database.addTablePartitionAndDefinition(String, String, String, String, String, Table).

addTablePartitionAndDefinition

void addTablePartitionAndDefinition(@NotNull
                                    String namespace,
                                    @NotNull
                                    String tableName,
                                    @NotNull
                                    String partitioningColumnName,
                                    @NotNull
                                    String columnPartitionValue,
                                    @NotNull
                                    Table data)

Adds a table definition and data for a partitioned table location. This operation is not atomic. This variant implicitly uses internalPartitionName set by the iris.defaultInternalPartitionNamingFunction server configuration.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

data - table containing the data and table definition to write out

addColumnPartitionAndDefinition

@Deprecated
default void addColumnPartitionAndDefinition(@NotNull
                                                         String namespace,
                                                         @NotNull
                                                         String tableName,
                                                         @NotNull
                                                         String partitioningColumnName,
                                                         @NotNull
                                                         String columnPartitionValue,
                                                         @NotNull
                                                         Table data)

Deprecated. Use Database.addTablePartitionAndDefinition(String, String, String, String, Table).

appendCentral

void appendCentral(String namespace,
                   String tableName,
                   String columnPartitionValue,
                   Table table,
                   boolean flush)
            throws IOException

Append to a table via a centralized table appender.

Note: The table data is appended to a host-specific internal partition, and the specified column partition value.

Note: This applies only to partitioned user tables.

Parameters:

namespace - table namespace

tableName - table name

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

table - new data

flush - true to flush the table to disk; false to wait for flushing (if the implementation supports waiting)

Throws:

IOException - problem appending

appendCentral

void appendCentral(String namespace,
                   String tableName,
                   Table table,
                   boolean flush)
            throws IOException

Append to a table via a centralized table appender. This variant implicitly uses a default partitioning column value set by the iris.defaultColumnPartitionNamingFunction function.

Note: This applies only to partitioned user tables.

Parameters:

namespace - table namespace

tableName - table name

table - new data

flush - true to flush the table to disk; false to wait for flushing (if the implementation supports waiting)

Throws:

IOException - problem appending

closeAndDeleteCentral

void closeAndDeleteCentral(String namespace,
                           String tableName)
                    throws IOException

Close all logger connections to the centralized logging for the specified table, and then atomically delete all centrally logged table data for this namespace and table name.

USE WITH EXTREME CAUTION!!!

Note: This applies only to partitioned user tables.

Parameters:

namespace - table namespace

tableName - table name

Throws:

IOException - problems encountered

logPartitionTableSnapshot

Database.LogHandle logPartitionTableSnapshot(String namespace,
                                             String tableName,
                                             String partitioningColumnName,
                                             String columnPartitionValue,
                                             Table table,
                                             String logInterval,
                                             ReplayerInterface replayer,
                                             boolean append)
                                      throws Exception

Snapshots a table at a regular interval and writes the snapshot to a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

table - table to snapshot and log (does not contain the partition column)

logInterval - interval to log snapshots at

replayer - data replayer

append - true to append to an existing table; false to replace the existing table.

Returns:

log handle

Throws:

Exception - problems

logPartitionTableSnapshot

Database.LogHandle logPartitionTableSnapshot(String namespace,
                                             String tableName,
                                             String partitioningColumnName,
                                             String columnPartitionValue,
                                             Table table,
                                             String logInterval,
                                             boolean append)
                                      throws Exception

Snapshots a table at a regular interval and writes the snapshot to a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

table - table to snapshot and log (does not contain the partition column)

logInterval - interval to log snapshots at

append - true to append to an existing table; false to replace the existing table.

Returns:

log handle

Throws:

Exception - problems

logPartitionTableSnapshot

Database.LogHandle logPartitionTableSnapshot(String namespace,
                                             String tableName,
                                             String partitioningColumnName,
                                             String columnPartitionValue,
                                             Table table,
                                             long logIntervalMillis,
                                             ReplayerInterface replayer,
                                             boolean append)
                                      throws IOException

Snapshots a table at a regular interval and writes the snapshot to a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

table - table to snapshot and log (does not contain the partition column)

logIntervalMillis - interval in milliseconds to log snapshots at

replayer - data replayer

append - true to append to an existing table; false to replace the existing table.

Returns:

log handle

Throws:

IOException - problems

logPartitionTableSnapshot

Database.LogHandle logPartitionTableSnapshot(String namespace,
                                             String tableName,
                                             String partitioningColumnName,
                                             String columnPartitionValue,
                                             Table table,
                                             long logIntervalMillis,
                                             boolean append)
                                      throws IOException

Snapshots a table at a regular interval and writes the snapshot to a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

table - table to snapshot and log (does not contain the partition column)

logIntervalMillis - interval in milliseconds to log snapshots at

append - true to append to an existing table; false to replace the existing table.

Returns:

log handle

Throws:

IOException - problems

logPartitionTableIncremental

Database.LogHandle logPartitionTableIncremental(String namespace,
                                                String tableName,
                                                String partitioningColumnName,
                                                String columnPartitionValue,
                                                Table table,
                                                ReplayerInterface replayer,
                                                boolean append)
                                         throws IOException

Writes all changes in a table to a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

table - table to log (does not contain the partition column)

replayer - data replayer

append - true to append to an existing table; false to replace the existing table.

Returns:

log handle

Throws:

IOException - problems

logPartitionTableIncremental

Database.LogHandle logPartitionTableIncremental(String namespace,
                                                String tableName,
                                                String partitioningColumnName,
                                                String columnPartitionValue,
                                                Table table,
                                                boolean append)
                                         throws IOException

Writes all changes in a table to a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

table - table to log (does not contain the partition column)

append - true to append to an existing table; false to replace the existing table.

Returns:

log handle

Throws:

IOException - problems

getColumnPartitionTableWriter

TableWriter getColumnPartitionTableWriter(String namespace,
                                          String tableName,
                                          String partitioningColumnName,
                                          String columnPartitionValue,
                                          TableDefinition tableDefinition,
                                          boolean append)

Gets a table writer for a partitioned table.

Parameters:

namespace - table namespace

tableName - table name

partitioningColumnName - name of the partitioning column

columnPartitionValue - column partition value (e.g. "2015-09-25" for a Date partitioning column).

tableDefinition - table definition

append - true to append to an existing partition; false to overwrite an existing partition.

Returns:

table writer

getTableWriter

TableWriter getTableWriter(String namespace,
                           String tableName,
                           TableDefinition tableDefinition,
                           boolean append)
                    throws IOException

Gets a table writer for an unpartitioned table.

Parameters:

namespace - table namespace

tableName - table name

tableDefinition - table definition

append - true to append to an existing partition; false to overwrite an existing partition.

Returns:

table writer

Throws:

IOException