Client interface library. More...

Collaboration diagram for Lib:

Modules
	Master
	Master client library.

	RangeServer
	RangeServer client library.

	RangeServerRecovery
	RangeServer recovery data structures.

Namespaces
	Hypertable::MetaLog
	MetaLog framework.

	Hypertable::MetaLog::EntityType
	MetaLog entity type constants

	Hypertable::SystemVariable

Classes
class	Hypertable::AccessGroupOptions
	Specification for access group options. More...

class	Hypertable::AccessGroupSpec
	Access group specification. More...

class	Hypertable::BalancePlan
	Balance plan. More...

class	Hypertable::BlockCompressionCodec
	Abstract base class for block compression codecs. More...

class	Hypertable::BlockCompressionCodecBmz
	Block compressor that uses the BMZ algorithm. More...

class	Hypertable::BlockCompressionCodecLzo
	Block compressor that uses the LZO algorithm. More...

class	Hypertable::BlockCompressionCodecNone
	Block compressor that performs no compression. More...

class	Hypertable::BlockCompressionCodecQuicklz
	Block compressor that uses the QUICKLZ algorithm. More...

class	Hypertable::BlockCompressionCodecSnappy
	Block compressor that uses the SNAPPY algorithm. More...

class	Hypertable::BlockCompressionCodecZlib
	Block compressor that uses the ZLIB algorithm. More...

class	Hypertable::BlockHeader
	Base class for block headers. More...

class	Hypertable::BlockHeaderCellStore
	cell store block header. More...

class	Hypertable::BlockHeaderCommitLog
	Commit log block header. More...

class	Hypertable::Canonicalize
	Static class with methods for canonicalizing table and namespace names. More...

class	Hypertable::Client

class	Hypertable::ClientObject
	Base class for Hypertable client objects. More...

class	Hypertable::ClusterId
	Provides access to the cluster ID. More...

class	Hypertable::ColumnFamilyOptions
	Specification for column family options. More...

class	Hypertable::ColumnFamilySpec
	Column family specification. More...

