public interface Table
Modifier and Type | Interface and Description |
---|---|
static class |
Table.TableGroup
ENUM for table groups.
|
static class |
Table.TableStatus |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CAPABILITIES_FIELD |
static java.util.EnumSet<LiveViewTableCapability> |
CAPABILITIES_FOR_FILTERED_TABLES |
static java.lang.String |
CEP_TABLES_GROUP |
static java.lang.String |
CREATE_TIME |
static java.util.EnumSet<LiveViewTableCapability> |
DEFAULT_CAPABILITIES |
static java.lang.String |
DESCRIPTION_FIELD |
static java.lang.String |
FIELDLIST_FIELD |
static java.lang.String |
FILTER |
static java.lang.String |
GROUP_FIELD |
static java.lang.String |
INDICES_FIELD |
static java.lang.String |
IS_ENABLED_FIELD |
static java.lang.String |
IS_SYSTEM_TABLE |
static java.lang.String |
KEY_FIELDS_CSV |
static java.util.EnumSet<LiveViewQueryLanguage> |
LIVEVIEW_LANGUAGE_ONLY |
static java.lang.String |
LV_ALERTS_TABLE |
static java.lang.String |
LV_STATS_TABLE |
static java.lang.String |
NAME_FIELD |
static java.lang.String |
NUM_SERVERS |
static java.lang.String |
QUERY_LANGUAGES_FIELD |
static java.lang.String |
REJECTED_SERVERS |
static java.lang.String |
REQUIRED_CLIENT_CAPABILITIES |
static java.lang.String |
SHORT_DESCRIPTION_FIELD |
static java.lang.String |
SM_DEFINED |
static java.lang.String |
SM_DISCOVERD_AT_START |
static java.lang.String |
SM_DYANAMICALLY_ADDED |
static java.lang.String |
SM_FILTERED_TABLE_DISCOVERED_AT_START_TIME |
static java.lang.String |
SM_FILTERED_TABLE_DYNAMICALLY_ADDED |
static java.lang.String |
SM_FILTERED_TABLE_ERROR_PREDICATE_VALIDATION |
static java.lang.String |
SM_LOADING |
static java.lang.String |
SM_REMOVING |
static java.lang.String |
SM_TABLE_CONTAINER_MISSING |
static java.lang.String |
STATUS_FIELD |
static java.lang.String |
STATUS_MESSAGE_FIELD |
static java.lang.String |
SYS_TABLES_GROUP |
static java.lang.String |
TABLE_SCHEMA_FIELD |
static java.lang.String |
TABLE_SPACE_FIELD |
static java.lang.String |
TABLES_TABLE_NAME
A special group used to identify system tables in LiveView.
|
Modifier and Type | Method and Description |
---|---|
Timestamp |
getCreateTime()
Returns the time when the table was created
|
java.lang.String |
getDescription()
A description of the table
|
java.util.List<Schema.Field> |
getFields()
Returns the fields describing the table columns.
|
java.util.List<Schema.Field> |
getFields(boolean includeInternal)
Returns the fields describing the table columns.
|
java.lang.String |
getFilter()
Returns the filter on the base table
|
java.lang.String |
getGroup()
A table can be assigned to a logical group.
|
java.util.List<java.util.List<java.lang.String>> |
getIndices()
Returns all the indices for the table.
|
java.util.List<Schema.Field> |
getKeyFields()
Returns the schema which describes the key for the records in this table.
|
java.lang.String |
getKeyFieldsCsv()
Returns the key fields table in the form of CSV.
|
java.lang.String |
getName()
The name of the table.
|
java.util.EnumSet<LiveViewQueryLanguage> |
getQueryLanguages()
Returns the languages that can be used for queries against this table.
|
java.lang.String |
getShortDescription()
A short description of the table
|
java.util.EnumSet<LiveViewTableCapability> |
getTableCapabilities()
Returns the capabilities that this Table supports.
|
TablePublisher |
getTablePublisher(java.lang.String publisherName)
Retrieve a publisher instance allowing a client to publish data to this table with the default buffer size
TablePublisher.PUBLISH_BUFFER_SIZE_DEFAULT and
flush interval TablePublisher.PUBLISH_INTERVAL_DEFAULT . |
TablePublisher |
getTablePublisher(java.lang.String publisherName,
int bufferSize,
long flushInterval,
java.util.concurrent.TimeUnit flushIntervalTimeUnit)
Retrieve a publisher instance allowing the client to publish data to the table.
|
java.lang.String |
getTableSpaceRef()
Returns the table space reference for the given table.
|
Table.TableStatus |
getTableStatus()
Get the status of the table.
|
java.lang.String |
getTableStatusMessage()
Returns the table status message.
|
java.util.Collection<java.lang.String> |
getUnmetClientCapabilities()
Every table might have requiredClientCapabilities which
|
boolean |
isEnabled()
Sometimes Tables will be disabled, because the Container that they are in has been shut down.
|
boolean |
isSystemTable()
Returns true if the table is a system table.
|
static final java.lang.String LV_STATS_TABLE
static final java.lang.String LV_ALERTS_TABLE
static final java.lang.String TABLES_TABLE_NAME
static final java.lang.String NAME_FIELD
static final java.lang.String GROUP_FIELD
static final java.lang.String TABLE_SPACE_FIELD
static final java.lang.String DESCRIPTION_FIELD
static final java.lang.String SHORT_DESCRIPTION_FIELD
static final java.lang.String QUERY_LANGUAGES_FIELD
static final java.lang.String CAPABILITIES_FIELD
static final java.lang.String IS_ENABLED_FIELD
static final java.lang.String FIELDLIST_FIELD
static final java.lang.String TABLE_SCHEMA_FIELD
static final java.lang.String KEY_FIELDS_CSV
static final java.lang.String REQUIRED_CLIENT_CAPABILITIES
static final java.lang.String INDICES_FIELD
static final java.lang.String STATUS_FIELD
static final java.lang.String STATUS_MESSAGE_FIELD
static final java.lang.String IS_SYSTEM_TABLE
static final java.lang.String CREATE_TIME
static final java.lang.String FILTER
static final java.lang.String NUM_SERVERS
static final java.lang.String REJECTED_SERVERS
static final java.lang.String SM_DISCOVERD_AT_START
static final java.lang.String SM_REMOVING
static final java.lang.String SM_DEFINED
static final java.lang.String SM_LOADING
static final java.lang.String SM_TABLE_CONTAINER_MISSING
static final java.lang.String SM_DYANAMICALLY_ADDED
static final java.lang.String SM_FILTERED_TABLE_DISCOVERED_AT_START_TIME
static final java.lang.String SM_FILTERED_TABLE_ERROR_PREDICATE_VALIDATION
static final java.lang.String SM_FILTERED_TABLE_DYNAMICALLY_ADDED
static final java.lang.String SYS_TABLES_GROUP
static final java.lang.String CEP_TABLES_GROUP
static final java.util.EnumSet<LiveViewQueryLanguage> LIVEVIEW_LANGUAGE_ONLY
static final java.util.EnumSet<LiveViewTableCapability> DEFAULT_CAPABILITIES
static final java.util.EnumSet<LiveViewTableCapability> CAPABILITIES_FOR_FILTERED_TABLES
java.lang.String getName()
java.lang.String getGroup()
java.lang.String getShortDescription()
java.lang.String getDescription()
java.util.List<Schema.Field> getFields()
java.util.List<Schema.Field> getFields(boolean includeInternal)
includeInternal
- specifies whether to include system internal fields in the listjava.util.List<Schema.Field> getKeyFields()
java.util.EnumSet<LiveViewQueryLanguage> getQueryLanguages()
LiveViewQueryLanguage
java.util.EnumSet<LiveViewTableCapability> getTableCapabilities()
LiveViewTableCapability
TablePublisher getTablePublisher(java.lang.String publisherName)
TablePublisher.PUBLISH_BUFFER_SIZE_DEFAULT
and
flush interval TablePublisher.PUBLISH_INTERVAL_DEFAULT
.publisherName
- assigns a name to the publisher. Data published will include the publisher
name for tracking and recoverability purposes.TablePublisher getTablePublisher(java.lang.String publisherName, int bufferSize, long flushInterval, java.util.concurrent.TimeUnit flushIntervalTimeUnit)
publisherName
- assigns a name to the publisher. Data published will include the publisher
name for tracking and recoverability purposes.bufferSize
- number of tuples to buffer client side before sending to server. A higher number
produces better throughput but higher latency. Ignored for LowLatencyPublisherflushInterval
- The interval between flushing the buffered tuples if the buffer does not completely fill. If a flushInterval
of less than or equal to zero specified, a low latency TablePublisher implementation will be used to sends data to the server
on the client's thread. Note the LowLatencyPublisher ignores bufferSize.flushIntervalTimeUnit
- The time unit of the flush intervalboolean isEnabled()
Table.TableStatus getTableStatus()
TableAdminManager
this tells you where it is in the loading process.java.util.Collection<java.lang.String> getUnmetClientCapabilities()
java.util.List<java.util.List<java.lang.String>> getIndices()
java.lang.String getTableSpaceRef()
java.lang.String getKeyFieldsCsv()
java.lang.String getTableStatusMessage()
boolean isSystemTable()
Timestamp getCreateTime()
java.lang.String getFilter()