net.quasardb.qdb.ts

Class Table

java.lang.Object

net.quasardb.qdb.ts.Table

All Implemented Interfaces:

Serializable

public class Table
extends Object
implements Serializable

Represents a timeseries Table. Upon construction, actively resolves metadata such as the associated Columns. Can also be used to construct new QuasarDB timeseries tables.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Column[]	columns
protected String	name
protected long	shardSizeMillis
protected long	shardSizeSecs

Constructor Summary

Constructors

Constructor and Description
Table(Column[] columns, long shardSizeMillis, String name) Initialize a new timeseries table.
Table(Session session, String name) Initialize a new timeseries table.

Method Summary

Modifier and Type	Method and Description
static AutoFlushWriter	asyncAutoFlushWriter(Session session, String name) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static AutoFlushWriter	asyncAutoFlushWriter(Session session, String name, long threshold) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static AutoFlushWriter	asyncAutoFlushWriter(Session session, Table table) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static AutoFlushWriter	asyncAutoFlushWriter(Session session, Table table, long threshold) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static Writer	asyncWriter(Session session, String name) Initializes new writer for a single timeseries table using high-speed buffered writes.
static Writer	asyncWriter(Session session, Table table) Initializes new writer for a timeseries table using high-speed buffered writes.
static void	attachTag(Session session, String tableName, String tag) Attaches a tag to an existing table.
static void	attachTag(Session session, Table table, String tag) Attaches a tag to an existing table.
static void	attachTags(Session session, String tableName, List<String> tags) Attaches tags to an existing table.
static void	attachTags(Session session, Table table, List<String> tags) Attaches tags to an existing table.
static AutoFlushWriter	autoFlushWriter(Session session, String name) Initializes new writer for a timeseries table that periodically flushes its local cache.
static AutoFlushWriter	autoFlushWriter(Session session, String name, long threshold) Initializes new writer for a timeseries table that periodically flushes its local cache.
static AutoFlushWriter	autoFlushWriter(Session session, Table table) Initializes new writer for a timeseries table that periodically flushes its local cache.
static AutoFlushWriter	autoFlushWriter(Session session, Table table, long threshold) Initializes new writer for a timeseries table that periodically flushes its local cache.
int	columnIndexById(String id) Utility function that looks up a column's index by its id.
static Table	create(Session session, String name, Column[] columns) Create new timeseries table with a default shard size.
static Table	create(Session session, String name, Column[] columns, long shardSize) Create new timeseries table.
static Table	create(Session session, String name, Table skeleton) Create new timeseries table by copying a 'skeleton' table's schema and using the default shard size.
static Table	create(Session session, String name, Table skeleton, long shardSize) Create new timeseries table by copying a 'skeleton' table's schema.
static Writer	expAsyncWriter(Session session, String name) Initializes new, experimental high-performance exp columns writer with asynchronous push mode.
static Writer	expAsyncWriter(Session session, Table table) Initializes new, experimental high-performance exp columns writer with asynchronous push mode.
static Writer	expFastWriter(Session session, String name) Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write.
static Writer	expFastWriter(Session session, Table table) Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write.
static Writer	expTruncateWriter(Session session, String name) Initializes new, experimental high-performance exp columns writer.
static Writer	expTruncateWriter(Session session, Table table) Initializes new, experimental high-performance exp columns writer.
static Writer	expWriter(Session session, String name) Initializes new, experimental high-performance writer.
static Writer	expWriter(Session session, Table table) Initializes new, experimental high-performance writer.
static AutoFlushWriter	fastAutoFlushWriter(Session session, String name) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static AutoFlushWriter	fastAutoFlushWriter(Session session, String name, long threshold) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static AutoFlushWriter	fastAutoFlushWriter(Session session, Table table) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static AutoFlushWriter	fastAutoFlushWriter(Session session, Table table, long threshold) Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.
static Writer	fastWriter(Session session, String name) Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write.
static Writer	fastWriter(Session session, Table table) Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write.
Column[]	getColumns() Returns column representation of this table.
static Column[]	getColumns(Session session, String name) Returns column layout of table.
Value.Type[]	getColumnTypes() Returns the types of each of the columns.
String	getName() Returns the table name.
long	getShardSize() Returns this table's shard size (in seconds)
static long	getShardSize(Session session, String tableName) Returns the shard size (in milliseconds) of the table.
static long	getShardSize(Session session, Table table) Returns the shard size (in seconds) of the table.
long	getShardSizeMillis() Returns this table's shard size (in milliseconds)
static long	getShardSizeMillis(Session session, Table table) Returns the shard size (in milliseconds) of the table.
static Table	likeOther(Table other, String name) Creates a new table object with the exact same structure and shard size as another table.
static Writer	pinnedAsyncWriter(Session session, String name) Initializes new, experimental high-performance pinned columns writer with asynchronous push mode.
static Writer	pinnedAsyncWriter(Session session, Table table) Initializes new, experimental high-performance pinned columns writer with asynchronous push mode.
static Writer	pinnedFastWriter(Session session, String name) Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write.
static Writer	pinnedFastWriter(Session session, Table table) Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write.
static Writer	pinnedTruncateWriter(Session session, String name) Initializes new, experimental high-performance pinned columns writer.
static Writer	pinnedTruncateWriter(Session session, Table table) Initializes new, experimental high-performance pinned columns writer.
static Writer	pinnedWriter(Session session, String name) Initializes new, experimental high-performance pinned columns writer.
static Writer	pinnedWriter(Session session, Table table) Initializes new, experimental high-performance pinned columns writer.
static Reader	reader(Session session, String name, TimeRange[] ranges) Initializes new reader for a timeseries table.
static Reader	reader(Session session, Table table, TimeRange[] ranges) Initializes new reader for a timeseries table.
static void	remove(Session session, String name) Remove existing timeseries table.
static void	remove(Session session, Table table) Remove existing timeseries table.
String	toString()
static Writer	truncateWriter(Session session, String name) Initializes new writer for a single table that replaces any existing data with the new data, rather than just adding.
static Writer	truncateWriter(Session session, Table table) Initializes new writer for a single table that replaces any existing data with the new data, rather than just adding.
static Writer	writer(Session session, String name) Initializes new writer for a single timeseries table.
static Writer	writer(Session session, Table table) Initializes new writer for a timeseries table.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

