hydra/api/Doxydocs_8h_source.html

00001
00002 /*
00003  * Copyright (c) 2011 Aleksander B. Demko
00004  * This source code is distributed under the MIT license.
00005  * See the accompanying file LICENSE.MIT.txt for details.
00006  */
00007
00008 // this file is soley for doxygen
00009 // it contains no code
00010
00011 /**
00012  \mainpage Table of Contents
00013
00014  Core manuals:
00015   - \ref hydrapage
00016
00017  Other manuals may also be available. See the "Related Pages" for a full list.
00018  */
00019
00020 /**
00021   \page hydrapage Hydra Library Reference
00022
00023   This is the hydra library reference. It's still
00024   under construction.
00025
00026   \section engineoversec Engine Overview
00027
00028   The singleton \ref hydra::Engine class encapsulates
00029   the core connection to the hydra database.
00030
00031   This engine class maintains three logic key-value
00032   databases, using the \ref hydra::DB class.
00033
00034   The \ref hydra::DB represents a key-value database,
00035   currently implemented as a table in a SQLite file.
00036   This may change in the future.
00037
00038   \section recordsoversec Records
00039
00040   Hydra uses a key-value database concept for its storage.
00041   Keys are usually filenames, UUIDs or hashes. Values
00042   are always \ref hydra::Record classes that are serialized
00043   to the databsae.
00044
00045   Currently, there are three record types:
00046   \ref hydra::FileItemRecord, \ref hydra::FileHashRecord
00047   and \ref hydra::FilePathRecord.
00048   These three records are stored in three \ref hydra::DB
00049   classes, all maintained by \ref hydra::Engine.
00050   You typically never access the \ref hydra::DB classes
00051   directly, and instead use all the methods provided
00052   by the \ref hydra::Engine class.
00053  */
00054