mirror of https://gitee.com/bigwinds/arangodb
cleanup documentation
This commit is contained in:
Frank Celler
parent
9acaf19faa
commit
c0774bb892
|
|
@ -11,6 +11,6 @@ fi
|
|||
HEADER='<html><head><title>ArangoDB Manual</title> <style media="screen" type="text/css" style="display:none">body{background-color:white;font:13px Helvetica,arial,freesans,clean,sans-serif;line-height:1.4;color:#333;}#access{font-size:16px;margin-left:12px;display:block;margin-left:10px;margin-right:10px;background-color:#F3F1EE!important;}#access a{border-right:1px solid #DBDEDF;color:#A49F96;display:block;line-height:38px;padding:0 10px;text-decoration:none;}#navigation ul{text-transform:uppercase;list-style:none;margin:0;}#navigation li{float:left;position:relative;}#container{width:920px;margin:0 auto;}a{color:#4183C4;text-decoration:none;}.contents h2{font-size:24px;border-bottom:1px solid #CCC;color:black;}.contents h1{font-size:33px;border-bottom:1px solid #CCC;color:black;}.clearfix:after{content:".";display:block;clear:both;font-size:0;height:0;visibility:hidden;}/**/ *:first-child+html .clearfix{min-height:0;}/**/ * html .clearfix{height:1%;}</style></head><body><div id="container"><img src="images/logo_arangodb.png" width="397" height="67" alt="ArangoDB"><div id="access" role="navigation"><div id="navigation"><ul id="menu-ahome" class="menu"><li><a href="Home.html">Table of contents</a></li> <li><a href="http://www.arangodb.org">ArangoDB homepage</a></li></ul></div><div class="clearfix"></div></div><div>'
|
||||
FOOTER='</div></body></html>'
|
||||
|
||||
sed -e "s~<?php include \"include/header.php\" ?> ~${HEADER}~" $INPUT \
|
||||
| sed -e "s~<?php include \"include/footer.php\" ?> ~${FOOTER}~" \
|
||||
sed -e "s~<?php include \"../include/header.php\" ?> ~${HEADER}~" $INPUT \
|
||||
| sed -e "s~<?php include \"../include/footer.php\" ?> ~${FOOTER}~" \
|
||||
| sed -e "s~<div class=\"title\">\\([^<]*\\)</div>~<h1>\\1</h1>~" > $OUTPUT
|
||||
|
|
|
|||
|
|
@ -217,6 +217,7 @@ 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 += EXTRES{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=" "
|
||||
|
||||
|
|
|
|||
|
|
@ -217,8 +217,10 @@ 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 += EXTRES{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=" "
|
||||
ALIASES += CLEARPAGE="@if LATEX @latexonly\clearpage@endlatexonly@endif"
|
||||
|
||||
# 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.
|
||||
|
|
|
|||
|
|
@ -217,8 +217,10 @@ 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 += EXTRES{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=" "
|
||||
ALIASES += CLEARPAGE="@if LATEX @latexonly\clearpage@endlatexonly@endif"
|
||||
|
||||
# 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.
|
||||
|
|
|
|||
|
|
@ -217,8 +217,10 @@ 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 += EXTRES{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=" "
|
||||
ALIASES += CLEARPAGE="@if LATEX @latexonly\clearpage@endlatexonly@endif"
|
||||
|
||||
# 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.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,18 @@
|
|||
\input{header.tex}
|
||||
\begin{center}
|
||||
{\Large ArangoDB's Importer Manual }\\
|
||||
\vspace*{1cm}
|
||||
{\large The ArangoDB Team}\\
|
||||
\vspace*{0.5cm}
|
||||
\input{version}
|
||||
{\small Version \arangodbversion}\\
|
||||
\end{center}
|
||||
\end{titlepage}
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{roman}
|
||||
\tableofcontents
|
||||
\clearemptydoublepage
|
||||
\pagenumbering{arabic}
|
||||
\input{ImpManual.inc}
|
||||
\printindex
|
||||
\end{document}
|
||||
|
|
@ -80,8 +80,9 @@
|
|||
/// @GE{Collection Name}: A collection name identifies a collection in a
|
||||
/// database. It is an string and is unique within the database. Unlike the
|
||||
/// collection identifier it is supplied by the creator of the collection. The
|
||||
/// collection name can consist of letters, digits and the characters @LIT{_} and
|
||||
/// @LIT{-}. However, the first character must be a letter.
|
||||
/// collection name can consist of letters, digits and the characters @LIT{_}
|
||||
/// (underscore) and @LIT{-} (dash). However, the first character must be a
|
||||
/// letter.
|
||||
///
|
||||
/// @page GlossaryDocument
|
||||
//////////////////////////
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@
|
|||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page Home ArangoDB
|
||||
/// @page Home ArangoDB @VERSION
|
||||
///
|
||||
/// My colleagues and I started developing a document-store, which focuses on
|
||||
/// durability of the data taking advantage of new technologies like SSD,
|
||||
|
|
@ -40,13 +40,12 @@
|
|||
/// @xmlonly The HTML and PDF versions of the manual can be found <ulink url="http://www.arangodb.org/manuals">here</ulink>. @endxmlonly
|
||||
///
|
||||
/// @warning
|
||||
/// ArangoDB is currently pre-alpha. We want to have a version 1 ready by end
|
||||
/// of May 2012, a multi server version is planned for the third quarter of
|
||||
/// 2012. The document is still far from complete. Please contact
|
||||
/// <a href="http://www.arangodb.org/connect">us</a>, if you have any questions.
|
||||
/// The documentation is still far from complete. Please contact <a
|
||||
/// href="http://www.arangodb.org/connect">us</a>, if you have any
|
||||
/// questions.
|
||||
///
|
||||
/// @section ArangoDBUserManual ArgangoDB's User Manuals (Version @VERSION)
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
/// @section ArangoDBUserManual ArgangoDB's User Manuals
|
||||
////////////////////////////////////////////////////////
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref UserManual @ifnot XML @SPC(<a href="user-manual.pdf">pdf</a>) @endif</li>
|
||||
|
|
@ -56,16 +55,16 @@
|
|||
/// @ifnot XML <li><a href="arangodb_1.0_shell_reference_card.pdf">Cheat Sheet</a></li> @endif
|
||||
/// </ul>
|
||||
///
|
||||
/// @section ArangoDBAdminManual ArangoDB's Administrator Manuals (Version @VERSION)
|
||||
////////////////////////////////////////////////////////////////////////////////////
|
||||
/// @section ArangoDBAdminManual ArangoDB's Administrator Manuals
|
||||
/////////////////////////////////////////////////////////////////
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref InstallManual @ifnot XML @SPC(<a href="install-manual.pdf">pdf</a>) @endif</li>
|
||||
/// <li>@ref Glossary</li>
|
||||
/// </ul>
|
||||
///
|
||||
/// @section ArangoDBAPIManual ArangoDB's Developer Manuals (Version @VERSION)
|
||||
//////////////////////////////////////////////////////////////////////////////
|
||||
/// @section ArangoDBAPIManual ArangoDB's Developer Manuals
|
||||
///////////////////////////////////////////////////////////
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref ImplementorManual @ifnot XML @SPC(<a href="implementor-manual.pdf">pdf</a>) @endif</li>
|
||||
|
|
|
|||
|
|
@ -25,6 +25,10 @@
|
|||
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- INSTALLATION MANUAL
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page InstallManual ArangoDB's Installation Manual
|
||||
///
|
||||
|
|
@ -45,18 +49,18 @@
|
|||
/// <ul>
|
||||
/// <li>@ref Installing
|
||||
/// <ul>
|
||||
/// <li>@ref BinaryPackages
|
||||
/// <li>@ref InstallingLinux
|
||||
/// </li>
|
||||
/// <li>@ref PackagesManager
|
||||
/// <li>@ref InstallingLinuxPackageManager
|
||||
/// <ul>
|
||||
/// <li>@ref OpenSUSE
|
||||
/// <li>@ref CentOS
|
||||
/// <li>@ref Debian
|
||||
/// <li>@ref InstallingCentOS
|
||||
/// <li>@ref InstallingDebian
|
||||
/// <li>@ref InstallingOpenSUSE
|
||||
/// </ul>
|
||||
/// </li>
|
||||
/// <li>@ref MacOSX
|
||||
/// <li>@ref InstallingMacOSX
|
||||
/// <ul>
|
||||
/// <li>@ref MacOSXHomebrew
|
||||
/// <li>@ref InstallingMacOSXHomebrew
|
||||
/// </ul>
|
||||
/// </li>
|
||||
/// </ul>
|
||||
|
|
@ -65,50 +69,23 @@
|
|||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page Installing Installing the ArangoDB
|
||||
/// @page Installing Installing ArangoDB
|
||||
///
|
||||
/// @EMBEDTOC{InstallingTOC}
|
||||
///
|
||||
/// @section BinaryPackages Binary Packages
|
||||
///////////////////////////////////////////
|
||||
/// @section InstallingLinux Linux
|
||||
//////////////////////////////////
|
||||
///
|
||||
/// You can find various binary packages here:
|
||||
/// You can find binary packages for various Linux distributions here:
|
||||
///
|
||||
/// @LIT{http://www.arangodb.org/repositories/}
|
||||
///
|
||||
///
|
||||
/// @section PackagesManager Install ArangoDB by a package manager
|
||||
//////////////////////////////////////////////////////////////////
|
||||
/// @subsection InstallingLinuxPackageManager Using a Package Manager to install ArangoDB
|
||||
/////////////////////////////////////////////////////////////////////////////////////////
|
||||
///
|
||||
/// @subsection OpenSUSE
|
||||
////////////////////////
|
||||
///
|
||||
/// Add the repository as follows:
|
||||
///
|
||||
/// @code
|
||||
/// zypper addrepo -f -t YUM http://www.arangodb.org/repositories/openSUSE-12.1 ArangoDB
|
||||
/// @endcode
|
||||
///
|
||||
/// Update repository data:
|
||||
///
|
||||
/// @code
|
||||
/// zypper refresh
|
||||
/// @endcode
|
||||
///
|
||||
/// Search for arangodb:
|
||||
///
|
||||
/// @code
|
||||
/// zypper search arangodb
|
||||
/// @endcode
|
||||
///
|
||||
/// Install arangodb:
|
||||
///
|
||||
/// @code
|
||||
/// zypper install arangodb
|
||||
/// @endcode
|
||||
///
|
||||
/// @subsection CentOS
|
||||
//////////////////////
|
||||
/// @subsubsection InstallingCentOS CentoOS
|
||||
///////////////////////////////////////////
|
||||
///
|
||||
/// Download and import GPG-PublicKey
|
||||
///
|
||||
|
|
@ -147,9 +124,8 @@
|
|||
/// yum install arangodb
|
||||
/// @endcode
|
||||
///
|
||||
///
|
||||
/// @subsection Debian Debian and Ubuntu
|
||||
////////////////////////////////////////
|
||||
/// @subsubsection InstallingDebian Debian, Linux-Mint, and Ubuntu
|
||||
//////////////////////////////////////////////////////////////////
|
||||
///
|
||||
/// Download and import GPG-PublicKey
|
||||
///
|
||||
|
|
@ -158,45 +134,83 @@
|
|||
/// apt-key add RPM-GPG-KEY-www.arangodb.org
|
||||
/// @endcode
|
||||
///
|
||||
/// Add the repository in file @LIT{/etc/apt/sources.list}
|
||||
/// Add the corresponding repository in file @LIT{/etc/apt/sources.list}:
|
||||
/// @code
|
||||
/// deb http://www.arangodb.org/repositories Debian-6.0 main
|
||||
/// @endcode
|
||||
/// or
|
||||
/// @code
|
||||
/// deb http://www.arangodb.org/repositories LinuxMint-13 main
|
||||
/// @endcode
|
||||
/// or
|
||||
/// @code
|
||||
/// deb http://www.arangodb.org/repositories Ubuntu-11.10 main
|
||||
/// @endcode
|
||||
///
|
||||
/// Update repository data:
|
||||
/// Update the repository data:
|
||||
///
|
||||
/// @code
|
||||
/// aptitude update
|
||||
/// @endcode
|
||||
///
|
||||
/// Search for arangodb:
|
||||
/// Now you should be able to search for arangodb:
|
||||
///
|
||||
/// @code
|
||||
/// aptitude search arangodb
|
||||
/// @endcode
|
||||
///
|
||||
/// Install arangodb:
|
||||
/// In order to install arangodb:
|
||||
///
|
||||
/// @code
|
||||
/// aptitude install arangodb
|
||||
/// @endcode
|
||||
///
|
||||
/// @section MacOSX
|
||||
///////////////////
|
||||
/// @subsubsection Gentoo
|
||||
/////////////////////////
|
||||
///
|
||||
/// You can find MacOSX packages here:
|
||||
/// Please use the
|
||||
/// @EXTRES{https://github.com/mgiken/portage-overlay/tree/master/dev-db/ArangoDB,portage}
|
||||
/// provided by @@mgiken.
|
||||
///
|
||||
/// @subsubsection InstallingOpenSUSE OpenSuSE
|
||||
//////////////////////////////////////////////
|
||||
///
|
||||
/// Add the repository as follows:
|
||||
///
|
||||
/// @code
|
||||
/// zypper addrepo -f -t YUM http://www.arangodb.org/repositories/openSUSE-12.1 ArangoDB
|
||||
/// @endcode
|
||||
///
|
||||
/// Update repository data:
|
||||
///
|
||||
/// @code
|
||||
/// zypper refresh
|
||||
/// @endcode
|
||||
///
|
||||
/// Search for arangodb:
|
||||
///
|
||||
/// @code
|
||||
/// zypper search arangodb
|
||||
/// @endcode
|
||||
///
|
||||
/// Install arangodb:
|
||||
///
|
||||
/// @code
|
||||
/// zypper install arangodb
|
||||
/// @endcode
|
||||
///
|
||||
/// @section InstallingMacOSX Mac OS X
|
||||
//////////////////////////////////////
|
||||
///
|
||||
/// You can find the MacOSX packages here:
|
||||
///
|
||||
/// @LIT{http://www.arangodb.org/repositories/MacOSX}
|
||||
///
|
||||
/// @subsection MacOSXHomebrew
|
||||
//////////////////////////////
|
||||
/// @subsection InstallingMacOSXHomebrew Homebrew
|
||||
/////////////////////////////////////////////////
|
||||
///
|
||||
/// If you are using <a href="http://mxcl.github.com/homebrew/">homebrew</a>,
|
||||
/// than you can install the ArangoDB using @CODE{brew} as follows:
|
||||
/// then you can install the ArangoDB using @CODE{brew} as follows:
|
||||
///
|
||||
/// @code
|
||||
/// brew install arangodb
|
||||
|
|
@ -212,6 +226,10 @@
|
|||
/// @endcode
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- COMPILING
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page CompilingTOC
|
||||
///
|
||||
|
|
@ -253,7 +271,7 @@
|
|||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page Compiling Compiling the ArangoDB from scratch
|
||||
/// @page Compiling Compiling ArangoDB from scratch
|
||||
///
|
||||
/// The following sections describe how to compile and build the ArangoDB from
|
||||
/// scratch. The ArangoDB will compile on most Linux and Mac OS X systems. It
|
||||
|
|
@ -355,7 +373,7 @@
|
|||
/// This will start up the ArangoDB and listen for HTTP requests on port 12345
|
||||
/// bound to any address. You should see the startup messages
|
||||
///
|
||||
/// @verbinclude startup1
|
||||
/// @TINYEXAMPLE{startup1,startup message}
|
||||
///
|
||||
/// Use your favorite browser to access the URL
|
||||
///
|
||||
|
|
@ -363,11 +381,11 @@
|
|||
///
|
||||
/// This should produce a JSON object like
|
||||
///
|
||||
/// @LIT{\{"server":"arango"\,"version":"0.0.8 [exported]"\}}
|
||||
/// @LIT{\{"server":"arango"\,"version":"1.x.y"\}}
|
||||
///
|
||||
/// as result.
|
||||
///
|
||||
/// Note that starting arangodb in this way will result in error messages being
|
||||
/// Note that starting ArangoDB in this way will result in error messages being
|
||||
/// displayed, because the paths are not yet set up. This will be corrected in
|
||||
/// the next step.
|
||||
///
|
||||
|
|
@ -478,6 +496,10 @@
|
|||
/// Now continue with @ref CompilingAIOCompile.
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- END-OF-FILE
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// Local Variables:
|
||||
// mode: c++
|
||||
// mode: outline-minor
|
||||
|
|
|
|||
|
|
@ -124,9 +124,10 @@
|
|||
/// @LIT{db.@FA{collection-name}}
|
||||
///
|
||||
/// This call will either return the collection named @FA{collection-name}
|
||||
/// or create a new one which that name and a set of default
|
||||
/// or create a new one with that name and a set of default
|
||||
/// properties.
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @section ShellCollectionShell Working with Collections
|
||||
//////////////////////////////////////////////////////////
|
||||
///
|
||||
|
|
@ -136,42 +137,54 @@
|
|||
/// @anchor ShellCollectionDrop
|
||||
/// @copydetails JS_DropVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionTruncate
|
||||
/// @copydetails JSF_ArangoCollection_prototype_truncate
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionProperties
|
||||
/// @copydetails JS_PropertiesVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionFigures
|
||||
/// @copydetails JS_FiguresVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionLoad
|
||||
/// @copydetails JS_LoadVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionUnload
|
||||
/// @copydetails JS_UnloadVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionRename
|
||||
/// @copydetails JS_RenameVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @subsection ShellCollectionDatabaseMethods Database Methods
|
||||
///////////////////////////////////////////////////////////////
|
||||
///
|
||||
/// @anchor ShellCollectionRead
|
||||
/// @copydetails JS_CollectionVocBase
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionCreate
|
||||
/// @copydetails JS_CreateVocBase
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionReadAll
|
||||
/// @copydetails JS_CollectionsVocBase
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionReadShortCut
|
||||
/// @copydetails MapGetVocBase
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionDropDb
|
||||
/// @copydetails JSF_ArangoDatabase_prototype__drop
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellCollectionTruncateDb
|
||||
/// @copydetails JSF_ArangoDatabase_prototype__truncate
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
|
|
|||
|
|
@ -25,6 +25,10 @@
|
|||
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- HANDLING DOCUMENTS
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page ShellDocumentTOC
|
||||
///
|
||||
|
|
@ -119,6 +123,7 @@
|
|||
/// Each document also has a document revision or etag with is returned
|
||||
/// in the @LIT{_rev} field when requesting a document.
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @section ShellDocumentShell Working with Documents
|
||||
//////////////////////////////////////////////////////
|
||||
///
|
||||
|
|
@ -128,28 +133,38 @@
|
|||
/// @anchor ShellDocumentRead
|
||||
/// @copydetails JS_DocumentVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellDocumentCreate
|
||||
/// @copydetails JS_SaveVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellDocumentUpdate
|
||||
/// @copydetails JS_ReplaceVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellDocumentDelete
|
||||
/// @copydetails JS_RemoveVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @subsection ShellDocumentDatabaseMethods Database Methods
|
||||
/////////////////////////////////////////////////////////////
|
||||
///
|
||||
/// @anchor ShellDocumentDbRead
|
||||
/// @copydetails JS_DocumentVocbase
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellDocumentDbUpdate
|
||||
/// @copydetails JS_ReplaceVocbase
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellDocumentDbDelete
|
||||
/// @copydetails JS_RemoveVocbase
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- END-OF-FILE
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// Local Variables:
|
||||
// mode: c++
|
||||
// mode: outline-minor
|
||||
|
|
|
|||
|
|
@ -25,6 +25,10 @@
|
|||
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- HANDLING EDGES
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page ShellEdgeTOC
|
||||
///
|
||||
|
|
@ -67,22 +71,30 @@
|
|||
///
|
||||
/// @copydoc GlossaryEdgeCollection
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @section ShellEdgeShell Working with Edges
|
||||
//////////////////////////////////////////////
|
||||
///
|
||||
/// @anchor ShellEdgeCreate
|
||||
/// @copydetails JS_SaveEdgesCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellEdgeEdges
|
||||
/// @copydetails JS_EdgesQuery
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellEdgeInEdges
|
||||
/// @copydetails JS_InEdgesQuery
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor ShellEdgeOutEdges
|
||||
/// @copydetails JS_OutEdgesQuery
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- END-OF-FILE
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// Local Variables:
|
||||
// mode: c++
|
||||
// mode: outline-minor
|
||||
|
|
|
|||
|
|
@ -25,6 +25,10 @@
|
|||
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- SIMPLE QUERIES
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page SimpleQueriesTOC
|
||||
///
|
||||
|
|
@ -83,27 +87,34 @@
|
|||
///
|
||||
/// @EMBEDTOC{ SimpleQueriesTOC}
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @section SimpleQueriesQueries Queries
|
||||
/////////////////////////////////////////
|
||||
///
|
||||
/// @anchor SimpleQueryAll
|
||||
/// @copydetails JSF_ArangoCollection_prototype_all
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryByExample
|
||||
/// @copydetails JSF_ArangoCollection_prototype_byExample
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryFirstExample
|
||||
/// @copydetails JSF_ArangoCollection_prototype_firstExample
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryRange
|
||||
/// @copydetails JSF_ArangoCollection_prototype_range
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryCollectionCount
|
||||
/// @copydetails JS_CountVocbaseCol
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryToArray
|
||||
/// @copydetails JSF_ArangoCollection_prototype_toArray
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @section SimpleQueriesGeoQueries Geo Queries
|
||||
////////////////////////////////////////////////
|
||||
///
|
||||
|
|
@ -123,15 +134,19 @@
|
|||
/// this case you must give a hint using the @FN{geo} operator which of indexes
|
||||
/// should be used in a query.
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryNear
|
||||
/// @copydetails JSF_ArangoCollection_prototype_near
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryWithin
|
||||
/// @copydetails JSF_ArangoCollection_prototype_within
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryGeo
|
||||
/// @copydetails JSF_ArangoCollection_prototype_geo
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @section SimpleQueriesPagination Pagination
|
||||
///////////////////////////////////////////////
|
||||
///
|
||||
|
|
@ -148,28 +163,38 @@
|
|||
/// This result should be sorted, so that the pagination works in a predicable
|
||||
/// way.
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryLimit
|
||||
/// @copydetails JSF_SimpleQuery_prototype_limit
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQuerySkip
|
||||
/// @copydetails JSF_SimpleQuery_prototype_skip
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @section SimpleQueriesCursor Sequential Access and Cursors
|
||||
//////////////////////////////////////////////////////////////
|
||||
///
|
||||
/// @anchor SimpleQueryHasNext
|
||||
/// @copydetails JSF_SimpleQuery_prototype_hasNext
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryNext
|
||||
/// @copydetails JSF_SimpleQuery_prototype_next
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryDispose
|
||||
/// @copydetails JSF_SimpleQuery_prototype_dispose
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @anchor SimpleQueryCount
|
||||
/// @copydetails JSF_SimpleQuery_prototype_count
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// --SECTION-- END-OF-FILE
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// Local Variables:
|
||||
// mode: outline-minor
|
||||
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
||||
|
|
|
|||
|
|
@ -119,11 +119,11 @@
|
|||
/// For more in-depth information
|
||||
///
|
||||
/// <ul>
|
||||
/// <li> read more on the@SPC@EXTREF{http://www.arangodb.org/2012/03/07/avocadodbs-design-objectives,design goals of ArangoDB}</li>
|
||||
/// <li> read more on the @EXTRES{http://www.arangodb.org/2012/03/07/avocadodbs-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@SPC@INTREF{InstallManual,try}.</li>
|
||||
/// <li> or give it a @EXTRES{http://www.arangodb.org/try,try}.</li>
|
||||
/// </ul>
|
||||
///
|
||||
/// The ArangoDB database groups documents into collections. Collections and
|
||||
|
|
@ -294,6 +294,7 @@
|
|||
/// { _id : "2223655/3993127", _rev : 3993127, name : "three" }]
|
||||
/// @endcode
|
||||
///
|
||||
/// @CLEARPAGE
|
||||
/// @FUN{start_pretty_print()}
|
||||
///
|
||||
/// While the standard JSON stringifier is very concise it is hard to read.
|
||||
|
|
@ -328,7 +329,8 @@
|
|||
/// ]
|
||||
/// @endcode
|
||||
///
|
||||
/// @FUN{start_pretty_print()}
|
||||
/// @CLEARPAGE
|
||||
/// @FUN{stop_pretty_print()}
|
||||
///
|
||||
/// The functions disable the pretty printer, switching back to the standard
|
||||
/// JSON output format.
|
||||
|
|
|
|||
Loading…
Reference in New Issue