Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

added datafile debugger doc

This commit is contained in:
Frank Celler 2012-07-29 13:06:33 +02:00
parent 579e80534f
commit 05a6c4eb90
3 changed files with 55 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile.files
View File

@ -79,6 +79,7 @@ WIKI = \
DbaManual \
DbaManualBasics \
DbaManualAuthentication \
DbaManualDatafileDebugger \
DefineAction \
ExamplesSetup \
FirstStepsArangoDB \

1
Makefile.in
View File

@ -1233,6 +1233,7 @@ WIKI = \
DbaManual \
DbaManualBasics \
DbaManualAuthentication \
DbaManualDatafileDebugger \
DefineAction \
ExamplesSetup \
FirstStepsArangoDB \

54
arangod/Documentation/dba-manual.dox
View File

@ -25,12 +25,18 @@
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- DBA MANUAL
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @page DbaManual ArangoDB's DBA Manual
///
/// @if LATEX
/// <ul>
/// <li>@ref DbaManualBasics</li>
/// <li>@ref DbaManualAuthentication</li>
/// <li>@ref DbaManualDatafileDebugger</li>
/// <li>@ref ShellCollection</li>
/// <li>@ref ShellIndex</li>
/// <li>@ref IndexCap</li>
@ -43,13 +49,18 @@
/// </ul>
/// @else
/// @copydetails DbaManualBasicsTOC
/// @copydetails DbaManualAuthenticationTOC
/// @copydetails DbaManualDatafileDebuggerTOC
/// @copydetails ShellCollectionTOC
/// @copydetails ShellIndexTOC
/// @copydetails IndexesTOC
/// @copydetails DbaManualAuthenticationTOC
/// @endif
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- DBA MANUAL BASCIS
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @page DbaManualBasicsTOC
///
@ -96,6 +107,10 @@
/// @copydetails JS_PropertiesVocbaseCol
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- DBA MANUAL AUTHENTICATION
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @page DbaManualAuthenticationTOC
///
@ -149,6 +164,43 @@
/// @copydetails triagens::arango::ArangoServer::_httpAuth
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- DBA MANUAL DATAFILE DEBUGGER
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @page DbaManualDatafileDebuggerTOC
///
/// <ul>
/// <li>@ref DbaManualDatafileDebugger
/// </li>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page DbaManualDatafileDebugger Datafile Debugger
///
/// @EMBEDTOC{DbaManualDatafileDebuggerTOC}
///
/// AranagoDB uses append-only journals. The corruption should only occur when
/// the database server is kill. In this case, the corruption should only
/// occur in the last object(s) being written to the journal.
///
/// If a corruption occurs within a normal datafile, then this can only happen
/// if a hardware fault occurred.
///
/// If a journal or datafile is corrupt, shutdown the database server and start
/// the program
///
/// @LIT{arango-dfdb}
///
/// in order to check the consistency of the datafiles and journals.
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- END-OF-FILE
// -----------------------------------------------------------------------------
// Local Variables:
// mode: c++
// mode: outline-minor