mirror of https://gitee.com/bigwinds/arangodb
doc
This commit is contained in:
Frank Celler
parent
e4c5135cbb
commit
9d10ae943e
|
|
@ -314,5 +314,6 @@ WIKI = \
|
|||
Doxygen/xml/RestDocument.md \
|
||||
Doxygen/xml/RestSystem.md \
|
||||
Doxygen/xml/StartStop.md \
|
||||
Doxygen/xml/UserManual.md \
|
||||
Doxygen/xml/UserManualServer.md \
|
||||
Doxygen/xml/UserManualShell.md \
|
||||
Doxygen/xml/jsUnity.md
|
||||
|
|
|
|||
|
|
@ -820,7 +820,8 @@ WIKI = \
|
|||
Doxygen/xml/RestDocument.md \
|
||||
Doxygen/xml/RestSystem.md \
|
||||
Doxygen/xml/StartStop.md \
|
||||
Doxygen/xml/UserManual.md \
|
||||
Doxygen/xml/UserManualServer.md \
|
||||
Doxygen/xml/UserManualShell.md \
|
||||
Doxygen/xml/jsUnity.md
|
||||
|
||||
@ENABLE_32BIT_TRUE@@ENABLE_ALL_IN_ONE_TRUE@LIBEV_BUILD_VERSION = ARCH.ia32
|
||||
|
|
|
|||
|
|
@ -35,376 +35,6 @@ using namespace triagens::basics;
|
|||
using namespace triagens::rest;
|
||||
using namespace triagens::avocado;
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- USER MANUAL
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page UserManual AvocadoDB User Manual
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>@ref Basics
|
||||
/// <ol>
|
||||
/// <li>@ref StartStop
|
||||
/// </li>
|
||||
/// <li>AvocadoScript
|
||||
/// <ol>
|
||||
/// <li>@ref SimpleQueries
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>@ref AQL
|
||||
/// <ol>
|
||||
/// <li>@ref Optimizer
|
||||
/// </li>
|
||||
/// <li>@ref IndexUsage
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>@ref AvocadoScript
|
||||
/// <ol>
|
||||
/// <li>@ref GeoCoordinates
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>Vertices, Edges, and Graphs
|
||||
/// <ol>
|
||||
/// <li>@ref Graphs
|
||||
/// </li>
|
||||
/// <li>@ref JSModuleGraph
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>Client Communication
|
||||
/// <ol>
|
||||
/// <li>@ref HttpInterface
|
||||
/// <ol>
|
||||
/// <li>@ref RestDocument
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>@ref DBAdmin
|
||||
/// <ol>
|
||||
/// <li>@ref DBAdminDurability
|
||||
/// </li>
|
||||
/// <li>@ref DBAdminIndex
|
||||
/// <ol>
|
||||
/// <li>@ref DBAdminIndexGeo
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>Advanced Topics
|
||||
/// <ol>
|
||||
/// <li>Actions
|
||||
/// <ol>
|
||||
/// <li>@ref Actions
|
||||
/// </li>
|
||||
/// <li>@ref DefineAction
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>@ref HttpInterface
|
||||
/// <ol>
|
||||
/// <li>@ref RestSystem
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// <li>@ref jsUnity
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page Basics Basics
|
||||
///
|
||||
/// The AvocadoDB groups documents into collections. Each collection can be
|
||||
/// accessed using queries. For simple queries involving just one collection,
|
||||
/// you can use a fluent interface from within JavaScript code, see @ref
|
||||
/// AvocadoScript. This interface allows you to select documents from one
|
||||
/// collection based on simple search criteria. The @ref HttpInterface
|
||||
/// lets you create, modify, or delete a single document via HTTP. For
|
||||
/// more complex queries, you can use the Avocado Query Language, which is
|
||||
/// an extension of SQL resp. UNQL.
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page StartStopTOC
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>@ref StartStopHttp "Starting the HTTP Server"</li>
|
||||
/// <li>@ref StartStopDebug "Starting the Debug Shell"</li>
|
||||
/// <li>@ref StartStopOptions "Frequently Used Options"</li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page StartStop Starting the AvocadoDB
|
||||
///
|
||||
/// The AvocadoDB has two mode of operation: as server, where it will answer to
|
||||
/// HTTP requests, see @ref HttpInterface, and a debug shell, where you can
|
||||
/// access the database directly. Using the debug shell allows you to issue all
|
||||
/// commands normally available in actions and transactions, see @ref
|
||||
/// AvocadoScript.
|
||||
///
|
||||
/// You should never start more than one server for the same database,
|
||||
/// independent from the mode of operation.
|
||||
///
|
||||
/// <hr>
|
||||
/// @copydoc StartStopTOC
|
||||
/// <hr>
|
||||
///
|
||||
/// @section StartStopHttp Starting the HTTP Server
|
||||
///
|
||||
/// The following command starts the AvocadoDB in server mode. You will be able
|
||||
/// to access the server using HTTP request on port 8529. See below for a list
|
||||
/// of frequently used options, see @ref CommandLine "here" for a complete list.
|
||||
///
|
||||
/// @verbinclude start2
|
||||
///
|
||||
/// @section StartStopDebug Starting the Debug Shell
|
||||
///
|
||||
/// The following command starts a debug shell. See below for a list of
|
||||
/// frequently used options, see @ref CommandLine "here" for a complete list.
|
||||
///
|
||||
/// @verbinclude start1
|
||||
///
|
||||
/// @section StartStopOptions Frequently Used Options
|
||||
///
|
||||
/// The following command-line options are frequently used. For a full
|
||||
/// list of options see @ref CommandLine "here".
|
||||
///
|
||||
/// @CMDOPT{@CA{database-directory}}
|
||||
///
|
||||
/// Uses the @CA{database-directory} as base directory. There is an alternative
|
||||
/// version available for use in configuration files, see @ref
|
||||
/// CommandLineAvocado "here".
|
||||
///
|
||||
/// @copydetails triagens::rest::ApplicationServerImpl::options
|
||||
///
|
||||
/// @CMDOPT{--log @CA{level}}
|
||||
///
|
||||
/// Allows the user to choose the level of information which is logged by the
|
||||
/// server. The @CA{level} is specified as a string and can be one of the
|
||||
/// following values: fatal, error, warning, info, debug, trace. For more
|
||||
/// information see @ref CommandLineLogging "here".
|
||||
///
|
||||
/// @copydetails triagens::avocado::AvocadoServer::_httpPort
|
||||
///
|
||||
/// @CMDOPT{--shell}
|
||||
///
|
||||
/// Opens a debug shell instead of starting the HTTP server.
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page DBAdminTOC
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>@ref DBAdminDurability
|
||||
/// </li>
|
||||
/// <li>@ref DBAdminIndex
|
||||
/// <ol>
|
||||
/// <li>@ref DBAdminIndexGeo
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page DBAdmin Database Administration
|
||||
///
|
||||
/// <hr>
|
||||
/// @copydetails DBAdminTOC
|
||||
/// <hr>
|
||||
///
|
||||
/// @section DBAdminDurability Durability
|
||||
///
|
||||
/// @subsection DBAdminDurability1 Mostly Memory/Durability
|
||||
///
|
||||
/// Database documents are stored in the memory-memory-mapped files are used to
|
||||
/// store them. The operating system has the advantageous option to decide
|
||||
/// swapping sparsely used areas out of the main memory. Per default, these
|
||||
/// memory-mapped files are synced frequently - advantageously storing all
|
||||
/// documents securely at once (durability).
|
||||
///
|
||||
/// @subsection DBAdminDurability2 AppendOnly/MVCC
|
||||
///
|
||||
/// Instead of overwriting existing documents, a completely new version of the
|
||||
/// document is generated. The two benefits are:
|
||||
///
|
||||
/// - Objects can be stored coherently and compactly in the main memory.
|
||||
/// - Objects are preserved-isolated writing and reading transactions allow
|
||||
/// accessing these objects for parallel operations.
|
||||
///
|
||||
/// The system collects obsolete versions as garbage, recognizing them as
|
||||
/// forsaken. Garbage collection is asynchronous and runs parallel to other
|
||||
/// processes.
|
||||
///
|
||||
/// @subsection DBAdminDurability3 Configuration
|
||||
///
|
||||
/// @copydetails JS_ParameterVocbaseCol
|
||||
///
|
||||
/// @section DBAdminIndex Index Management
|
||||
///
|
||||
/// @subsection DBAdminIndexHash Hash Indexes
|
||||
///
|
||||
/// @copydetails JS_EnsureHashIndexVocbaseCol
|
||||
///
|
||||
/// @subsection DBAdminIndexGeo Geo Indexes
|
||||
///
|
||||
/// @copydetails JS_EnsureGeoIndexVocbaseCol
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- INSTALLATION MANUAL
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page InstallManual AvocadoDB Installation Manual
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>@ref Installing
|
||||
/// <li>
|
||||
/// <li>@ref Compiling
|
||||
/// </li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- REFERENCE MANUAL
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page RefManual AvocadoDB Reference Manual
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>@ref JSModules
|
||||
/// <ol>
|
||||
/// <li>@ref JSModuleActions
|
||||
/// </li>
|
||||
/// <li>@ref JSModuleConsole
|
||||
/// </li>
|
||||
/// <li>@ref JSModuleFs
|
||||
/// </li>
|
||||
/// <li>@ref JSModuleGraph
|
||||
/// </li>
|
||||
/// <li>@ref JSModuleInternal
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// <li>@ref CommandLine
|
||||
/// <ol>
|
||||
/// <li>@ref CommandLineAvocado
|
||||
/// </li>
|
||||
/// <li>@ref CommandLineScheduler
|
||||
/// </li>
|
||||
/// <li>@ref CommandLineLogging
|
||||
/// </li>
|
||||
/// <li>@ref CommandLineRandom
|
||||
/// </li>
|
||||
/// </ol>
|
||||
/// </li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page CommandLineTOC
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>configuration</li>
|
||||
/// <li>daemon</li>
|
||||
/// <li>gid</li>
|
||||
/// <li>help</li>
|
||||
/// <li>pid-file</li>
|
||||
/// <li>uid</li>
|
||||
/// <li>version</li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page CommandLine Command-Line Options
|
||||
///
|
||||
/// <hr>
|
||||
/// @copydoc CommandLineTOC
|
||||
/// <hr>
|
||||
///
|
||||
/// @section GeneralOptions General Options
|
||||
///
|
||||
/// @copydetails triagens::rest::ApplicationServerImpl::initFile
|
||||
///
|
||||
/// @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.
|
||||
///
|
||||
/// @copydetails triagens::rest::ApplicationServerImpl::gid
|
||||
///
|
||||
/// @copydetails triagens::rest::ApplicationServerImpl::options
|
||||
///
|
||||
/// @copydetails triagens::rest::AnyServer::_pidFile
|
||||
///
|
||||
/// @CMDOPT{--show-io-backends}
|
||||
///
|
||||
/// If this option is specified, then the server will list available backends
|
||||
/// and exit. This option is useful only when used in conjunction with the
|
||||
/// option scheduler.backend. An integer is returned (which is platform
|
||||
/// dependent) which indicates available backends on your platform. See libev
|
||||
/// for further details and for the meaning of the integer returned. This
|
||||
/// describes the allowed integers for @CODE{scheduler.backend}, see
|
||||
/// @ref CommandLineScheduler "here" for details.
|
||||
///
|
||||
/// @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.
|
||||
///
|
||||
/// @copydetails triagens::rest::ApplicationServerImpl::uid
|
||||
///
|
||||
/// @copydetails triagens::rest::ApplicationServerImpl::version
|
||||
///
|
||||
/// <hr>
|
||||
/// Next steps:
|
||||
///
|
||||
/// - @ref CommandLineAvocado "Command-Line Options for the AvocadoDB"
|
||||
/// - @ref CommandLineScheduler "Command-Line Options for Communication"
|
||||
/// - @ref CommandLineLogging "Command-Line Options for Logging"
|
||||
/// - @ref CommandLineRandom "Command-Line Options for Random Numbers"
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page CommandLineAvocadoTOC
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>database.directory</li>
|
||||
/// <li>server.admin-port</li>
|
||||
/// <li>server.http-port</li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page CommandLineAvocado Command-Line Options for the AvocadoDB
|
||||
///
|
||||
/// <hr>
|
||||
/// @copydoc CommandLineAvocadoTOC
|
||||
/// <hr>
|
||||
///
|
||||
/// @copydetails triagens::avocado::AvocadoServer::_databasePath
|
||||
///
|
||||
/// @copydetails triagens::avocado::AvocadoServer::_adminPort
|
||||
///
|
||||
/// @copydetails triagens::avocado::AvocadoServer::_httpPort
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- public functions
|
||||
// -----------------------------------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
///
|
||||
/// DISCLAIMER
|
||||
///
|
||||
/// Copyright 2004-2012 triagens GmbH, Cologne, Germany
|
||||
/// Copyright 2012 triagens GmbH, Cologne, Germany
|
||||
///
|
||||
/// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
/// you may not use this file except in compliance with the License.
|
||||
|
|
@ -25,6 +25,17 @@
|
|||
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page InstallManual AvocadoDB Installation Manual
|
||||
///
|
||||
/// <ol>
|
||||
/// <li>@ref Installing
|
||||
/// <li>
|
||||
/// <li>@ref Compiling
|
||||
/// </li>
|
||||
/// </ol>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page InstallingTOC
|
||||
///
|
||||
|
|
@ -290,6 +301,7 @@
|
|||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// Local Variables:
|
||||
// mode: c++
|
||||
// mode: outline-minor
|
||||
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
|
||||
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
||||
// End:
|
||||
|
|
|
|||
Loading…
Reference in New Issue