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

Constructor Summary

Constructors

Constructor and Description
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 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.
String	getName() Returns the timeseries table name.
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.
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

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.

Method Detail

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.

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.

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.

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.

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 timeseries table name.

getColumns

public Column[] getColumns()

Returns column representation of this table.

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