Package com.illumon.iris.binarystore

Interface Summary

Interface	Description
BinaryStoreBufferProcessor	Interface for BinaryStoreImportProcessor to access both V1 and V2 BinaryStores.
BinaryStoreReader	Interface for functionality common between BinaryStoreBufferProcessor and the Binary Store Readers.
BinaryStoreV2RowBufferProcessor	Interface for row buffer processors, which are usually generated code to fill and write a row batch data structure.
ChannelManager	Manage writable channels.
ChannelManagerMultiPartition	Interface derived from ChannelManager for implementations that determine channels based on supplied column partition values.
ChannelManagerStandard	Interface derived from ChannelManager for implementations that determine channels based on internal pre-determined criteria.
CloseableStringCache<STRING_LIKE_TYPE extends CharSequence>	A StringCache that is SafeCloseable.
Entry	Binary stores consist of Entries, which may be Rows or Records.
EntryHandler	Implementors of this interface provide Row and Record callbacks.
ExpirationManager<T>	Manage a value that changes after a certain period of time.
KeyedRowSetter
Record	Interface for writing out a binary store v2 record entry.
Record.RecordSetter<T extends RecordData>	Setter specialization for RecordData.
RecordData	Holds the data payload of a record entry.
Row	Interface for writing out values in a row.
RowCopier
RowGetter<T>
RowSetter<T>	Type-safe interface for setting cell values in individual columns of a row to allow a row to be written.
SkipableTableReader	A table reader that can advance to a given record, return its size, and block instead of returning an EOF.
StringCacheProvider	Provider interface for CloseableStringCaches to use in ingestion and data access.
TableReader	Row-oriented table reading interface.
TableWriter<R extends Row>	Interface for writing table data out.
WritableRowContainer<R extends Row>	A container for a Row that supports the concept of release, as well as access to the row itself.

Class Summary

Class	Description
AbstractBinaryStoreReader	This is the common class for the V1 and V2 binary store readers.
AbstractBinaryStoreReaderV1	Base for V1 binary store readers. This class implements the reader for a self-descriptive binary format table. A table is structured as following: header, formatted as follows: 4-byte signed int (numColumns) For each column: 0-terminated ascii string (column name) 0-terminated ascii string (type name) 4-byte signed int (type size - unused) 4-byte signed int (metadata size) metadata size bytes (metadata) list of rows (numColumns+7)/8 bytes (column presence bitmap) For each non-null column: Column data based on SupportedType encoding
AbstractBinaryStoreReaderV2	Base for V2 binary store readers.
AbstractBinaryStoreReaderV2.BinaryStoreRowGetter<T>
AbstractBinaryStoreWriter<R extends Row>	This class provides a common ancestor for V1 and V2 binary store writer to manage output channels.
AbstractRowGetter<T>
AbstractRowSetter<T>
BinaryRecordV2	This class implements binary record entry writing for the V2 binary log format.
BinaryRowV2	This class implements row writing for the V2 binary log format.
BinaryStoreBufferProcessorV1	V1 Binary Store.
BinaryStoreBufferProcessorV2	V2 Binary Store.
BinaryStoreReaderV1	Table reader for Version 1 of the binary store.
BinaryStoreReaderV2	Table reader for Version 2 of the binary store.
BinaryStoreSocketReaderV2	Extend AbstractBinaryStoreReaderV2 implementation to add a socket channel source.
BinaryStoreUtils	Container class for utility functions related to binary stores.
BinaryStoreV2Constants	Constant fields written to the V2 binary store.
BinaryStoreV2HeaderInfo	Information extracted from a binary store header.
BinaryStoreV2HeaderInfo.ColumnInfo	Per-column information extracted from a binary store header.
BinaryStoreV2HeaderParser	Tool for parsing V2 (and higher) of the binary store header format.
BinaryStoreV2RowBufferProcessor.Uninitialized	Row buffer processor to use when a real one has not yet been set, and hence rows are unexpected.
BinaryStoreWriterV2	This class implements the writer for a self-descriptive binary table in the V2 binary log format.
BinaryStoreWriterV2.DeferrableRowPartition	A container for binning WritableRowContainers by column partition in order to enable write batching.
CommandRecordV2	Read and write RecordData that are commands.
CommandRecordV2.CheckpointCommand
CommandRecordV2.DeletePartition2Command	This class represents a command to delete the identified partition.
CommandRecordV2.DeletePartitionCommand	This class represents a command to delete the "current" partition.
CommandRecordV2.LASCommandRecordV2	Wrap a LAS command (as defined in com.illumon.iris.db.v2.logaggregator.CommandHelper.LasInnerCommandId) in a record entry.
DelegatingBinaryStoreV2BufferProcessor	Buffer processor for version 2 of the binary store protocol which delegates row buffer consumption to a BinaryStoreV2RowBufferProcessor rather than support the legacy RowGetter approach.
DelegatingBinaryStoreV2BufferProcessor.UninitializedRecordHandler	Record handler to use when a real one has not yet been set, and hence records are unexpected.
ExpirationManager.ArbitraryExpiration	Returns a string representing the current time period.
ExpirationManager.BaseExpiration<T>
ExpirationManager.DailyExpiration	Returns the current date.
ExpirationManager.DailyHourlyExpiration	Provides DailyExpiration and adds access to the current date.
ExpirationManager.HourlyExpiration	Expires on the hour, returning a datetime format of "yyyy-MM-dd.HHmmss.SSSZ", which will round to "yyyy-MM-dd.HH0000.000-????" after rolling on the hour.
ExpirationManager.StaticExpiration<T>	Static value - does not expire.
IrisCat	Utility to print out the contents of a binary store file.
IrisTail	Utility to prints out the end of a Binary Store file, optionally following the file as it grows.
MultiPartitionFileManager	ChannelManager implementation for binary log files, using dynamic column partition selection.
RollingFileManager	This class maintains the file channels, with the appropriate roll interval for BinaryStoreWriters.
RollingFileManagerBase	Base class for rolling files on a time interval.
RollingFileManagerWithDateColumnPartition	Rolls on the hour, changes the filename base when the column partition changes.
RollingFileManagerWithSpecifiedColumnPartition	Implementation of RollingFileManagerBase which takes one unchanging value for the column partition.
RowCopierFactory
SetApplicationVersion	A common error is to update a logger/listener schema without changing the logFormat (Application Version).
StringCacheProviders	StringCacheProvider implementations to provide a framework for data ingestion.
SwitchBinaryStoreReader	Reads the magic number and selects either a V1 or V2 binary store reader as appropriate.

Enum Summary

Enum	Description
RollingFileManagerBase.ExistingFilePolicy	Allow different behaviors when an existing output file is seen.
Row.Flags	Per-row transaction flags.
SupportedType	Enumeration of supported types in Iris binary log files.

Exception Summary

Exception	Description
AbstractBinaryStoreReader.MissingGetterException
BinaryStoreBufferProcessor.ReadDataException	The BinaryStoreBufferProcessors do not actually read any data, they only consume data passed into them using the setDataBuffer method.
EofException	Marker exception when the AbstractBinaryStoreReader encounters an EOF.
TableReader.MissingPropertyGetterException