shardSizeMillis

protected long shardSizeMillis

shardSizeSecs

protected long shardSizeSecs

columns

protected Column[] columns

Constructor Detail

Table

public Table(Session session,
             String name)

Initialize a new timeseries table.

Parameters:

session - Active connection with the QdbCluster

name - Timeseries name. Must already exist.

Table

public Table(Column[] columns,
             long shardSizeMillis,
             String name)

Initialize a new timeseries table.

Parameters:

columns - Table columns

name - Timeseries name. Must already exist.

Method Detail

likeOther

public static Table likeOther(Table other,
                              String name)

Creates a new table object with the exact same structure and shard size as another table. This is an efficient way to initialize large sets of tables that all share a common shard size / schema, as no lookups with the QuasarDB cluster are performed.

Parameters:

other - Table to use the schema and shard size of

name - Name of the new table to be initialized.

create

public static Table create(Session session,
                           String name,
                           Table skeleton)

Create new timeseries table by copying a 'skeleton' table's schema and using the default shard size.

Parameters:

session - Active session with the QuasarDB cluster.

name - Unique identifier for this timeseries table.

skeleton - Skeleton table's schema to be copied.

Returns:

Reference to the newly created timeseries table.

create

public static Table create(Session session,
                           String name,
                           Table skeleton,
                           long shardSize)

Create new timeseries table by copying a 'skeleton' table's schema.

Parameters:

session - Active session with the QuasarDB cluster.

name - Unique identifier for this timeseries table.

skeleton - Skeleton table's schema to be copied.

shardSize - The size of the shards in ms.

Returns:

Reference to the newly created timeseries table.

create

public static Table create(Session session,
                           String name,
                           Column[] columns)

Create new timeseries table with a default shard size.

Parameters:

session - Active session with the QuasarDB cluster.

name - Unique identifier for this timeseries table.

columns - Column definitions of this table. The ordering of the array will persist through the table definition and cannot be changed after creation.

Returns:

Reference to the newly created timeseries table.

create

public static Table create(Session session,
                           String name,
                           Column[] columns,
                           long shardSize)

Create new timeseries table.

Parameters:

session - Active session with the QuasarDB cluster.

name - Unique identifier for this timeseries table.

columns - Column definitions of this table. The ordering of the array will persist through the table definition and cannot be changed after creation.

shardSize - The size of the shards in ms.

Returns:

Reference to the newly created timeseries table.

remove

public static void remove(Session session,
                          String name)

Remove existing timeseries table.

Parameters:

session - Active session with the QuasarDB cluster

name - Unique identifier for this timeseries table.

remove

public static void remove(Session session,
                          Table table)

Remove existing timeseries table.

Parameters:

session - Active session with the QuasarDB cluster

table - Table to remove

writer

public static Writer writer(Session session,
                            String name)

Initializes new writer for a single timeseries table.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

