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

391 lines
15 KiB
HTML
Raw Blame History

<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>
<!-- Generated by Doxygen 1.7.5.1 -->
</div>
<div class="header">
<div class="headertitle">
<h1>ArangoDB's User Manual (1.0.0) </h1> </div>
</div>
<div class="contents">
<div class="textblock"><ul>
<li>
<a class="el" href="UserManualBasics.html">About ArangoDB</a> <ul>
<li>
<a class="el" href="UserManualBasics.html#UserManualServerStartStop">Starting the ArangoDB Server</a> <ul>
<li>
<a class="el" href="UserManualBasics.html#UserManualServerStartStopOptions">Frequently Used Options</a> </li>
</ul>
</li>
<li>
<a class="el" href="UserManualBasics.html#UserManualServerFE">ArangoDB's Front-End</a> </li>
<li>
<a class="el" href="UserManualBasics.html#UserManualShellStartStop">Starting the ArangoDB Shell</a> <ul>
<li>
<a class="el" href="UserManualBasics.html#UserManualShellStartStopOptions">Command-Line Options</a> </li>
</ul>
</li>
<li>
<a class="el" href="UserManualBasics.html#UserManualServerStartStopDebug">Starting the ArangoDB Emergency Console</a> </li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="FirstStepsArangoDB.html">First Steps with ArangoDB</a> <ul>
<li>
<a class="el" href="FirstStepsArangoDB.html#FirstStepsArangoDBServerStart">Starting the ArangoDB server</a> </li>
<li>
<a class="el" href="FirstStepsArangoDB.html#FirstStepsArangoDBFirstSteps">First Steps using arangosh</a> </li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="UserManualArangosh.html">The Arango Shell</a> </li>
</ul>
<ul>
<li>
<a class="el" href="ShellCollection.html">Handling Collections</a> <ul>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionIntro">Collections</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionResource">Address of a Collection</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionShell">Working with Collections</a> <ul>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionCollectionMethods">Collection Methods</a> <ul>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionDrop">collection.drop</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionTruncate">collection.truncate</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionProperties">collection.properties</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionFigures">collection.figures</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionLoad">collection.load</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionUnload">collection.unload</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionUnload">collection.rename</a> </li>
</ul>
</li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionDatabaseMethods">Database Methods</a> <ul>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionRead">db._collection</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionCreate">db._create</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionReadAll">db._collections</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionReadShortCut">db.collection-name</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionDropDb">db._drop</a> </li>
<li>
<a class="el" href="ShellCollection.html#ShellCollectionTruncateDb">db._truncate</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="ShellDocument.html">Handling Documents</a> <ul>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentIntro">Documents, Identifiers, Handles</a> </li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentResource">Address and ETag of an Document</a> </li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentShell">Working with Documents</a> <ul>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentCollectionMethods">Collection Methods</a> <ul>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentRead">collection.document</a> </li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentCreate">collection.save</a> </li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentUpdate">collection.replace</a> </li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentDelete">collection.remove</a> </li>
</ul>
</li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentDatabaseMethods">Database Methods</a> <ul>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentDbRead">db._document</a> </li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentDbUpdate">db._replace</a> </li>
<li>
<a class="el" href="ShellDocument.html#ShellDocumentDbDelete">db._remove</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="ShellEdge.html">Handling Edges</a> <ul>
<li>
<a class="el" href="ShellEdge.html#ShellEdgeIntro">Edges, Identifiers, Handles</a> </li>
<li>
<a class="el" href="ShellEdge.html#ShellEdgeShell">Working with Edges</a> <ul>
<li>
<a class="el" href="ShellEdge.html#ShellEdgeCreate">edge-collection.save</a> </li>
<li>
<a class="el" href="ShellEdge.html#ShellEdgeEdges">edge-collection.edges</a> </li>
<li>
<a class="el" href="ShellEdge.html#ShellEdgeInEdges">edge-collection.inEdges</a> </li>
<li>
<a class="el" href="ShellEdge.html#ShellEdgeOutEdges">edge-collection.outEdges</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="SimpleQueries.html">Simple Queries</a> <ul>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueriesQueries">Queries</a> <ul>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryAll">collection.all</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryByExample">collection.byExample</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryFirstExample">collection.firstExample</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryRange">collection.range</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryCollectionCount">collection.count</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryToArray">collection.toArray</a> </li>
</ul>
</li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueriesGeoQueries">Geo Queries</a> <ul>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryNear">collection.near</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryWithin">collection.within</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryGeo">collection.geo</a> </li>
</ul>
</li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueriesPagination">Pagination</a> <ul>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryLimit">query.limit</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQuerySkip">query.skip</a> </li>
</ul>
</li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueriesCursor">Sequential Access and Cursors</a> <ul>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryHasNext">query.hasNext</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryNext">query.next</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQuerySetBatchSize">query.setBatchSize</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryGetBatchSize">query.getBatchSize</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryExecute">query.execute</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryDispose">query.dispose</a> </li>
<li>
<a class="el" href="SimpleQueries.html#SimpleQueryCount">query.count</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="Aql.html">ArangoDB Query Language (AQL)</a> <ul>
<li>
<a class="el" href="Aql.html#AqlPurpose">Introduction</a> </li>
<li>
<a class="el" href="Aql.html#AqlHowToUse">How to invoke AQL</a> </li>
<li>
<a class="el" href="Aql.html#AqlQueryResults">Query results</a> </li>
<li>
<a class="el" href="Aql.html#AqlBasics">Language basics</a> <ul>
<li>
<a class="el" href="Aql.html#AqlWhitespace">Whitespace</a> </li>
<li>
<a class="el" href="Aql.html#AqlComments">Comments</a> </li>
<li>
<a class="el" href="Aql.html#AqlKeywords">Keywords</a> </li>
<li>
<a class="el" href="Aql.html#AqlNames">Names</a> </li>
<li>
<a class="el" href="Aql.html#AqlTypes">Data types</a> </li>
<li>
<a class="el" href="Aql.html#AqlParameter">Bind parameters</a> </li>
<li>
<a class="el" href="Aql.html#AqlTypeOrder">Type and value order</a> </li>
<li>
<a class="el" href="Aql.html#AqlData">Accessing data from collections</a> </li>
<li>
<a class="el" href="Aql.html#AqlOperators">Operators</a> </li>
<li>
<a class="el" href="Aql.html#AqlFunctions">Functions</a> </li>
</ul>
</li>
<li>
<a class="el" href="Aql.html#AqlOperations">High-level operations</a> <ul>
<li>
<a class="el" href="Aql.html#AqlOperationFor">FOR</a> </li>
<li>
<a class="el" href="Aql.html#AqlOperationReturn">RETURN</a> </li>
<li>
<a class="el" href="Aql.html#AqlOperationFilter">FILTER</a> </li>
<li>
<a class="el" href="Aql.html#AqlOperationSort">SORT</a> </li>
<li>
<a class="el" href="Aql.html#AqlOperationLimit">LIMIT</a> </li>
<li>
<a class="el" href="Aql.html#AqlOperationLet">LET</a> </li>
<li>
<a class="el" href="Aql.html#AqlOperationCollect">COLLECT</a> </li>
</ul>
</li>
<li>
<a class="el" href="Aql.html#AqlAdvanced">Advanced features</a> <ul>
<li>
<a class="el" href="Aql.html#AqlSubqueries">Subqueries</a> </li>
<li>
<a class="el" href="Aql.html#AqlExpansion">Variable expansion</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="CommandLine.html">Command-Line Options</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineGeneralOptions">General Options</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineHelp">help</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineVersion">version</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineConfiguration">configuration</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineDaemon">daemon</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineSupervisor">supervisor</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineUid">uid</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineGid">gid</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLinePidFile">pid-file</a> </li>
</ul>
</li>
<li>
<a class="el" href="CommandLine.html#CommandLineArango">Command-Line Options for the ArangoDB</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoEndpoint">server.endpoint</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoDisableAuthentication">server.disable-authentication</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoKeepAliveTimeout">server.keep-alive-timeout</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoKeyFile">server.keyfile</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoCaFile">server.cafile</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoSslProtocol">server.ssl-protocol</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoSslCacheMode">server.ssl-cache</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoSslOptions">server.ssl-options</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoSslCipherList">server.ssl-cipher-list</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoDirectory">database.directory</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoMaximalJournalSize">database.maximal-journal-size</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoWaitForSync">database.wait-for-sync</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoForceSyncShapes">database.force-sync-shapes</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoRemoveOnDrop">database.remove-on-compacted</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoJsGcFrequency">javascript.gc-frequency</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineArangoJsGcInterval">javascript.gc-interval</a> </li>
</ul>
</li>
<li>
<a class="el" href="CommandLine.html#CommandLineLogging">Command-Line Options for Logging</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingGeneral">General Logging Options</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogFile">log.file</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogSeverity">log.severity</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogSyslog">log.syslog</a> </li>
</ul>
</li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingHuman">Human Readable Logging</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogLevel">log.level</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogLineNumber">log.line-number</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogPrefix">log.prefix</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogThread">log.thread</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogFilter">log.filter</a> </li>
</ul>
</li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingMachine">Maschine Readable Logging</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogApplication">log.application</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogFacility">log.facility</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogFormat">log.format</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineLoggingLogHostName">log.hostname</a> </li>
</ul>
</li>
</ul>
</li>
<li>
<a class="el" href="CommandLine.html#CommandLineScheduler">Command-Line Options for Communication</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineSchedulerThreads">scheduler.threads</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineSchedulerBackend">scheduler.backend</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineSchedulerShowIoBackends">show-io-backends</a> </li>
</ul>
</li>
<li>
<a class="el" href="CommandLine.html#CommandLineRandom">Command-Line Options for Random Numbers</a> <ul>
<li>
<a class="el" href="CommandLine.html#CommandLineRandomGenerator">random.generator</a> </li>
<li>
<a class="el" href="CommandLine.html#CommandLineRandomGenerator">random.no-seed</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
</div></div>
</div></body></html>
Reference in New Issue View Git Blame Copy Permalink