Hypertable::HqlHelpText Class Reference

Holds and provides access to help text. More...

#include <HqlHelpText.h>

Static Public Member Functions
static const char **	get (const std::string &subject)
	Returns help text string for a command. More...
static void	install_range_server_client_text ()
	Installs help text for rsclient command interpreter. More...
static void	install_master_client_text ()
	Installs help text for hypertable (HQL) command interpreter. More...

Detailed Description

Holds and provides access to help text.

This class is used to hold and servce help text for either the rsclient command interpreter or the hypertable (HQL) command interpreter.

Definition at line 44 of file HqlHelpText.h.

Member Function Documentation

const char ** HqlHelpText::get ( const std::string &  subject )

static

Returns help text string for a command.

This method returns the help text for the command described in subject. For commands that consist of multiple words, subject can contain any prefix of the word set, for example, given the command LOAD DATA INFILE, subject can contain:

LOAD
LOAD DATA
LOAD DATA INFILE

Parameters

subject

Command for which to return help text

Returns

Help text associated with command in subject

Definition at line 2178 of file HqlHelpText.cc.

void HqlHelpText::install_master_client_text ( )

static

Installs help text for hypertable (HQL) command interpreter.

Definition at line 2209 of file HqlHelpText.cc.

void HqlHelpText::install_range_server_client_text ( )

static

Installs help text for rsclient command interpreter.

Definition at line 2186 of file HqlHelpText.cc.

---

The documentation for this class was generated from the following files:

• /home/doug/src/hypertable/src/cc/Hypertable/Lib/HqlHelpText.h
• /home/doug/src/hypertable/src/cc/Hypertable/Lib/HqlHelpText.cc