writer

public static Writer writer(Session session,
                            Table table)

Initializes new writer for a timeseries table.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

pinnedWriter

public static Writer pinnedWriter(Session session,
                                  String name)

Initializes new, experimental high-performance pinned columns writer.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

pinnedWriter

public static Writer pinnedWriter(Session session,
                                  Table table)

Initializes new, experimental high-performance pinned columns writer.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

expWriter

public static Writer expWriter(Session session,
                               String name)

Initializes new, experimental high-performance writer.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

expWriter

public static Writer expWriter(Session session,
                               Table table)

Initializes new, experimental high-performance writer.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

pinnedTruncateWriter

public static Writer pinnedTruncateWriter(Session session,
                                          String name)

Initializes new, experimental high-performance pinned columns writer.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

pinnedTruncateWriter

public static Writer pinnedTruncateWriter(Session session,
                                          Table table)

Initializes new, experimental high-performance pinned columns writer.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

expTruncateWriter

public static Writer expTruncateWriter(Session session,
                                       String name)

Initializes new, experimental high-performance exp columns writer.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

expTruncateWriter

public static Writer expTruncateWriter(Session session,
                                       Table table)

Initializes new, experimental high-performance exp columns writer.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

asyncWriter

public static Writer asyncWriter(Session session,
                                 String name)

Initializes new writer for a single timeseries table using high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

asyncWriter

public static Writer asyncWriter(Session session,
                                 Table table)

Initializes new writer for a timeseries table using high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

pinnedAsyncWriter

public static Writer pinnedAsyncWriter(Session session,
                                       String name)

Initializes new, experimental high-performance pinned columns writer with asynchronous push mode.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

pinnedAsyncWriter

public static Writer pinnedAsyncWriter(Session session,
                                       Table table)

Initializes new, experimental high-performance pinned columns writer with asynchronous push mode.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

expAsyncWriter

public static Writer expAsyncWriter(Session session,
                                    String name)

Initializes new, experimental high-performance exp columns writer with asynchronous push mode.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

expAsyncWriter

public static Writer expAsyncWriter(Session session,
                                    Table table)

Initializes new, experimental high-performance exp columns writer with asynchronous push mode.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

fastWriter

public static Writer fastWriter(Session session,
                                String name)

Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write. This is especially useful when you do lots of small, incremental pushes, such as streaming data.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

fastWriter

public static Writer fastWriter(Session session,
                                Table table)

Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write. This is especially useful when you do lots of small, incremental pushes, such as streaming data.

Parameters:

session - Active session with the QuasarDB cluster.

table - Table to insert into.

pinnedFastWriter

public static Writer pinnedFastWriter(Session session,
                                      String name)

Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write. This is especially useful when you do lots of small, incremental pushes, such as streaming data.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

pinnedFastWriter

public static Writer pinnedFastWriter(Session session,
                                      Table table)

Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write. This is especially useful when you do lots of small, incremental pushes, such as streaming data.

Parameters:

session - Active session with the QuasarDB cluster.

table - Table to insert into.

expFastWriter

public static Writer expFastWriter(Session session,
                                   String name)

Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write. This is especially useful when you do lots of small, incremental pushes, such as streaming data.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

expFastWriter

public static Writer expFastWriter(Session session,
                                   Table table)

Initializes new writer for a single table that makes use of in-place updates rather than copy-on-write. This is especially useful when you do lots of small, incremental pushes, such as streaming data.

Parameters:

session - Active session with the QuasarDB cluster.

table - Table to insert into.

truncateWriter

public static Writer truncateWriter(Session session,
                                    String name)

Initializes new writer for a single table that replaces any existing data with the new data, rather than just adding. This is recommended if you want the ability to retry operations, and you are not inserting into the same table from multiple writers.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

truncateWriter

public static Writer truncateWriter(Session session,
                                    Table table)

Initializes new writer for a single table that replaces any existing data with the new data, rather than just adding. This is recommended if you want the ability to retry operations, and you are not inserting into the same table from multiple writers.

Parameters:

session - Active session with the QuasarDB cluster.

table - Table to insert into.

autoFlushWriter

public static AutoFlushWriter autoFlushWriter(Session session,
                                              String name)

Initializes new writer for a timeseries table that periodically flushes its local cache.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

autoFlushWriter

public static AutoFlushWriter autoFlushWriter(Session session,
                                              Table table)

Initializes new writer for a timeseries table that periodically flushes its local cache.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

autoFlushWriter

public static AutoFlushWriter autoFlushWriter(Session session,
                                              String name,
                                              long threshold)

Initializes new writer for a timeseries table that periodically flushes its local cache.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