class	Hypertable::Lib::ColumnPredicate
	Represents a column predicate (e.g. More...

class	Hypertable::CommitLog
	Commit log for persisting range updates. More...

struct	Hypertable::CommitLog::CumulativeFragmentData

struct	Hypertable::CommitLogBlockInfo
	Holds information about an individual block. More...

class	Hypertable::CommitLogBlockStream
	Abstraction for reading a stream of blocks from a commit log file. More...

class	Hypertable::CommitLogReader
	Provides sequential access to blocks in a commit log. More...

class	Hypertable::HqlCommandInterpreter
	HQL command interpreter. More...

class	Hypertable::HqlHelpText
	Holds and provides access to help text. More...

class	Hypertable::MetaLog::Header
	Metalog file header. More...

class	Hypertable::MetaLog::Definition
	Defines the set of valid MetaLog entities for a server. More...

class	Hypertable::MetaLog::Entity
	Base class for MetaLog entities. More...

class	Hypertable::MetaLog::EntityRecover
	Recover entity used for sanity checking. More...

class	Hypertable::MetaLog::EntityHeader
	Entity header. More...

class	Hypertable::MetaLog::Reader
	Reads a MetaLog. More...

class	Hypertable::MetaLog::Writer
	Writes a MetaLog. More...

class	Hypertable::MetaLog::Writer::WriteScheduler
	Periodically flushes deferred writes to disk. More...

class	Hypertable::Namespace

class	Hypertable::ProfileDataScanner
	Scanner profile data. More...

class	Hypertable::PseudoTables
	Singleton class holding Schema objects for pseudo tables. More...

class	Hypertable::QualifiedRangeSpec
	Qualified (with table identifier) range specification. More...

class	Hypertable::QualifiedRangeSpecManaged
	Qualified (with table identifier) range specification, with storage. More...

struct	Hypertable::LtQualifiedRangeSpecManaged

class	Hypertable::QualifiedRangeHash

struct	Hypertable::QualifiedRangeEqual

class	Hypertable::RangeAddrInfo
	Holds range location. More...

class	Hypertable::RangeLocationInfo
	Holds range start and end row plus location. More...

class	Hypertable::RangeMoveSpec
	Range move specification. More...

class	Hypertable::Lib::RangeServer::Protocol
	Master client protocol information. More...

class	Hypertable::RangeSpec
	Range specification. More...

class	Hypertable::RangeSpecManaged
	Wrapper for RangeSpec providing member storage. More...

class	Hypertable::RangeState
	Range state. More...

class	Hypertable::RangeStateManaged
	Range state with memory management. More...

class	Hypertable::Lib::RS_METRICS::RangeMeasurement
	Single range metrics measurement. More...

class	Hypertable::Lib::RS_METRICS::RangeMetrics
	Aggregates metrics for an individual range. More...

class	Hypertable::Lib::RS_METRICS::ReaderTable
	Reads metrics from the `sys/RS_METRICS` table. More...

class	Hypertable::Lib::RS_METRICS::ServerMeasurement
	Single server metrics measurement. More...

class	Hypertable::Lib::RS_METRICS::ServerMetrics
	Aggregates metrics for an individual RangeServer. More...

class	Hypertable::ScanBlock
	Encapsulates a block of scan results. More...

class	Hypertable::Schema
	Schema specification. More...

struct	Hypertable::SystemVariable::Spec
	Holds a variable code and boolean value. More...

class	Hypertable::TableIdentifier
	Table identifier. More...

class	Hypertable::TableIdentifierManaged
	Wrapper for TableIdentifier providing member storage. More...

class	Hypertable::TableMutatorIntervalHandler
	Timer handler for periodically flushing a shared mutator. More...

class	Hypertable::TableParts
	Represents a set of table parts (sub-tables). More...

class	Hypertable::TableScanner
	Synchronous table scanner. More...

class	Hypertable::TableScannerAsync
	Asynchronous table scanner. More...

Typedefs
typedef std::vector < AccessGroupSpec * >	Hypertable::AccessGroupSpecs
	Vector of AccessGroupSpec pointers. More...

typedef std::shared_ptr < BalancePlan >	Hypertable::BalancePlanPtr

typedef std::shared_ptr < BlockCompressionCodec >	Hypertable::BlockCompressionCodecPtr
	Smart pointer to BlockCompressionCodec. More...

typedef std::shared_ptr< Client >	Hypertable::ClientPtr

typedef std::shared_ptr < ClientObject >	Hypertable::ClientObjectPtr
	Smart pointer to ClientObject. More...

typedef std::vector < ColumnFamilySpec * >	Hypertable::ColumnFamilySpecs
	Vector of ColumnFamilySpec pointers. More...

typedef std::shared_ptr < CommitLog >	Hypertable::CommitLogPtr
	Smart pointer to CommitLog. More...

typedef std::shared_ptr < CommitLogReader >	Hypertable::CommitLogReaderPtr
	Smart pointer to CommitLogReader. More...

typedef std::shared_ptr < Definition >	Hypertable::MetaLog::DefinitionPtr
	Smart pointer to Definition. More...

typedef std::shared_ptr< Entity >	Hypertable::MetaLog::EntityPtr
	Smart pointer to Entity. More...

typedef std::shared_ptr< Reader >	Hypertable::MetaLog::ReaderPtr
	Smart pointer to Reader. More...

typedef std::shared_ptr< Writer >	Hypertable::MetaLog::WriterPtr
	Smart pointer to Writer. More...

typedef std::shared_ptr < Namespace >	Hypertable::NamespacePtr
	Shared smart pointer to Namespace. More...

typedef std::shared_ptr < RangeMoveSpec >	Hypertable::RangeMoveSpecPtr

typedef std::map< String, RangeMetrics >	Hypertable::Lib::RS_METRICS::RangeMetricsMap

typedef std::shared_ptr < ScanBlock >	Hypertable::ScanBlockPtr
	Smart pointer to ScanBlock. More...

typedef std::shared_ptr< Schema >	Hypertable::SchemaPtr
	Smart pointer to Schema. More...

typedef std::shared_ptr < TableMutatorIntervalHandler >	Hypertable::TableMutatorIntervalHandlerPtr
	Smart pointer to TableMutatorIntervalHandler. More...

typedef std::shared_ptr < TableScanner >	Hypertable::TableScannerPtr
	Smart pointer to TableScanner. More...

typedef std::shared_ptr < TableScannerAsync >	Hypertable::TableScannerAsyncPtr
	Smart pointer to TableScannerAsync. More...

Enumerations
enum	Hypertable::BloomFilterMode { Hypertable::BLOOM_FILTER_DISABLED, Hypertable::BLOOM_FILTER_ROWS, Hypertable::BLOOM_FILTER_ROWS_COLS }
	Enumeration for bloom filter modes. More...

enum	{ Hypertable::AccessGroupOptions::REPLICATION, Hypertable::AccessGroupOptions::BLOCKSIZE, Hypertable::AccessGroupOptions::COMPRESSOR, Hypertable::AccessGroupOptions::BLOOMFILTER, Hypertable::AccessGroupOptions::IN_MEMORY, Hypertable::AccessGroupOptions::MAX }
	Enumeration for isset bits. More...

enum	Hypertable::BlockCompressionCodec::Type { Hypertable::BlockCompressionCodec::UNKNOWN =-1, Hypertable::BlockCompressionCodec::NONE =0, Hypertable::BlockCompressionCodec::BMZ =1, Hypertable::BlockCompressionCodec::ZLIB =2, Hypertable::BlockCompressionCodec::LZO =3, Hypertable::BlockCompressionCodec::QUICKLZ =4, Hypertable::BlockCompressionCodec::SNAPPY =5, Hypertable::BlockCompressionCodec::COMPRESSION_TYPE_LIMIT =6 }
	Enumeration for compression type. More...

enum	{ Hypertable::ClusterId::GENERATE_IF_NOT_FOUND =1 }
	Flag to signal constructor to generate cluster ID if not found. More...

enum	{ Hypertable::ColumnFamilyOptions::MAX_VERSIONS, Hypertable::ColumnFamilyOptions::TTL, Hypertable::ColumnFamilyOptions::TIME_ORDER_DESC, Hypertable::ColumnFamilyOptions::COUNTER, Hypertable::ColumnFamilyOptions::MAX }
	Enumeration for isset bits. More...

enum	{ Hypertable::Lib::ColumnPredicate::NO_OPERATION = 0, Hypertable::Lib::ColumnPredicate::EXACT_MATCH = 0x0001, Hypertable::Lib::ColumnPredicate::PREFIX_MATCH = 0x0002, Hypertable::Lib::ColumnPredicate::REGEX_MATCH = 0x0004, Hypertable::Lib::ColumnPredicate::VALUE_MATCH = 0x0007, Hypertable::Lib::ColumnPredicate::QUALIFIER_EXACT_MATCH = 0x0100, Hypertable::Lib::ColumnPredicate::QUALIFIER_PREFIX_MATCH = 0x0200, Hypertable::Lib::ColumnPredicate::QUALIFIER_REGEX_MATCH = 0x0400, Hypertable::Lib::ColumnPredicate::QUALIFIER_MATCH = 0x0700 }

enum	{ Hypertable::MetaLog::Header::LENGTH = 16 }
	Enumeration containing static header length. More...

enum	{ Hypertable::MetaLog::EntityType::RECOVER = 0x00000001 }

enum	{ Hypertable::MetaLog::EntityHeader::FLAG_REMOVE = 0x00000001, Hypertable::MetaLog::EntityHeader::LENGTH = 32 }
	Enumeration for entity header constants. More...

enum	Hypertable::MetaLog::Reader::Flags { Hypertable::MetaLog::Reader::LOAD_ALL_ENTITIES =1 }

enum	Hypertable::PseudoTables::ColumnFamilyCode { Hypertable::PseudoTables::CELLSTORE_INDEX_SIZE = 1, Hypertable::PseudoTables::CELLSTORE_INDEX_COMPRESSED_SIZE = 2, Hypertable::PseudoTables::CELLSTORE_INDEX_KEY_COUNT = 3 }
	Enumeration for pseudo table column family codes. More...

enum	{ Hypertable::Lib::RangeServer::Protocol::COMMAND_LOAD_RANGE = 0, Hypertable::Lib::RangeServer::Protocol::COMMAND_UPDATE, Hypertable::Lib::RangeServer::Protocol::COMMAND_CREATE_SCANNER, Hypertable::Lib::RangeServer::Protocol::COMMAND_FETCH_SCANBLOCK, Hypertable::Lib::RangeServer::Protocol::COMMAND_COMPACT, Hypertable::Lib::RangeServer::Protocol::COMMAND_STATUS, Hypertable::Lib::RangeServer::Protocol::COMMAND_SHUTDOWN, Hypertable::Lib::RangeServer::Protocol::COMMAND_DUMP, Hypertable::Lib::RangeServer::Protocol::COMMAND_DESTROY_SCANNER, Hypertable::Lib::RangeServer::Protocol::COMMAND_DROP_TABLE, Hypertable::Lib::RangeServer::Protocol::COMMAND_DROP_RANGE, Hypertable::Lib::RangeServer::Protocol::COMMAND_REPLAY_BEGIN, Hypertable::Lib::RangeServer::Protocol::COMMAND_REPLAY_LOAD_RANGE, Hypertable::Lib::RangeServer::Protocol::COMMAND_REPLAY_UPDATE, Hypertable::Lib::RangeServer::Protocol::COMMAND_REPLAY_COMMIT, Hypertable::Lib::RangeServer::Protocol::COMMAND_GET_STATISTICS, Hypertable::Lib::RangeServer::Protocol::COMMAND_UPDATE_SCHEMA, Hypertable::Lib::RangeServer::Protocol::COMMAND_COMMIT_LOG_SYNC, Hypertable::Lib::RangeServer::Protocol::COMMAND_CLOSE, Hypertable::Lib::RangeServer::Protocol::COMMAND_WAIT_FOR_MAINTENANCE, Hypertable::Lib::RangeServer::Protocol::COMMAND_ACKNOWLEDGE_LOAD, Hypertable::Lib::RangeServer::Protocol::COMMAND_RELINQUISH_RANGE, Hypertable::Lib::RangeServer::Protocol::COMMAND_HEAPCHECK, Hypertable::Lib::RangeServer::Protocol::COMMAND_METADATA_SYNC, Hypertable::Lib::RangeServer::Protocol::COMMAND_INITIALIZE, Hypertable::Lib::RangeServer::Protocol::COMMAND_REPLAY_FRAGMENTS, Hypertable::Lib::RangeServer::Protocol::COMMAND_PHANTOM_LOAD, Hypertable::Lib::RangeServer::Protocol::COMMAND_PHANTOM_UPDATE, Hypertable::Lib::RangeServer::Protocol::COMMAND_PHANTOM_PREPARE_RANGES, Hypertable::Lib::RangeServer::Protocol::COMMAND_PHANTOM_COMMIT_RANGES, Hypertable::Lib::RangeServer::Protocol::COMMAND_DUMP_PSEUDO_TABLE, Hypertable::Lib::RangeServer::Protocol::COMMAND_SET_STATE, Hypertable::Lib::RangeServer::Protocol::COMMAND_TABLE_MAINTENANCE_ENABLE, Hypertable::Lib::RangeServer::Protocol::COMMAND_TABLE_MAINTENANCE_DISABLE, Hypertable::Lib::RangeServer::Protocol::COMMAND_MAX }

enum	Hypertable::Lib::RangeServer::Protocol::RangeGroup { Hypertable::Lib::RangeServer::Protocol::GROUP_METADATA_ROOT, Hypertable::Lib::RangeServer::Protocol::GROUP_METADATA, Hypertable::Lib::RangeServer::Protocol::GROUP_SYSTEM, Hypertable::Lib::RangeServer::Protocol::GROUP_USER }

enum	{ Hypertable::Lib::RangeServer::Protocol::UPDATE_FLAG_NO_LOG_SYNC = 0x0001, Hypertable::Lib::RangeServer::Protocol::UPDATE_FLAG_NO_LOG = 0x0004 }

enum	Hypertable::Lib::RangeServer::Protocol::CompactionFlags { Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_ROOT = 0x0001, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_METADATA = 0x0002, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_SYSTEM = 0x0004, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_USER = 0x0008, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_ALL = 0x000F, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_MINOR = 0x0010, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_MAJOR = 0x0020, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_MERGING = 0x0040, Hypertable::Lib::RangeServer::Protocol::COMPACT_FLAG_GC = 0x0080 }

enum	Hypertable::RangeSpec::Type { Hypertable::RangeSpec::ROOT =0, Hypertable::RangeSpec::METADATA =1, Hypertable::RangeSpec::SYSTEM =2, Hypertable::RangeSpec::USER =3, Hypertable::RangeSpec::UNKNOWN =4 }

enum	Hypertable::RangeState::StateType { Hypertable::RangeState::STEADY, Hypertable::RangeState::SPLIT_LOG_INSTALLED, Hypertable::RangeState::SPLIT_SHRUNK, Hypertable::RangeState::RELINQUISH_LOG_INSTALLED, Hypertable::RangeState::RELINQUISH_COMPACTED, Hypertable::RangeState::PHANTOM = 0x80 }
	Mixed enumeration for range state values and PHANTOM bit mask. More...

enum	Hypertable::SystemVariable::Code { Hypertable::SystemVariable::READONLY = 0, Hypertable::SystemVariable::COUNT = 1 }
	Enumeration for variable codes. More...

enum	{ Hypertable::TableParts::PRIMARY = 0x01, Hypertable::TableParts::VALUE_INDEX = 0x02, Hypertable::TableParts::QUALIFIER_INDEX = 0x04, Hypertable::TableParts::ALL = 0x07 }
	Enumeration for describing parts of a table. More...

enum	Hypertable::MetaLog::EntityType::MasterTypes { Hypertable::MetaLog::EntityType::RANGE_SERVER_CONNECTION = 0x00020000, Hypertable::MetaLog::EntityType::OLD_OPERATION_TEST = 0x00020001, Hypertable::MetaLog::EntityType::OLD_OPERATION_STATUS = 0x00020002, Hypertable::MetaLog::EntityType::OLD_OPERATION_SYSTEM_UPGRADE = 0x00020003, Hypertable::MetaLog::EntityType::OLD_OPERATION_INITIALIZE = 0x00020004, Hypertable::MetaLog::EntityType::OLD_OPERATION_COLLECT_GARBAGE = 0x00020005, Hypertable::MetaLog::EntityType::OLD_OPERATION_GATHER_STATISTICS = 0x00020006, Hypertable::MetaLog::EntityType::OLD_OPERATION_WAIT_FOR_SERVERS = 0x00020007, Hypertable::MetaLog::EntityType::OLD_OPERATION_REGISTER_SERVER = 0x00020008, Hypertable::MetaLog::EntityType::OLD_OPERATION_RECOVER_SERVER = 0x00020009, Hypertable::MetaLog::EntityType::OLD_OPERATION_CREATE_NAMESPACE = 0x0002000A, Hypertable::MetaLog::EntityType::OLD_OPERATION_DROP_NAMESPACE = 0x0002000B, Hypertable::MetaLog::EntityType::OLD_OPERATION_CREATE_TABLE = 0x0002000C, Hypertable::MetaLog::EntityType::OLD_OPERATION_DROP_TABLE = 0x0002000D, Hypertable::MetaLog::EntityType::OLD_OPERATION_ALTER_TABLE = 0x0002000E, Hypertable::MetaLog::EntityType::OLD_OPERATION_RENAME_TABLE = 0x0002000F, Hypertable::MetaLog::EntityType::OLD_OPERATION_GET_SCHEMA = 0x00020010, Hypertable::MetaLog::EntityType::OLD_OPERATION_MOVE_RANGE = 0x00020011, Hypertable::MetaLog::EntityType::OLD_OPERATION_RELINQUISH_ACKNOWLEDGE = 0x00020012, Hypertable::MetaLog::EntityType::OLD_OPERATION_BALANCE = 0x00020013, Hypertable::MetaLog::EntityType::OLD_OPERATION_LOAD_BALANCER = 0x00020014, Hypertable::MetaLog::EntityType::BALANCE_PLAN_AUTHORITY = 0x00030000, Hypertable::MetaLog::EntityType::OPERATION_TEST = 0x00030001, Hypertable::MetaLog::EntityType::OPERATION_STATUS = 0x00030002, Hypertable::MetaLog::EntityType::OPERATION_SYSTEM_UPGRADE = 0x00030003, Hypertable::MetaLog::EntityType::OPERATION_INITIALIZE = 0x00030004, Hypertable::MetaLog::EntityType::OPERATION_COLLECT_GARBAGE = 0x00030005, Hypertable::MetaLog::EntityType::OPERATION_GATHER_STATISTICS = 0x00030006, Hypertable::MetaLog::EntityType::OPERATION_WAIT_FOR_SERVERS = 0x00030007, Hypertable::MetaLog::EntityType::OPERATION_REGISTER_SERVER = 0x00030008, Hypertable::MetaLog::EntityType::OPERATION_RECOVER_SERVER = 0x00030009, Hypertable::MetaLog::EntityType::OPERATION_CREATE_NAMESPACE = 0x0003000A, Hypertable::MetaLog::EntityType::OPERATION_DROP_NAMESPACE = 0x0003000B, Hypertable::MetaLog::EntityType::OPERATION_CREATE_TABLE = 0x0003000C, Hypertable::MetaLog::EntityType::OPERATION_DROP_TABLE = 0x0003000D, Hypertable::MetaLog::EntityType::OPERATION_ALTER_TABLE = 0x0003000E, Hypertable::MetaLog::EntityType::OPERATION_RENAME_TABLE = 0x0003000F, Hypertable::MetaLog::EntityType::OPERATION_GET_SCHEMA = 0x00030010, Hypertable::MetaLog::EntityType::OPERATION_MOVE_RANGE = 0x00030011, Hypertable::MetaLog::EntityType::OPERATION_RELINQUISH_ACKNOWLEDGE = 0x00030012, Hypertable::MetaLog::EntityType::OPERATION_BALANCE_RETIRED = 0x00030013, Hypertable::MetaLog::EntityType::OPERATION_LOAD_BALANCER_RETIRED = 0x00030014, Hypertable::MetaLog::EntityType::OPERATION_RECOVER_SERVER_RANGES = 0x00030015, Hypertable::MetaLog::EntityType::OPERATION_RECOVERY_BLOCKER = 0x00030016, Hypertable::MetaLog::EntityType::OPERATION_STOP = 0x00030017, Hypertable::MetaLog::EntityType::OPERATION_BALANCE = 0x00030018, Hypertable::MetaLog::EntityType::OPERATION_TIMED_BARRIER = 0x00030019, Hypertable::MetaLog::EntityType::OPERATION_COMPACT = 0x0003001A, Hypertable::MetaLog::EntityType::OPERATION_SET = 0x0003001B, Hypertable::MetaLog::EntityType::SYSTEM_STATE = 0x0003001C, Hypertable::MetaLog::EntityType::OPERATION_REGISTER_SERVER_BLOCKER = 0x0003001D, Hypertable::MetaLog::EntityType::OPERATION_TOGGLE_TABLE_MAINTENANCE = 0x0003001E, Hypertable::MetaLog::EntityType::OPERATION_RECREATE_INDEX_TABLES = 0x0003001F, Hypertable::MetaLog::EntityType::RECOVERED_SERVERS = 0x00030020 }
	Master MetaLog entity type constants More...

enum	Hypertable::MetaLog::EntityType::RangeServerTypes { Hypertable::MetaLog::EntityType::RANGE = 0x00010001, Hypertable::MetaLog::EntityType::RANGE2 = 0x00010002, Hypertable::MetaLog::EntityType::TASK_REMOVE_TRANSFER_LOG = 0x00010003, Hypertable::MetaLog::EntityType::TASK_ACKNOWLEDGE_RELINQUISH = 0x00010004, Hypertable::MetaLog::EntityType::REMOVE_OK_LOGS = 0x00010005 }
	RangeServer MetaLog entity type constants More...

Functions
std::ostream &	Hypertable::operator<< (std::ostream &os, const BalancePlan &plan)

bool	Hypertable::operator== (const BlockHeader &lhs, const BlockHeader &rhs)
	Equality operator for BlockHeader type. More...

bool	Hypertable::operator== (const BlockHeaderCellStore &lhs, const BlockHeaderCellStore &rhs)
	Equality operator for BlockHeaderCellStore type. More...

bool	Hypertable::operator== (const BlockHeaderCommitLog &lhs, const BlockHeaderCommitLog &rhs)
	Equality operator for BlockHeaderCommitLog type. More...

	Hypertable::Client::Client (const std::string &install_dir, const std::string &config_file, uint32_t default_timeout_ms=0)
	Constructs the object using the specified config file. More...

	Hypertable::Client::Client (const std::string &install_dir=String(), uint32_t default_timeout_ms=0)
	Constructs the object using the default config file. More...

	Hypertable::Client::~Client ()

void	Hypertable::Client::create_namespace (const std::string &name, Namespace *base=NULL, bool create_intermediate=false, bool if_not_exists=false)
	Creates a namespace. More...

NamespacePtr	Hypertable::Client::open_namespace (const std::string &name, Namespace *base=NULL)
	Opens a Namespace. More...

bool	Hypertable::Client::exists_namespace (const std::string &name, Namespace *base=NULL)
	Checks if the namespace exists. More...

void	Hypertable::Client::drop_namespace (const std::string &name, Namespace *base=NULL, bool if_exists=false)
	Removes a namespace. More...

Hyperspace::SessionPtr &	Hypertable::Client::get_hyperspace_session ()

Lib::Master::ClientPtr	Hypertable::Client::get_master_client ()

NameIdMapperPtr	Hypertable::Client::get_nameid_mapper ()

void	Hypertable::Client::close ()

void	Hypertable::Client::shutdown ()

HqlInterpreter *	Hypertable::Client::create_hql_interpreter (bool immutable_namespace=true)

void	Hypertable::Client::initialize ()

std::ostream &	Hypertable::Lib::operator<< (std::ostream &os, const ColumnPredicate &cp)

std::ostream &	Hypertable::MetaLog::operator<< (std::ostream &os, Entity &entity)
	ostream shift function for Entity objects. More...

std::ostream &	Hypertable::operator<< (std::ostream &os, const QualifiedRangeSpec &qualified_range)

std::ostream &	Hypertable::operator<< (std::ostream &os, const QualifiedRangeSpecManaged &qualified_range)

std::ostream &	Hypertable::operator<< (std::ostream &os, const RangeMoveSpec &move_spec)

std::ostream &	Hypertable::operator<< (std::ostream &os, const RangeSpec &range)

std::ostream &	Hypertable::operator<< (std::ostream &out, const RangeState &st)
	ostream shift function for RangeState objects. More...

std::ostream &	Hypertable::operator<< (std::ostream &os, const TableIdentifier &tid)

void	Hypertable::copy (TableScanner &scanner, CellsBuilder &b)

void	Hypertable::copy (TableScannerPtr &p, CellsBuilder &v)

Detailed Description

Client interface library.

The Lib module contains the Hypertable client library which contains Hypertable specific code that is shared by clients, the RangeServer and the Master.

Typedef Documentation

typedef std::vector<AccessGroupSpec *> Hypertable::AccessGroupSpecs

Vector of AccessGroupSpec pointers.

Definition at line 636 of file AccessGroupSpec.h.

typedef std::shared_ptr<BalancePlan> Hypertable::BalancePlanPtr

Definition at line 81 of file BalancePlan.h.

typedef std::shared_ptr<BlockCompressionCodec> Hypertable::BlockCompressionCodecPtr

Smart pointer to BlockCompressionCodec.

Definition at line 109 of file BlockCompressionCodec.h.

typedef std::shared_ptr<ClientObject> Hypertable::ClientObjectPtr

Smart pointer to ClientObject.

Definition at line 51 of file ClientObject.h.

typedef std::shared_ptr<Client> Hypertable::ClientPtr

Definition at line 156 of file Client.h.

typedef std::vector<ColumnFamilySpec *> Hypertable::ColumnFamilySpecs

Vector of ColumnFamilySpec pointers.

Definition at line 442 of file ColumnFamilySpec.h.

typedef std::shared_ptr<CommitLog> Hypertable::CommitLogPtr

Smart pointer to CommitLog.

Definition at line 223 of file CommitLog.h.

typedef std::shared_ptr<CommitLogReader> Hypertable::CommitLogReaderPtr

Smart pointer to CommitLogReader.

Definition at line 112 of file CommitLogReader.h.

typedef std::shared_ptr<Definition> Hypertable::MetaLog::DefinitionPtr

Smart pointer to Definition.

Definition at line 114 of file MetaLogDefinition.h.

typedef std::shared_ptr<Entity> Hypertable::MetaLog::EntityPtr

Smart pointer to Entity.

Definition at line 169 of file MetaLogEntity.h.

typedef std::shared_ptr<Namespace> Hypertable::NamespacePtr

Shared smart pointer to Namespace.

Definition at line 333 of file Namespace.h.

typedef std::map<String, RangeMetrics> Hypertable::Lib::RS_METRICS::RangeMetricsMap

Definition at line 104 of file RangeMetrics.h.

typedef std::shared_ptr<RangeMoveSpec> Hypertable::RangeMoveSpecPtr

Definition at line 101 of file RangeMoveSpec.h.

typedef std::shared_ptr<Reader> Hypertable::MetaLog::ReaderPtr

Smart pointer to Reader.

Definition at line 213 of file MetaLogReader.h.

typedef std::shared_ptr<ScanBlock> Hypertable::ScanBlockPtr

Smart pointer to ScanBlock.

Definition at line 130 of file ScanBlock.h.

typedef std::shared_ptr<Schema> Hypertable::SchemaPtr

Smart pointer to Schema.

Definition at line 465 of file Schema.h.

typedef std::shared_ptr<TableMutatorIntervalHandler> Hypertable::TableMutatorIntervalHandlerPtr

Smart pointer to TableMutatorIntervalHandler.

Definition at line 127 of file TableMutatorIntervalHandler.h.

typedef std::shared_ptr<TableScannerAsync> Hypertable::TableScannerAsyncPtr

Smart pointer to TableScannerAsync.

Definition at line 178 of file TableScannerAsync.h.

typedef std::shared_ptr<TableScanner> Hypertable::TableScannerPtr

Smart pointer to TableScanner.

Definition at line 124 of file TableScanner.h.

typedef std::shared_ptr<Writer> Hypertable::MetaLog::WriterPtr

Smart pointer to Writer.

Definition at line 280 of file MetaLogWriter.h.

Enumeration Type Documentation

anonymous enum

Enumeration for isset bits.

Enumerator
REPLICATION	replication bit
BLOCKSIZE	blocksize bit
COMPRESSOR	compressor bit
BLOOMFILTER	bloom filter bit
IN_MEMORY	in memory bit
MAX	Total bit count.

Definition at line 58 of file AccessGroupSpec.h.

anonymous enum

Flag to signal constructor to generate cluster ID if not found.

Enumerator
GENERATE_IF_NOT_FOUND	Passed to constructor to tell it to generate cluster ID if not found.

Definition at line 50 of file ClusterId.h.

anonymous enum

Enumeration for isset bits.

Enumerator
MAX_VERSIONS	max versions bit
TTL	ttl bit
TIME_ORDER_DESC	time order desc bit
COUNTER	counter bit
MAX	Total bit count.

Definition at line 44 of file ColumnFamilySpec.h.

anonymous enum

Enumerator
NO_OPERATION
EXACT_MATCH
PREFIX_MATCH
REGEX_MATCH
VALUE_MATCH
QUALIFIER_EXACT_MATCH
QUALIFIER_PREFIX_MATCH
QUALIFIER_REGEX_MATCH
QUALIFIER_MATCH

Definition at line 42 of file ColumnPredicate.h.

anonymous enum

Enumeration containing static header length.

Enumerator
LENGTH	Static header length.

Definition at line 80 of file MetaLog.h.

anonymous enum

Enumerator
RECOVER	Recover entity.

Definition at line 189 of file MetaLogEntity.h.

anonymous enum

Enumeration for entity header constants.

Enumerator
FLAG_REMOVE	Entity removal flag
LENGTH	Static length of entity header.

Definition at line 59 of file MetaLogEntityHeader.h.

anonymous enum

Enumerator
COMMAND_LOAD_RANGE
COMMAND_UPDATE
COMMAND_CREATE_SCANNER
COMMAND_FETCH_SCANBLOCK
COMMAND_COMPACT
COMMAND_STATUS
COMMAND_SHUTDOWN
COMMAND_DUMP
COMMAND_DESTROY_SCANNER
COMMAND_DROP_TABLE
COMMAND_DROP_RANGE
COMMAND_REPLAY_BEGIN
COMMAND_REPLAY_LOAD_RANGE
COMMAND_REPLAY_UPDATE
COMMAND_REPLAY_COMMIT
COMMAND_GET_STATISTICS
COMMAND_UPDATE_SCHEMA
COMMAND_COMMIT_LOG_SYNC
COMMAND_CLOSE
COMMAND_WAIT_FOR_MAINTENANCE
COMMAND_ACKNOWLEDGE_LOAD
COMMAND_RELINQUISH_RANGE
COMMAND_HEAPCHECK
COMMAND_METADATA_SYNC
COMMAND_INITIALIZE
COMMAND_REPLAY_FRAGMENTS
COMMAND_PHANTOM_LOAD
COMMAND_PHANTOM_UPDATE
COMMAND_PHANTOM_PREPARE_RANGES
COMMAND_PHANTOM_COMMIT_RANGES
COMMAND_DUMP_PSEUDO_TABLE
COMMAND_SET_STATE
COMMAND_TABLE_MAINTENANCE_ENABLE
COMMAND_TABLE_MAINTENANCE_DISABLE
COMMAND_MAX

Definition at line 53 of file Protocol.h.

anonymous enum

Enumerator
UPDATE_FLAG_NO_LOG_SYNC
UPDATE_FLAG_NO_LOG

Definition at line 99 of file Protocol.h.

anonymous enum

Enumeration for describing parts of a table.

Enumerator
PRIMARY	Primary table.
VALUE_INDEX	Value index.
QUALIFIER_INDEX	Qualifier index
ALL	All parts.

Definition at line 52 of file TableParts.h.

enum Hypertable::BloomFilterMode

Enumeration for bloom filter modes.

Enumerator
BLOOM_FILTER_DISABLED	Disable.
BLOOM_FILTER_ROWS	Rows only.
BLOOM_FILTER_ROWS_COLS	Rows plus columns.

Definition at line 44 of file AccessGroupSpec.h.

enum Hypertable::SystemVariable::Code

Enumeration for variable codes.

Enumerator
READONLY	Read-only.
COUNT	Valid code count.

Definition at line 45 of file SystemVariable.h.

enum Hypertable::PseudoTables::ColumnFamilyCode

Enumeration for pseudo table column family codes.

Enumerator
CELLSTORE_INDEX_SIZE	.cellstore.index `Size` column family
CELLSTORE_INDEX_COMPRESSED_SIZE	.cellstore.index `CompressedSize` column family
CELLSTORE_INDEX_KEY_COUNT	.cellstore.index `KeyCount` column family

Definition at line 49 of file PseudoTables.h.

enum Hypertable::Lib::RangeServer::Protocol::CompactionFlags

Enumerator
COMPACT_FLAG_ROOT
COMPACT_FLAG_METADATA
COMPACT_FLAG_SYSTEM
COMPACT_FLAG_USER
COMPACT_FLAG_ALL
COMPACT_FLAG_MINOR
COMPACT_FLAG_MAJOR
COMPACT_FLAG_MERGING
COMPACT_FLAG_GC

Definition at line 106 of file Protocol.h.

enum Hypertable::MetaLog::Reader::Flags

Enumerator
LOAD_ALL_ENTITIES

Definition at line 60 of file MetaLogReader.h.

enum Hypertable::MetaLog::EntityType::MasterTypes

Master MetaLog entity type constants

Enumerator
RANGE_SERVER_CONNECTION
OLD_OPERATION_TEST
OLD_OPERATION_STATUS
OLD_OPERATION_SYSTEM_UPGRADE
OLD_OPERATION_INITIALIZE
OLD_OPERATION_COLLECT_GARBAGE
OLD_OPERATION_GATHER_STATISTICS
OLD_OPERATION_WAIT_FOR_SERVERS
OLD_OPERATION_REGISTER_SERVER
OLD_OPERATION_RECOVER_SERVER
OLD_OPERATION_CREATE_NAMESPACE
OLD_OPERATION_DROP_NAMESPACE
OLD_OPERATION_CREATE_TABLE
OLD_OPERATION_DROP_TABLE
OLD_OPERATION_ALTER_TABLE
OLD_OPERATION_RENAME_TABLE
OLD_OPERATION_GET_SCHEMA
OLD_OPERATION_MOVE_RANGE
OLD_OPERATION_RELINQUISH_ACKNOWLEDGE
OLD_OPERATION_BALANCE
OLD_OPERATION_LOAD_BALANCER
BALANCE_PLAN_AUTHORITY
OPERATION_TEST
OPERATION_STATUS
OPERATION_SYSTEM_UPGRADE
OPERATION_INITIALIZE
OPERATION_COLLECT_GARBAGE
OPERATION_GATHER_STATISTICS
OPERATION_WAIT_FOR_SERVERS
OPERATION_REGISTER_SERVER
OPERATION_RECOVER_SERVER
OPERATION_CREATE_NAMESPACE
OPERATION_DROP_NAMESPACE
OPERATION_CREATE_TABLE
OPERATION_DROP_TABLE
OPERATION_ALTER_TABLE
OPERATION_RENAME_TABLE
OPERATION_GET_SCHEMA
OPERATION_MOVE_RANGE
OPERATION_RELINQUISH_ACKNOWLEDGE
OPERATION_BALANCE_RETIRED
OPERATION_LOAD_BALANCER_RETIRED
OPERATION_RECOVER_SERVER_RANGES
OPERATION_RECOVERY_BLOCKER
OPERATION_STOP
OPERATION_BALANCE
OPERATION_TIMED_BARRIER
OPERATION_COMPACT
OPERATION_SET
SYSTEM_STATE
OPERATION_REGISTER_SERVER_BLOCKER
OPERATION_TOGGLE_TABLE_MAINTENANCE
OPERATION_RECREATE_INDEX_TABLES
RECOVERED_SERVERS

Definition at line 42 of file MetaLogEntityTypes.h.

enum Hypertable::Lib::RangeServer::Protocol::RangeGroup

Enumerator
GROUP_METADATA_ROOT
GROUP_METADATA
GROUP_SYSTEM
GROUP_USER

Definition at line 91 of file Protocol.h.

enum Hypertable::MetaLog::EntityType::RangeServerTypes

RangeServer MetaLog entity type constants

Enumerator
RANGE
RANGE2
TASK_REMOVE_TRANSFER_LOG
TASK_ACKNOWLEDGE_RELINQUISH
REMOVE_OK_LOGS

Definition at line 42 of file MetaLogEntityTypes.h.

enum Hypertable::RangeState::StateType

Mixed enumeration for range state values and PHANTOM bit mask.

Enumerator
STEADY	Normal (steady)
SPLIT_LOG_INSTALLED	Split - log installed.
SPLIT_SHRUNK	Split - range shrunk.
RELINQUISH_LOG_INSTALLED	Relinquish - log installed.
RELINQUISH_COMPACTED	Relinquish - range compacted.
PHANTOM	Phantom bit mask.

Definition at line 52 of file RangeState.h.

enum Hypertable::RangeSpec::Type

Enumerator
ROOT
METADATA
SYSTEM
USER
UNKNOWN

Definition at line 42 of file RangeSpec.h.

enum Hypertable::BlockCompressionCodec::Type

Enumeration for compression type.

Enumerator
UNKNOWN	Unknown compression type.
NONE	No compression.
BMZ	Bentley-McIlroy large common substring compression.
ZLIB	ZLIB compression.
LZO	LZO compression.
QUICKLZ	QuickLZ 1.5 compession.
SNAPPY	Snappy compression.
COMPRESSION_TYPE_LIMIT	Limit of compression types.

Definition at line 51 of file BlockCompressionCodec.h.

Function Documentation

Client::Client	(	const std::string &	install_dir,
		const std::string &	config_file,
		uint32_t	default_timeout_ms = `0`
	)

Constructs the object using the specified config file.

Parameters

install_dir	path to Hypertable installation directory
config_file	name of configuration file
default_timeout_ms	default method call timeout in milliseconds

Definition at line 60 of file Client.cc.

Client::Client	(	const std::string &	install_dir = `String()`,
		uint32_t	default_timeout_ms = `0`
	)

Constructs the object using the default config file.

Parameters

install_dir	path to Hypertable installation directory
default_timeout_ms	default method call timeout in milliseconds

Definition at line 72 of file Client.cc.

void Client::close ( )

Definition at line 184 of file Client.cc.

void Hypertable::copy	(	TableScanner &	scanner,
		CellsBuilder &	b
	)

Definition at line 102 of file TableScanner.cc.

void Hypertable::copy	(	TableScannerPtr &	p,
		CellsBuilder &	v
	)

inline

Definition at line 127 of file TableScanner.h.

HqlInterpreter * Client::create_hql_interpreter ( bool immutable_namespace = true )

Parameters

immutable_namespace if true then the namespace can't be modified once its set

Definition at line 193 of file Client.cc.

void Client::create_namespace	(	const std::string &	name,
		Namespace *	base = `NULL`,
		bool	create_intermediate = `false`,
		bool	if_not_exists = `false`
	)

Creates a namespace.

Parameters

name	name of the namespace to create
base	optional base Namespace (if specified the name parameter will be relative to base)
create_intermediate	if true then create all non-existent intermediate namespaces
if_not_exists	don't throw an exception if namespace does exist

Definition at line 86 of file Client.cc.

void Client::drop_namespace	(	const std::string &	name,
		Namespace *	base = `NULL`,
		bool	if_exists = `false`
	)

Removes a namespace.

This command instructs the Master to remove a namespace from the system. The namespace must be empty, ie all tables and namespaces under it must have been dropped already

Parameters

name	namespace name
base	optional base Namespace (if specified the name parameter will be relative to base)
if_exists	don't throw an exception if table does not exist

Definition at line 150 of file Client.cc.

bool Client::exists_namespace	(	const std::string &	name,
		Namespace *	base = `NULL`
	)

Checks if the namespace exists.

Parameters

name	name of namespace
base	optional base Namespace (if specified the name parameter will be relative to base)

Returns: true if namespace exists false ow

Definition at line 121 of file Client.cc.

Hyperspace::SessionPtr & Client::get_hyperspace_session ( )

Definition at line 171 of file Client.cc.

Lib::Master::ClientPtr Client::get_master_client ( )

Definition at line 176 of file Client.cc.

NameIdMapperPtr Client::get_nameid_mapper ( )

Definition at line 180 of file Client.cc.

void Client::initialize ( )

private

Definition at line 198 of file Client.cc.

NamespacePtr Client::open_namespace	(	const std::string &	name,
		Namespace *	base = `NULL`
	)

Opens a Namespace.

Parameters

name	name of the Namespace
base	optional base Namespace (if specified the name parameter will be relative to base)

Returns: pointer to the Namespace object

Definition at line 106 of file Client.cc.

std::ostream& Hypertable::operator<<	(	std::ostream &	os,
		const BalancePlan &	plan
	)

std::ostream& Hypertable::operator<<	(	std::ostream &	os,
		const RangeMoveSpec &	move_spec
	)

std::ostream& Hypertable::Lib::operator<<	(	std::ostream &	os,
		const ColumnPredicate &	cp
	)

std::ostream& Hypertable::operator<<	(	std::ostream &	os,
		const RangeSpec &	range
	)

std::ostream& Hypertable::operator<<	(	std::ostream &	os,
		const TableIdentifier &	tid
	)

std::ostream & Hypertable::operator<<	(	std::ostream &	out,
		const RangeState &	st
	)

ostream shift function for RangeState objects.

This method writes a human readable representation of a RangeState object to the given ostream as a single line, formatted as follows:

{RangeState: state=<s> timestamp=<t> ... }

Parameters

out	ostream on which to print range state
st	RangeState object to print

Returns: out

Definition at line 144 of file RangeState.cc.

std::ostream& Hypertable::MetaLog::operator<<	(	std::ostream &	os,
		Entity &	entity
	)

inline

ostream shift function for Entity objects.

This method writes a human readable representation of an Entity to a given ostream. It prints the header followed by the entity state.

Parameters

os	ostream on which to print entity
entity	Entity object to print

Returns: os

Definition at line 179 of file MetaLogEntity.h.

std::ostream& Hypertable::operator<<	(	std::ostream &	os,
		const QualifiedRangeSpec &	qualified_range
	)

std::ostream& Hypertable::operator<<	(	std::ostream &	os,
		const QualifiedRangeSpecManaged &	qualified_range
	)

bool Hypertable::operator==	(	const BlockHeaderCellStore &	lhs,
		const BlockHeaderCellStore &	rhs
	)

inline

Equality operator for BlockHeaderCellStore type.

This method performs an equality comparison of lhs and rhs.

Returns: true if lhs is logically equal to rhs, false otherwise.

Definition at line 108 of file BlockHeaderCellStore.h.

bool Hypertable::operator==	(	const BlockHeaderCommitLog &	lhs,
		const BlockHeaderCommitLog &	rhs
	)

inline

Equality operator for BlockHeaderCommitLog type.

This method performs an equality comparison of lhs and rhs.

Returns: true if lhs is logically equal to rhs, false otherwise.

Definition at line 163 of file BlockHeaderCommitLog.h.

bool Hypertable::operator==	(	const BlockHeader &	lhs,
		const BlockHeader &	rhs
	)

inline

Equality operator for BlockHeader type.

This method performs an equality comparison of lhs and rhs.

Returns: true if lhs is logically equal to rhs, false otherwise.

Definition at line 242 of file BlockHeader.h.

void Client::shutdown ( )

Definition at line 188 of file Client.cc.

Hypertable::Client::~Client ( )

inline

Definition at line 74 of file Client.h.

Variable Documentation

ApplicationQueueInterfacePtr Hypertable::Client::m_app_queue

private

Definition at line 143 of file Client.h.

Comm* Hypertable::Client::m_comm

private

Definition at line 141 of file Client.h.

ConnectionManagerPtr Hypertable::Client::m_conn_manager

private

Definition at line 142 of file Client.h.

Hyperspace::SessionPtr Hypertable::Client::m_hyperspace

private

Definition at line 144 of file Client.h.

bool Hypertable::Client::m_hyperspace_reconnect

private

Definition at line 152 of file Client.h.

std::string Hypertable::Client::m_install_dir

private

Definition at line 149 of file Client.h.

Lib::Master::ClientPtr Hypertable::Client::m_master_client

private

Definition at line 146 of file Client.h.

NameIdMapperPtr Hypertable::Client::m_namemap

private

Definition at line 145 of file Client.h.

NamespaceCachePtr Hypertable::Client::m_namespace_cache

private

Definition at line 151 of file Client.h.

PropertiesPtr Hypertable::Client::m_props

private

Definition at line 140 of file Client.h.

RangeLocatorPtr Hypertable::Client::m_range_locator

private

Definition at line 147 of file Client.h.

TableCachePtr Hypertable::Client::m_table_cache

private

Definition at line 150 of file Client.h.

uint32_t Hypertable::Client::m_timeout_ms

private

Definition at line 148 of file Client.h.

std::string Hypertable::Client::m_toplevel_dir

private

Definition at line 153 of file Client.h.

Variables
PropertiesPtr	Hypertable::Client::m_props

Comm *	Hypertable::Client::m_comm

ConnectionManagerPtr	Hypertable::Client::m_conn_manager

ApplicationQueueInterfacePtr	Hypertable::Client::m_app_queue

Hyperspace::SessionPtr	Hypertable::Client::m_hyperspace

NameIdMapperPtr	Hypertable::Client::m_namemap

Lib::Master::ClientPtr	Hypertable::Client::m_master_client

RangeLocatorPtr	Hypertable::Client::m_range_locator

uint32_t	Hypertable::Client::m_timeout_ms

std::string	Hypertable::Client::m_install_dir

TableCachePtr	Hypertable::Client::m_table_cache

NamespaceCachePtr	Hypertable::Client::m_namespace_cache

bool	Hypertable::Client::m_hyperspace_reconnect

std::string	Hypertable::Client::m_toplevel_dir

Modules

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation