Documentation

Getting Started Guide - This document describes how to get up and running with Hypertable in five minutes.

HQL Statement Syntax - This document describes the Hypertable Query Language (HQL). For each command it provides the BNF, describes how it is used, and gives working examples.

Thrift client API reference - Generated documentation from Thrift IDLs for Hypertable client services

Architectural Overview - This document provides an architectural overview of Hypertable and includes references to the source code

How to Build - This document describes how to install the required dependencies and build Hypertable on various platforms

HyperRecord - This document describes the integration of Hypertable with ActiveRecord, the Ruby on Rails ORM.

Thrift Client for Ruby - This document describes how to use the Thrift client to access Hypertable from Ruby

Config Property Reference - This document describes all of the available config file properties.

Source Documentation - Doxygen documentation for the source code. Includes class references, class relationship diagrams, and annotated source files.

Known Deficiencies - This document lists the deficiencies known to exist in the current release and all previous releases.