threshold - The amount of rows to keep in local buffer before automatic flushing occurs.

autoFlushWriter

public static AutoFlushWriter autoFlushWriter(Session session,
                                              Table table,
                                              long threshold)

Initializes new writer for a timeseries table that periodically flushes its local cache.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

threshold - The amount of rows to keep in local buffer before automatic flushing occurs.

asyncAutoFlushWriter

public static AutoFlushWriter asyncAutoFlushWriter(Session session,
                                                   String name)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

asyncAutoFlushWriter

public static AutoFlushWriter asyncAutoFlushWriter(Session session,
                                                   Table table)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

asyncAutoFlushWriter

public static AutoFlushWriter asyncAutoFlushWriter(Session session,
                                                   String name,
                                                   long threshold)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

threshold - The amount of rows to keep in local buffer before automatic flushing occurs.

asyncAutoFlushWriter

public static AutoFlushWriter asyncAutoFlushWriter(Session session,
                                                   Table table,
                                                   long threshold)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

threshold - The amount of rows to keep in local buffer before automatic flushing occurs.

fastAutoFlushWriter

public static AutoFlushWriter fastAutoFlushWriter(Session session,
                                                  String name)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

fastAutoFlushWriter

public static AutoFlushWriter fastAutoFlushWriter(Session session,
                                                  Table table)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

fastAutoFlushWriter

public static AutoFlushWriter fastAutoFlushWriter(Session session,
                                                  String name,
                                                  long threshold)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

threshold - The amount of rows to keep in local buffer before automatic flushing occurs.

fastAutoFlushWriter

public static AutoFlushWriter fastAutoFlushWriter(Session session,
                                                  Table table,
                                                  long threshold)

Initializes new writer for a timeseries table that periodically flushes its local cache, and makes use of high-speed buffered writes.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

threshold - The amount of rows to keep in local buffer before automatic flushing occurs.

reader

public static Reader reader(Session session,
                            String name,
                            TimeRange[] ranges)

Initializes new reader for a timeseries table.

Parameters:

session - Active session with the QuasarDB cluster.

name - Timeseries table name. Must already exist.

ranges - Time ranges to look for.

reader

public static Reader reader(Session session,
                            Table table,
                            TimeRange[] ranges)

Initializes new reader for a timeseries table.

Parameters:

session - Active session with the QuasarDB cluster.

table - Timeseries table.

ranges - Time time ranges to look for.

attachTag

public static void attachTag(Session session,
                             Table table,
                             String tag)

Attaches a tag to an existing table.

Parameters:

session - Active session with the QuasarDB cluster

table - Timeseries table

tag - Tag to attach

attachTag

public static void attachTag(Session session,
                             String tableName,
                             String tag)

Attaches a tag to an existing table.

Parameters:

session - Active session with the QuasarDB cluster

tableName - Name of the timeseries table

tag - Tag to attach

attachTags

public static void attachTags(Session session,
                              Table table,
                              List<String> tags)

Attaches tags to an existing table.

Parameters:

session - Active session with the QuasarDB cluster

table - Timeseries table

tags - Tags to attach

attachTags

public static void attachTags(Session session,
                              String tableName,
                              List<String> tags)

Attaches tags to an existing table.

Parameters:

session - Active session with the QuasarDB cluster

tableName - Name of the timeseries table

tags - Tags to attach

getName

public String getName()

Returns the table name.

getShardSizeMillis

public long getShardSizeMillis()

Returns this table's shard size (in milliseconds)

getShardSize

public long getShardSize()

Returns this table's shard size (in seconds)

getShardSizeMillis

public static long getShardSizeMillis(Session session,
                                      Table table)

Returns the shard size (in milliseconds) of the table.

getShardSize

public static long getShardSize(Session session,
                                Table table)

Returns the shard size (in seconds) of the table.

getShardSize

public static long getShardSize(Session session,
                                String tableName)

Returns the shard size (in milliseconds) of the table.

getColumns

public static Column[] getColumns(Session session,
                                  String name)

Returns column layout of table.

Parameters:

session - Active session with the QuasarDB cluster.

name - Unique identifier for this timeseries table.

getColumns

public Column[] getColumns()

Returns column representation of this table.

getColumnTypes

public Value.Type[] getColumnTypes()

Returns the types of each of the columns.

columnIndexById

public int columnIndexById(String id)

Utility function that looks up a column's index by its id. The first column starts with 0.

Parameters:

id - String identifier of the column.

Returns:

The index of the column inside the timeseries table definition.

toString

public String toString()

Overrides:

toString in class Object