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

more doc

This commit is contained in:
Frank Celler 2012-05-14 14:51:55 +02:00
parent 2688788454
commit c909ec20f3
16 changed files with 329 additions and 319 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
ApplicationServer/ApplicationServerImpl.h
View File

@ -41,31 +41,31 @@
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineLoggingTOC
///
/// <ol>
/// <ul>
/// <li>@ref CommandLineLoggingGeneral
/// <ol>
/// <ul>
/// <li>@ref CommandLineLoggingLogFile "log.file"</li>
/// <li>@ref CommandLineLoggingLogSeverity "log.severity"</li>
/// <li>@ref CommandLineLoggingLogSyslog "log.syslog"</li>
/// </ol>
/// </ul>
/// </li>
/// <li>@ref CommandLineLoggingHuman
/// <ol>
/// <ul>
/// <li>@ref CommandLineLoggingLogLevel "log.level"</li>
/// <li>@ref CommandLineLoggingLogLineNumber "log.line-number"</li>
/// <li>@ref CommandLineLoggingLogPrefix "log.prefix"</li>
/// <li>@ref CommandLineLoggingLogThread "log.thread"</li>
/// </ol>
/// </ul>
/// </li>
/// <li>@ref CommandLineLoggingMachine
/// <ol>
/// <ul>
/// <li>@ref CommandLineLoggingLogApplication "log.application"</li>
/// <li>@ref CommandLineLoggingLogFacility "log.facility"</li>
/// <li>@ref CommandLineLoggingLogFormat "log.format"</li>
/// <li>@ref CommandLineLoggingLogHostName "log.hostname"</li>
/// </ol>
/// </ul>
/// </li>
/// </ol>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
@ -77,20 +77,14 @@
/// are used to provide statistics about executed requests and timings about
/// computation steps.
///
/// <hr>
/// @copydoc CommandLineLoggingTOC
/// <hr>
///
/// @section CommandLineLoggingGeneral General Logging Options
//////////////////////////////////////////////////////////////
///
/// @anchor CommandLineLoggingLogFile
/// @copydetails triagens::rest::ApplicationServerImpl::logFile
/// <hr>
///
/// @anchor CommandLineLoggingLogSeverity
/// @copydetails triagens::rest::ApplicationServerImpl::logSeverity
/// <hr>
///
/// @anchor CommandLineLoggingLogSyslog
/// @copydetails triagens::rest::ApplicationServerImpl::logSyslog
@ -100,34 +94,27 @@
///
/// @anchor CommandLineLoggingLogLevel
/// @copydetails triagens::rest::ApplicationServerImpl::logLevel
/// <hr>
///
/// @anchor CommandLineLoggingLogLineNumber
/// @copydetails triagens::rest::ApplicationServerImpl::logLineNumber
/// <hr>
///
/// @anchor CommandLineLoggingLogPrefix
/// @copydetails triagens::rest::ApplicationServerImpl::logPrefix
/// <hr>
///
/// @anchor CommandLineLoggingLogThread
/// @copydetails triagens::rest::ApplicationServerImpl::logThreadId
/// <hr>
///
/// @section CommandLineLoggingMachine Maschine Readable Logging
////////////////////////////////////////////////////////////////
///
/// @anchor CommandLineLoggingLogApplication
/// @copydetails triagens::rest::ApplicationServerImpl::logApplicationName
/// <hr>
///
/// @anchor CommandLineLoggingLogFacility
/// @copydetails triagens::rest::ApplicationServerImpl::logFacility
/// <hr>
///
/// @anchor CommandLineLoggingLogFormat
/// @copydetails triagens::rest::ApplicationServerImpl::logFormat
/// <hr>
///
/// @anchor CommandLineLoggingLogHostName
/// @copydetails triagens::rest::ApplicationServerImpl::logHostName
@ -136,19 +123,15 @@
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineRandomTOC
///
/// <ol>
/// <ul>
/// <li>@ref CommandLineRandomGenerator "random.generator"</li>
/// <li>@ref CommandLineRandomGenerator "random.no-seed"</li>
/// </ol>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineRandom Command-Line Options for Random Numbers
///
/// <hr>
/// @copydoc CommandLineRandomTOC
/// <hr>
///
/// @anchor CommandLineRandomGenerator
/// @copydetails triagens::rest::ApplicationServerImpl::randomGenerator
////////////////////////////////////////////////////////////////////////////////
@ -665,8 +648,6 @@ namespace triagens {
/// algorithm. Algorithm 4 is a combination of the blocking random number
/// generator and the Mersenne Twister.
///
/// <hr>
///
/// @CMDOPT{--random.no-seed}
///
/// By default, the random generator is seeded. Setting this option causes the

13
ApplicationServer/ApplicationServerSchedulerImpl.h
View File

@ -35,32 +35,23 @@
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineSchedulerTOC
///
/// <ol>
/// <ul>
/// <li>@ref CommandLineSchedulerThreads "scheduler.threads"</li>
/// <li>@ref CommandLineSchedulerBackend "scheduler.backend"</li>
/// <li>@ref CommandLineSchedulerShowIoBackends "show-io-backends"</li>
/// </ol>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineScheduler Command-Line Options for Communication
///
/// <hr>
/// @copydoc CommandLineSchedulerTOC
/// <hr>
///
/// @anchor CommandLineSchedulerThreads
///////////////////////////////////////
/// @copydetails triagens::rest::ApplicationServerSchedulerImpl::_nrSchedulerThreads
/// <hr>
///
/// @anchor CommandLineSchedulerBackend
///////////////////////////////////////
/// @copydetails triagens::rest::ApplicationServerSchedulerImpl::_backend
/// <hr>
///
/// @anchor CommandLineSchedulerShowIoBackends
//////////////////////////////////////////////
/// @CMDOPT{--show-io-backends}
///
/// If this option is specified, then the server will list available backends

1
Doxygen/Examples.ArangoDB/arangosh-start
View File

@ -1,3 +1,4 @@
> ./arangosh
_
__ _ _ __ __ _ _ __ __ _ ___ ___| |__
/ _` | '__/ _` | '_ \ / _` |/ _ \/ __| '_ \

20
Doxygen/arango-html.doxy
View File

@ -190,13 +190,13 @@ TAB_SIZE = 8
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES += FUN{1}="<tt><b>\1</b></tt>"
ALIASES += FUN{2}="<tt><b>\1, \2</b></tt>"
ALIASES += FUN{3}="<tt><b>\1, \2, \3</b></tt>"
ALIASES += FUN{4}="<tt><b>\1, \2, \3, \4</b></tt>"
ALIASES += FUN{5}="<tt><b>\1, \2, \3, \4, \5</b></tt>"
ALIASES += FUN{6}="<tt><b>\1, \2, \3, \4, \5, \6</b></tt>"
ALIASES += FUN{7}="<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>"
ALIASES += FUN{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += FUN{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2</b></tt><hr>@endif"
ALIASES += FUN{3}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3</b></tt><hr>@endif"
ALIASES += FUN{4}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4</b></tt><hr>@endif"
ALIASES += FUN{5}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5</b></tt><hr>@endif"
ALIASES += FUN{6}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6</b></tt><hr>@endif"
ALIASES += FUN{7}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt><hr>@endif"
ALIASES += FA{1}="<em>\1</em>"
ALIASES += FN{1}="<tt>\1</tt>"
ALIASES += VAR{1}="<tt>\1</tt>"
@ -204,17 +204,21 @@ ALIASES += LIT{1}="<tt>\1</tt>"
ALIASES += CODE{1}="<tt>\1</tt>"
ALIASES += CODE{2}="<tt>\1, \2</tt>"
ALIASES += CODE{3}="<tt>\1, \2, \3</tt>"
ALIASES += CMDOPT{1}="<tt><b>\1</b></tt>"
ALIASES += CMDOPT{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += CA{1}="<em>\1</em>"
ALIASES += CO{1}="<tt>\1</tt>"
ALIASES += REST{1}="<tt><b>\1</b></tt>"
ALIASES += GE{1}="<b>\1</b>"
ALIASES += EXAMPLES="<b>Examples</b><br>"
ALIASES += EXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}@endlatexonly"
ALIASES += TINYEXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}\renewcommand{\examplesize}{\tiny}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}\renewcommand{\examplesize}{\ttfamily}@endlatexonly"
ALIASES += VERSION="0.5.0"
ALIASES += EMBEDTOC{1}="@ifnot LATEX<hr>@copydoc \1<hr>@endif"
ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else <hr><em>\1</em> (\2)<hr><br>@endif"
ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly"
ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else<a href="\1">\2</a>@endif"
ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif"
ALIASES += SPC="&nbsp;"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.

20
Doxygen/arango-latex.doxy
View File

@ -190,13 +190,13 @@ TAB_SIZE = 8
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES += FUN{1}="<tt><b>\1</b></tt>"
ALIASES += FUN{2}="<tt><b>\1, \2</b></tt>"
ALIASES += FUN{3}="<tt><b>\1, \2, \3</b></tt>"
ALIASES += FUN{4}="<tt><b>\1, \2, \3, \4</b></tt>"
ALIASES += FUN{5}="<tt><b>\1, \2, \3, \4, \5</b></tt>"
ALIASES += FUN{6}="<tt><b>\1, \2, \3, \4, \5, \6</b></tt>"
ALIASES += FUN{7}="<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>"
ALIASES += FUN{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += FUN{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2</b></tt><hr>@endif"
ALIASES += FUN{3}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3</b></tt><hr>@endif"
ALIASES += FUN{4}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4</b></tt><hr>@endif"
ALIASES += FUN{5}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5</b></tt><hr>@endif"
ALIASES += FUN{6}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6</b></tt><hr>@endif"
ALIASES += FUN{7}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt><hr>@endif"
ALIASES += FA{1}="<em>\1</em>"
ALIASES += FN{1}="<tt>\1</tt>"
ALIASES += VAR{1}="<tt>\1</tt>"
@ -204,17 +204,21 @@ ALIASES += LIT{1}="<tt>\1</tt>"
ALIASES += CODE{1}="<tt>\1</tt>"
ALIASES += CODE{2}="<tt>\1, \2</tt>"
ALIASES += CODE{3}="<tt>\1, \2, \3</tt>"
ALIASES += CMDOPT{1}="<tt><b>\1</b></tt>"
ALIASES += CMDOPT{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += CA{1}="<em>\1</em>"
ALIASES += CO{1}="<tt>\1</tt>"
ALIASES += REST{1}="<tt><b>\1</b></tt>"
ALIASES += GE{1}="<b>\1</b>"
ALIASES += EXAMPLES="<b>Examples</b><br>"
ALIASES += EXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}@endlatexonly"
ALIASES += TINYEXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}\renewcommand{\examplesize}{\tiny}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}\renewcommand{\examplesize}{\ttfamily}@endlatexonly"
ALIASES += VERSION="0.5.0"
ALIASES += EMBEDTOC{1}="@ifnot LATEX<hr>@copydoc \1<hr>@endif"
ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else <hr><em>\1</em> (\2)<hr><br>@endif"
ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly"
ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else<a href="\1">\2</a>@endif"
ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif"
ALIASES += SPC="&nbsp;"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.

20
Doxygen/arango.template
View File

@ -190,13 +190,13 @@ TAB_SIZE = 8
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES += FUN{1}="<tt><b>\1</b></tt>"
ALIASES += FUN{2}="<tt><b>\1, \2</b></tt>"
ALIASES += FUN{3}="<tt><b>\1, \2, \3</b></tt>"
ALIASES += FUN{4}="<tt><b>\1, \2, \3, \4</b></tt>"
ALIASES += FUN{5}="<tt><b>\1, \2, \3, \4, \5</b></tt>"
ALIASES += FUN{6}="<tt><b>\1, \2, \3, \4, \5, \6</b></tt>"
ALIASES += FUN{7}="<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>"
ALIASES += FUN{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += FUN{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2</b></tt><hr>@endif"
ALIASES += FUN{3}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3</b></tt><hr>@endif"
ALIASES += FUN{4}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4</b></tt><hr>@endif"
ALIASES += FUN{5}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5</b></tt><hr>@endif"
ALIASES += FUN{6}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6</b></tt><hr>@endif"
ALIASES += FUN{7}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt><hr>@endif"
ALIASES += FA{1}="<em>\1</em>"
ALIASES += FN{1}="<tt>\1</tt>"
ALIASES += VAR{1}="<tt>\1</tt>"
@ -204,17 +204,21 @@ ALIASES += LIT{1}="<tt>\1</tt>"
ALIASES += CODE{1}="<tt>\1</tt>"
ALIASES += CODE{2}="<tt>\1, \2</tt>"
ALIASES += CODE{3}="<tt>\1, \2, \3</tt>"
ALIASES += CMDOPT{1}="<tt><b>\1</b></tt>"
ALIASES += CMDOPT{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += CA{1}="<em>\1</em>"
ALIASES += CO{1}="<tt>\1</tt>"
ALIASES += REST{1}="<tt><b>\1</b></tt>"
ALIASES += GE{1}="<b>\1</b>"
ALIASES += EXAMPLES="<b>Examples</b><br>"
ALIASES += EXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}@endlatexonly"
ALIASES += TINYEXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}\renewcommand{\examplesize}{\tiny}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}\renewcommand{\examplesize}{\ttfamily}@endlatexonly"
ALIASES += VERSION="0.5.0"
ALIASES += EMBEDTOC{1}="@ifnot LATEX<hr>@copydoc \1<hr>@endif"
ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else <hr><em>\1</em> (\2)<hr><br>@endif"
ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly"
ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else<a href="\1">\2</a>@endif"
ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif"
ALIASES += SPC="&nbsp;"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.

20
Doxygen/arango.template.in
View File

@ -190,13 +190,13 @@ TAB_SIZE = 8
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
ALIASES += FUN{1}="<tt><b>\1</b></tt>"
ALIASES += FUN{2}="<tt><b>\1, \2</b></tt>"
ALIASES += FUN{3}="<tt><b>\1, \2, \3</b></tt>"
ALIASES += FUN{4}="<tt><b>\1, \2, \3, \4</b></tt>"
ALIASES += FUN{5}="<tt><b>\1, \2, \3, \4, \5</b></tt>"
ALIASES += FUN{6}="<tt><b>\1, \2, \3, \4, \5, \6</b></tt>"
ALIASES += FUN{7}="<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>"
ALIASES += FUN{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += FUN{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2</b></tt><hr>@endif"
ALIASES += FUN{3}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3</b></tt><hr>@endif"
ALIASES += FUN{4}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4</b></tt><hr>@endif"
ALIASES += FUN{5}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5</b></tt><hr>@endif"
ALIASES += FUN{6}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6</b></tt><hr>@endif"
ALIASES += FUN{7}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1, \2, \3, \4, \5, \6, \7</b></tt><hr>@endif"
ALIASES += FA{1}="<em>\1</em>"
ALIASES += FN{1}="<tt>\1</tt>"
ALIASES += VAR{1}="<tt>\1</tt>"
@ -204,17 +204,21 @@ ALIASES += LIT{1}="<tt>\1</tt>"
ALIASES += CODE{1}="<tt>\1</tt>"
ALIASES += CODE{2}="<tt>\1, \2</tt>"
ALIASES += CODE{3}="<tt>\1, \2, \3</tt>"
ALIASES += CMDOPT{1}="<tt><b>\1</b></tt>"
ALIASES += CMDOPT{1}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly<tt><b>\1</b></tt>@latexonly}\vskip 1em@endlatexonly@else<hr><tt><b>\1</b></tt><hr>@endif"
ALIASES += CA{1}="<em>\1</em>"
ALIASES += CO{1}="<tt>\1</tt>"
ALIASES += REST{1}="<tt><b>\1</b></tt>"
ALIASES += GE{1}="<b>\1</b>"
ALIASES += EXAMPLES="<b>Examples</b><br>"
ALIASES += EXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}@endlatexonly"
ALIASES += TINYEXAMPLE{2}="@latexonly\renewcommand{\examplecap}{\2}\renewcommand{\examplesize}{\tiny}@endlatexonly@verbinclude \1@latexonly\renewcommand{\examplecap}{}\renewcommand{\examplesize}{\ttfamily}@endlatexonly"
ALIASES += VERSION="@PACKAGE_VERSION@"
ALIASES += EMBEDTOC{1}="@ifnot LATEX<hr>@copydoc \1<hr>@endif"
ALIASES += RESTHEADER{2}="@if LATEX@latexonly \vskip 0.5em\colorbox{gray}{@endlatexonly\1 (\2)@latexonly}\vskip 1em@endlatexonly@else <hr><em>\1</em> (\2)<hr><br>@endif"
ALIASES += LATEXBREAK="@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly"
ALIASES += EXTREF{2}="@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else<a href="\1">\2</a>@endif"
ALIASES += INTREF{2}="@if LATEX \2@else@ref \1 \"\2\"@endif"
ALIASES += SPC="&nbsp;"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.

4
Doxygen/latex/header.tex
View File

@ -13,6 +13,7 @@
\usepackage{mathptmx}
\usepackage[scaled=.90]{helvet}
\usepackage{courier}
\usepackage[hyphens]{url}
\usepackage{doxygen}
\usepackage{listings}
\lstset{language=C++,inputencoding=utf8,basicstyle=\footnotesize,breaklines=true,breakatwhitespace=true,tabsize=8,numbers=left }
@ -21,8 +22,9 @@
\let\DoxyVerbInclude=\undefined
\renewcommand{\footrulewidth}{0.4pt}
\newcommand{\examplecap}{}
\newcommand{\examplesize}{\ttfamily}
\lstnewenvironment{DoxyVerbInclude}{%
\lstset{numbers=none,backgroundcolor=\color{lightgray},language=,basicstyle=\ttfamily,breaklines=true,breakatwhitespace=false,caption=\protect\examplecap,captionpos=below}
\lstset{numbers=none,backgroundcolor=\color{lightgray},language=,basicstyle=\protect\examplesize,breaklines=true,breakatwhitespace=false,caption=\protect\examplecap,captionpos=below}%
}{%
}
\definecolor{gray}{gray}{.8}

6
RestServer/ArangoServer.h
View File

@ -230,9 +230,9 @@ namespace triagens {
///
/// @CMDOPT{--server.http-port @CA{address}:@CA{port}}
///
/// Specifies the @CA{port} for HTTP requests by clients. This will bind to the
/// given @CA{address}, which can be a numeric value like @CODE{192.168.1.1} or
/// a name.
/// Specifies the @CA{address} and @CA{port} for HTTP requests by clients. This
/// will bind to the given @CA{address}, which can be a numeric value like
/// @CODE{192.168.1.1} or a name.
///
/// @CMDOPT{--port @CA{port}}
///

120
RestServer/command-line-options.dox
View File

@ -25,6 +25,126 @@
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineTOC
///
/// <ul>
/// <li>@ref CommandLine
/// <ul>
/// <li>@ref CommandLineGeneralOptions
/// <ul>
/// <li>@ref CommandLineHelp "help"</li>
/// <li>@ref CommandLineVersion "version"</li>
/// <li>@ref CommandLineConfiguration "configuration"</li>
/// <li>@ref CommandLineDaemon "daemon"</li>
/// <li>@ref CommandLineSupervisor "supervisor"</li>
/// <li>@ref CommandLineUid "uid"</li>
/// <li>@ref CommandLineGid "gid"</li>
/// <li>@ref CommandLinePidFile "pid-file"</li>
/// </ul>
/// </li>
/// <li>@ref CommandLineArango
/// <ul>
/// <li>@ref CommandLineArangoHttpPort "server.http-port"</li>
/// <li>@ref CommandLineArangoAdminPort "server.admin-port"</li>
/// <li>@ref CommandLineArangoDirectory "database.directory"</li>
/// <li>@ref CommandLineArangoMaximalJournalSize "database.maximal-journal-size"</li>
/// <li>@ref CommandLineArangoRemoveOnDrop "database.remove-on-drop"</li>
/// </ul>
/// </li>
/// <li>@ref CommandLineLoggingInc
/// @copydetails CommandLineLoggingTOC
/// </li>
/// <li>@ref CommandLineSchedulerInc
/// @copydetails CommandLineSchedulerTOC
/// </li>
/// <li>@ref CommandLineRandomInc
/// @copydetails CommandLineRandomTOC
/// </li>
/// </ul>
/// </li>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLine Command-Line Options
///
/// @EMBEDTOC{CommandLineTOC}
///
/// @section CommandLineGeneralOptions General Options
//////////////////////////////////////////////////////
///
/// @anchor CommandLineHelp
/// @copydetails triagens::rest::ApplicationServerImpl::options
///
/// @anchor CommandLineVersion
/// @copydetails triagens::rest::ApplicationServerImpl::version
///
/// @anchor CommandLineConfiguration
/// @copydetails triagens::rest::ApplicationServerImpl::initFile
///
/// @anchor CommandLineDaemon
/// @CMDOPT{--daemon}
///
/// Runs the server as a daemon (as a background process). This parameter can
/// only be set if the pid (process id) file is specified. That is, unless a
/// value to the parameter pid-file is given, then the server will report an
/// error and exit.
///
/// @anchor CommandLineSupervisor
/// @CMDOPT{--supervisor}
///
/// Executes the server in supervisor mode. In the event that the server
/// unexpectedly terminates due to an internal error, the supervisor will
/// automatically restart the server. Setting this flag automatically implies
/// that the server will run as a daemon. Note that, as with the daemon flag,
/// this flag requires that the pid-file parameter will set.
///
/// @anchor CommandLineUid
/// @copydetails triagens::rest::ApplicationServerImpl::uid
///
/// @anchor CommandLineGid
/// @copydetails triagens::rest::ApplicationServerImpl::gid
///
/// @anchor CommandLinePidFile
/// @copydetails triagens::rest::AnyServer::_pidFile
///
/// @section CommandLineArango Command-Line Options for the ArangoDB
////////////////////////////////////////////////////////////////////
///
/// @anchor CommandLineArangoHttpPort
/// @copydetails triagens::arango::ArangoServer::_httpPort
///
/// @anchor CommandLineArangoAdminPort
/// @copydetails triagens::arango::ArangoServer::_adminPort
///
/// @anchor CommandLineArangoDirectory
/// @copydetails triagens::arango::ArangoServer::_databasePath
///
/// @anchor CommandLineArangoMaximalJournalSize
/// @copydetails triagens::arango::ArangoServer::_defaultMaximalSize
///
/// @anchor CommandLineArangoRemoveOnDrop
/// @copydetails triagens::arango::ArangoServer::_removeOnDrop
///
/// @section CommandLineSchedulerInc Command-Line Options for Communication
///////////////////////////////////////////////////////////////////////////
///
/// @copydetails CommandLineScheduler
///
/// @section CommandLineLoggingInc Command-Line Options for Logging
///////////////////////////////////////////////////////////////////
///
/// @copydetails CommandLineLogging
///
/// @section CommandLineRandomInc Command-Line Options for Random Numbers
/////////////////////////////////////////////////////////////////////////
///
/// @copydetails CommandLineRandom
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
// mode: c++
// mode: outline-minor

134
RestServer/ref-manual.dox
View File

@ -121,140 +121,6 @@
/// @endif
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineSubTOC
///
/// <ul>
/// <li>@ref CommandLineArango</li>
/// <li>@ref CommandLineScheduler</li>
/// <li>@ref CommandLineLogging</li>
/// <li>@ref CommandLineRandom</li>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineTOC
///
/// <ul>
/// <li>@ref CommandLineHelp "help"</li>
/// <li>@ref CommandLineVersion "version"</li>
/// <li>@ref CommandLineConfiguration "configuration"</li>
/// <li>@ref CommandLineDaemon "daemon"</li>
/// <li>@ref CommandLineSupervisor "supervisor"</li>
/// <li>@ref CommandLineUid "uid"</li>
/// <li>@ref CommandLineGid "gid"</li>
/// <li>@ref CommandLinePidFile "pid-file"</li>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLine Command-Line Options
///
/// <hr>
/// @copydoc CommandLineTOC
/// <hr>
///
/// @section GeneralOptions General Options
///////////////////////////////////////////
///
/// @anchor CommandLineHelp
///////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::options
/// <hr>
///
/// @anchor CommandLineVersion
//////////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::version
/// <hr>
///
/// @anchor CommandLineConfiguration
////////////////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::initFile
/// <hr>
///
/// @anchor CommandLineDaemon
/////////////////////////////
/// @CMDOPT{--daemon}
///
/// Runs the server as a daemon (as a background process). This parameter can
/// only be set if the pid (process id) file is specified. That is, unless a
/// value to the parameter pid-file is given, then the server will report an
/// error and exit.
///
/// <hr>
///
/// @anchor CommandLineSupervisor
/////////////////////////////////
/// @CMDOPT{--supervisor}
///
/// Executes the server in supervisor mode. In the event that the server
/// unexpectedly terminates due to an internal error, the supervisor will
/// automatically restart the server. Setting this flag automatically implies
/// that the server will run as a daemon. Note that, as with the daemon flag,
/// this flag requires that the pid-file parameter will set.
///
/// <hr>
///
/// @anchor CommandLineUid
//////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::uid
/// <hr>
///
/// @anchor CommandLineGid
//////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::gid
/// <hr>
///
/// @anchor CommandLinePidFile
//////////////////////////////
/// @copydetails triagens::rest::AnyServer::_pidFile
/// <hr>
///
/// Next steps:
///////////////
///
/// @copydetails CommandLineSubTOC
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineArangoTOC
///
/// <ul>
/// <li>@ref CommandLineArangoHttpPort "server.http-port"</li>
/// <li>@ref CommandLineArangoAdminPort "server.admin-port"</li>
/// <li>@ref CommandLineArangoDirectory "database.directory"</li>
/// <li>@ref CommandLineArangoMaximalJournalSize "database.maximal-journal-size"</li>
/// <li>@ref CommandLineArangoRemoveOnDrop "database.remove-on-drop"</li>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineArango Command-Line Options for the ArangoDB
///
/// <hr>
/// @copydoc CommandLineArangoTOC
/// <hr>
///
/// @anchor CommandLineArangoHttpPort
/// @copydetails triagens::arango::ArangoServer::_httpPort
/// <hr>
///
/// @anchor CommandLineArangoAdminPort
/// @copydetails triagens::arango::ArangoServer::_adminPort
/// <hr>
///
/// @anchor CommandLineArangoDirectory
/// @copydetails triagens::arango::ArangoServer::_databasePath
/// <hr>
///
/// @anchor CommandLineArangoMaximalJournalSize
/// @copydetails triagens::arango::ArangoServer::_defaultMaximalSize
/// <hr>
///
/// @anchor CommandLineArangoRemoveOnDrop
/// @copydetails triagens::arango::ArangoServer::_removeOnDrop
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page DBAdminTOC
///

134
RestServer/simple-queries.dox
View File

@ -28,84 +28,84 @@
////////////////////////////////////////////////////////////////////////////////
/// @page SimpleQueriesTOC
///
/// <ol>
/// <li>@ref SimpleQueriesQueries
/// <ol>
/// <li>@ref SimpleQueryDocument "collection.document(document-reference)"</li>
/// <li>@ref SimpleQueryAll "collection.all()"</li>
/// <li>@ref SimpleQueryByExample "collection.byExample(example)"</li>
/// <li>@ref SimpleQueryFirstExample "collection.firstExample(example)"</li>
/// <li>@ref SimpleQueryCollectionCount "collection.count()"</li>
/// <li>@ref SimpleQueryToArray "collection.toArray()"</li>
/// </ol>
/// <ul>
/// <li>@ref SimpleQueries
/// <ul>
/// <li>@ref SimpleQueriesQueries
/// <ul>
/// <li>@ref SimpleQueryDocument "collection.document"</li>
/// <li>@ref SimpleQueryAll "collection.all"</li>
/// <li>@ref SimpleQueryByExample "collection.byExample"</li>
/// <li>@ref SimpleQueryFirstExample "collection.firstExample"</li>
/// <li>@ref SimpleQueryCollectionCount "collection.count"</li>
/// <li>@ref SimpleQueryToArray "collection.toArray"</li>
/// </ul>
/// </li>
/// <li>@ref SimpleQueriesGeoQueries
/// <ul>
/// <li>@ref SimpleQueryNear "collection.near"</li>
/// <li>@ref SimpleQueryWithin "collection.within"</li>
/// <li>@ref SimpleQueryGeo "collection.geo"</li>
/// </ul>
/// </li>
/// <li>@ref SimpleQueriesEdgesQueries
/// <ul>
/// <li>@ref SimpleQueryEdges "edges-collection.edges"</li>
/// <li>@ref SimpleQueryInEdges "edges-collection.inEdges"</li>
/// <li>@ref SimpleQueryOutEdges "edges-collection.outEdges"</li>
/// </ul>
/// </li>
/// <li>@ref SimpleQueriesPagination
/// <ul>
/// <li>@ref SimpleQueryLimit "query.limit"</li>
/// <li>@ref SimpleQuerySkip "query.skip"</li>
/// </ul>
/// </li>
/// <li>@ref SimpleQueriesCursor
/// <ul>
/// <li>@ref SimpleQueryHasNext "query.hasNext"</li>
/// <li>@ref SimpleQueryNext "query.next"</li>
/// <li>@ref SimpleQueryDispose "query.dispose"</li>
/// <li>@ref SimpleQueryCount "query.count"</li>
/// </ul>
/// </li>
/// </ul>
/// </li>
/// <li>@ref SimpleQueriesGeoQueries
/// <ol>
/// <li>@ref SimpleQueryNear "collection.near(latitude, longitude)"</li>
/// <li>@ref SimpleQueryWithin "collection.within(latitude, longitude)"</li>
/// <li>@ref SimpleQueryGeo "collection.geo(location)"</li>
/// </ol>
/// </li>
/// <li>@ref SimpleQueriesEdgesQueries
/// <ol>
/// <li>@ref SimpleQueryEdges "edges-collection.edges(vertex)"</li>
/// <li>@ref SimpleQueryInEdges "edges-collection.inEdges(vertex)"</li>
/// <li>@ref SimpleQueryOutEdges "edges-collection.outEdges(vertex)"</li>
/// </ol>
/// </li>
/// <li>@ref SimpleQueriesPagination
/// <ol>
/// <li>@ref SimpleQueryLimit "query.limit(limit)"</li>
/// <li>@ref SimpleQuerySkip "query.skip(skip)"</li>
/// </ol>
/// </li>
/// <li>@ref SimpleQueriesSequentialAccess
/// <ol>
/// <li>@ref SimpleQueryHasNext "query.hasNext()"</li>
/// <li>@ref SimpleQueryNext "query.next()"</li>
/// <li>@ref SimpleQueryCount "query.count()"</li>
/// </ol>
/// </li>
/// </ol>
/// </ul>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page SimpleQueries Simple Queries
///
/// Simple queries can be used if the query condition is straight forward
/// simple, i. e., a document reference, all documents, a query-by-example, or a
/// simple geo query. In a simple query you can specify exactly one collection
/// and one condition.
///
/// <hr>
/// @copydoc SimpleQueriesTOC
/// <hr>
/// Simple queries can be used if the query condition is straight forward,
/// i. e., a document reference, all documents, a query-by-example, or a simple
/// geo query. In a simple query you can specify exactly one collection and one
/// query criteria. In the following sections we describe the JavaScript shell
/// interface for simple queries, which you can use within the ArangoDB shell
/// and within actions and transactions.
///
/// If a query returns a cursor, then you can use @FN{hasNext} and @FN{next} to
/// iterate over the result set or @FN{toArray} to convert it to an array.
///
/// @EMBEDTOC{ SimpleQueriesTOC}
///
/// @section SimpleQueriesQueries Queries
/////////////////////////////////////////
///
/// @anchor SimpleQueryDocument
/// @copydetails JS_DocumentVocbaseCol
/// <hr>
///
/// @anchor SimpleQueryAll
/// @copydetails JSF_ArangoCollection_prototype_all
/// <hr>
///
/// @anchor SimpleQueryByExample
/// @copydetails JSF_ArangoCollection_prototype_byExample
/// <hr>
///
/// @anchor SimpleQueryFirstExample
/// @copydetails JSF_ArangoCollection_prototype_firstExample
/// <hr>
///
/// @anchor SimpleQueryCollectionCount
/// @copydetails JS_CountVocbaseCol
/// <hr>
///
/// @anchor SimpleQueryToArray
/// @copydetails JSF_ArangoCollection_prototype_toArray
@ -113,31 +113,27 @@
/// @section SimpleQueriesGeoQueries Geo Queries
////////////////////////////////////////////////
///
/// The ArangoDB allows to selects documents based on geographic
/// coordinates. In order for this to work, a geo-spatial index must be defined.
/// This index will use a very elaborate algorithm to lookup neighbours that is
/// a magnitude faster than a simple R* index.
/// The ArangoDB allows to selects documents based on geographic coordinates. In
/// order for this to work, a geo-spatial index must be defined. This index
/// will use a very elaborate algorithm to lookup neighbors that is a magnitude
/// faster than a simple R* index.
///
/// In general a geo coordinate is a pair of latitude and longitude. This can
/// either be an list with two elements like @CODE{[ -10\, +30 ]} (latitude
/// first, followed by longitude) or an object like @CODE{{ lon: -10\, lat: +30
/// }}. In order to find all documents within a given radius around a
/// coordinate use the @FN{within} operator. In order to find all
/// documents near a given document use the @FN{near} operator.
/// first, followed by longitude) or an object like @CODE{{ lon: -10\, lat: +30}}.
/// In order to find all documents within a given radius around a coordinate
/// use the @FN{within} operator. In order to find all documents near a given
/// document use the @FN{near} operator.
///
/// It is possible to define more than one geo-spatial index per collection. In
/// this case you must give a hint using the @FN{geo} operator which of indexes
/// should be used in a query.
///
/// <hr>
///
/// @anchor SimpleQueryNear
/// @copydetails JSF_ArangoCollection_prototype_near
/// <hr>
///
/// @anchor SimpleQueryWithin
/// @copydetails JSF_ArangoCollection_prototype_within
/// <hr>
///
/// @anchor SimpleQueryGeo
/// @copydetails JSF_ArangoCollection_prototype_geo
@ -147,11 +143,9 @@
///
/// @anchor SimpleQueryEdges
/// @copydetails JS_EdgesQuery
/// <hr>
///
/// @anchor SimpleQueryInEdges
/// @copydetails JS_InEdgesQuery
/// <hr>
///
/// @anchor SimpleQueryOutEdges
/// @copydetails JS_OutEdgesQuery
@ -174,21 +168,21 @@
///
/// @anchor SimpleQueryLimit
/// @copydetails JSF_SimpleQuery_prototype_limit
/// <hr>
///
/// @anchor SimpleQuerySkip
/// @copydetails JSF_SimpleQuery_prototype_skip
///
/// @section SimpleQueriesSequentialAccess Sequential Access
////////////////////////////////////////////////////////////
/// @section SimpleQueriesCursor Sequential Access and Cursors
//////////////////////////////////////////////////////////////
///
/// @anchor SimpleQueryHasNext
/// @copydetails JSF_SimpleQuery_prototype_hasNext
/// <hr>
///
/// @anchor SimpleQueryNext
/// @copydetails JSF_SimpleQuery_prototype_next
/// <hr>
///
/// @anchor SimpleQueryDispose
/// @copydetails JSF_SimpleQuery_prototype_dispose
///
/// @anchor SimpleQueryCount
/// @copydetails JSF_SimpleQuery_prototype_count

61
RestServer/user-manual.dox
View File

@ -31,14 +31,19 @@
/// @if LATEX
/// <ul>
/// <li>@ref UserManualBasics</li>
/// <li>@ref SimpleQueries</li>
/// <li>ArangoQueryLanguage</li>
/// @latexonly\appendix@endlatexonly
/// <li>@ref CommandLine</li>
/// <li>@ref Glossary</li>
/// </ul>
/// @else
/// @copydetails UserManualBasicsTOC
/// @copydetails SimpleQueriesTOC
/// <ul>
/// <li>Arango Query Language</li>
/// </ul>
/// @copydetails CommandLineTOC
/// @endif
////////////////////////////////////////////////////////////////////////////////
@ -54,6 +59,7 @@
/// <li>@ref UserManualServerStartStopOptions</li>
/// </ul>
/// </li>
/// <li>@ref UserManualServerFE</li>
/// <li>@ref UserManualShellStartStop
/// <ul>
/// <li>@ref UserManualShellStartStopOptions</li>
@ -97,21 +103,22 @@
/// For more in-depth information
///
/// <ul>
/// <li> read more on the <a href="http://www.arangodb.org/2012/03/07/arangodbs-design-objectives">
/// design goals of ArangoDB</a></li>
/// <li> <a href="http://vimeo.com/36411892">watch the video</a> - Martin Schoenert,
/// <li> read more on the@SPC@EXTREF{http://www.arangodb.org/2012/03/07/arangodbs-design-objectives,design goals of ArangoDB}</li>
/// <li> @EXTREF{http://vimeo.com/36411892,watch the video}@SPC- Martin Schoenert,
/// architect of ArangoDB, gives an introduction of what the ArangoDB project
/// is about.</li>
/// <li> or give it a @ref InstallManual "try".</li>
/// <li> or give it a@SPC@INTREF{InstallManual,try}.</li>
/// </ul>
///
/// The ArangoDB database groups documents into collections. Each collection can
/// be accessed using queries. For simple queries involving just one collection
/// and one search criteria, you can use a simple interface from within
/// JavaScript code or other languages supported by an API. This interface
/// allows you to select documents from one collection based on simple search
/// criteria. For more complex queries, you can use the Arango Query Language,
/// which is an evolution of SQL resp. UNQL for the NoSQL world.
/// The ArangoDB database groups documents into collections. Collections and
/// documents can be accessed using queries. For simple queries involving just
/// one collection and one search criteria, you can use a simple interface from
/// within JavaScript code or other languages supported by an API. This
/// interface allows you to select documents from one collection based on just
/// one search criteria. For more complex queries, you can use the Arango Query
/// Language (AQL), which is an evolution of SQL resp. UNQL for the NoSQL
/// world. AQL allows you to use more then one collection, similar to joins from
/// SQL, while still retaining the document and list structures like UNQL.
///
/// The ArangoDB database packages comes with various programs:
///
@ -131,8 +138,8 @@
///////////////////////////////////////////////////////////////////
///
/// The ArangoDB database server has two modes of operation: as server, where it
/// will answer to client requests and an emergency console, where you can
/// access the database directly. The latter should - as the name suggests -
/// will answer to client requests and an emergency console, in which you can
/// access the database directly. The latter - as the name suggests - should
/// only be used in case of an emergency, for example, a corrupted
/// collection. Using the emergency console allows you to issue all commands
/// normally available in actions and transactions.
@ -148,7 +155,7 @@
/// UserManualServerStartStopOptions "below" for a list of frequently used
/// options, see @ref CommandLine "here" for a complete list.
///
/// @verbinclude option-database-directory
/// @TINYEXAMPLE{option-database-directory,starting the server}
///
/// After starting the server, point your favorite browser to:
///
@ -188,6 +195,26 @@
///
/// Runs the server as a daemon (as a background process).
///
/// @section UserManualServerFE ArangoDB's Front-End
////////////////////////////////////////////////////
///
/// The ArangoDB server has a graphical front-end, which allows you to inspect
/// the current state of the server. You can read the front-end using the
/// following URL:
///
/// @LIT{http://localhost:8529/_admin}
///
/// Unless you have loaded an application into the ArangoDB server which remaps
/// the paths, the front-end will also be available under
/// @LIT{http://localhost:8529/}.
///
/// @htmlonly <img src="images/fe1.png" alt="ArangoDB Fron-End">@endhtmlonly
/// @latexonly\includegraphics[width=12cm]{images/fe1.png}@endlatexonly
///
/// The front-end allows you the browser through the collections and
/// documents. If you need to administrate the database, please use
/// the ArgangoDB shell described in the next section.
///
/// @section UserManualShellStartStop Starting the ArangoDB Shell
/////////////////////////////////////////////////////////////////
///
@ -196,7 +223,7 @@
/// any arguments, the ArangoDB shell will try to contact the server
/// on port 8529 on the localhost.
///
/// @verbinclude arangosh-start
/// @TINYEXAMPLE{arangosh-start,starting the shell}
///
/// The shell will print its own version number and, if successfully connected
/// to a server, the version number of the ArangoDB server.
@ -206,7 +233,7 @@
///
/// Use @LIT{--help} to get a list of command-line options:
///
/// @verbinclude arangosh-options
/// @TINYEXAMPLE{arangosh-options,shell options}
///
/// @section UserManualServerStartStopDebug Starting the ArangoDB Emergency Console
///////////////////////////////////////////////////////////////////////////////////
@ -217,7 +244,7 @@
/// @note Never start the emergency console for a database which also has a
/// server attached to it. In general the ArangoDB shell is what you want.
///
/// @verbinclude start-emergency-console
/// @EXAMPLE{start-emergency-console,emergency console}
////////////////////////////////////////////////////////////////////////////////
// Local Variables:

36
js/actions/system/api-system.js
View File

@ -40,25 +40,33 @@ var actions = require("actions");
/// @brief returns system status information for the server
////////////////////////////////////////////////////////////////////////////////
function AdminRedirect (req, res) {
var dest = "/_admin/html/index.html";
res.responseCode = actions.HTTP_MOVED_PERMANENTLY;
res.contentType = "text/html";
res.body = "<html><head><title>Moved</title></head><body><h1>Moved</h1><p>This page has moved to <a href=\""
+ dest
+ "\">"
+ dest
+ "</a>.</p></body></html>";
res.headers = { location : dest };
}
actions.defineHttp({
url : "",
context : "admin",
prefix : false,
callback : AdminRedirect
});
callback : function (req, res) {
var dest = "/_admin/html/index.html";
res.responseCode = actions.HTTP_MOVED_PERMANENTLY;
res.contentType = "text/html";
res.body = "<html><head><title>Moved</title></head><body><h1>Moved</h1><p>This page has moved to <a href=\""
+ dest
+ "\">"
+ dest
+ "</a>.</p></body></html>";
res.headers = { location : dest };
}
actions.defineHttp({
url : "_admin",
context : "admin",
prefix : false,
callback : AdminRedirect
});
////////////////////////////////////////////////////////////////////////////////

14
js/common/modules/simple-query-basics.js
View File

@ -93,8 +93,8 @@ ArangoEdgesCollection.prototype.all = ArangoCollection.prototype.all;
///
/// Limits the result to @FA{limit} documents instead of the default 100.
///
/// @note @FA{limit} can be more than 100, this will raise the default
/// limit.
/// @note Unlike with multiple explicit limits, @FA{limit} will raise
/// the implicit default limit imposed by @FN{within}.
///
/// @FUN{@FA{collection}.near(@FA{latitude}, @FA{longitude}).distance()}
////////////////////////////////////////////////////////////////////////
@ -679,7 +679,7 @@ SimpleQuery.prototype.toArray = function () {
////////////////////////////////////////////////////////////////////////////////
/// @brief counts the number of documents
///
/// @FUN{count()}
/// @FUN{@FA{cursor}.count()}
///
/// The @FN{count} operator counts the number of document in the result set and
/// returns that number. The @FN{count} operator ignores any limits and returns
@ -688,7 +688,7 @@ SimpleQuery.prototype.toArray = function () {
/// @note Not all simple queries support counting. In this case @LIT{null} is
/// returned.
///
/// @FUN{count(@LIT{true})}
/// @FUN{@FA{cursor}.count(@LIT{true})}
///
/// If the result set was limited by the @FN{limit} operator or documents were
/// skiped using the @FN{skip} operator, the @FN{count} operator with argument
@ -723,7 +723,7 @@ SimpleQuery.prototype.count = function (applyPagination) {
////////////////////////////////////////////////////////////////////////////////
/// @brief checks if the cursor is exhausted
///
/// @FUN{hasNext()}
/// @FUN{@FA{cursor}.hasNext()}
///
/// The @FN{hasNext} operator returns @LIT{true}, then the cursor still has
/// documents. In this case the next document can be accessed using the
@ -743,7 +743,7 @@ SimpleQuery.prototype.hasNext = function () {
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the next result document
///
/// @FUN{next()}
/// @FUN{@FA{cursor}.next()}
///
/// If the @FN{hasNext} operator returns @LIT{true}, then the underlying
/// cursor of the simple query still has documents. In this case the
@ -765,7 +765,7 @@ SimpleQuery.prototype.next = function() {
////////////////////////////////////////////////////////////////////////////////
/// @brief disposes the result
///
/// @FUN{dispose()}
/// @FUN{@FA{cursor}.dispose()}
///
/// If you are no longer interested in any further results, you should call
/// @FN{dispose} in order to free any resources associated with the query.

6
js/server/modules/actions.js
View File

@ -109,7 +109,7 @@ function DefineHttp (options) {
var contexts = options.context;
var callback = options.callback;
var parameters = options.parameters;
var prefix = options.prefix || false;
var prefix = true;
var userContext = false;
if (! contexts) {
@ -140,6 +140,10 @@ function DefineHttp (options) {
return;
}
if (options.hasOwnProperty("prefix")) {
prefix = options.prefix;
}
var parameter = { parameters : parameters, prefix : prefix };
// console.debug("callback: %s", callback);