1
0
Fork 0
arangodb/Doxygen/doc/DbaManual.html

189 lines
7.5 KiB
HTML

<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 DBA Manual (1.0.0) </h1> </div>
</div>
<div class="contents">
<div class="textblock"><ul>
<li>
<a class="el" href="DbaManualBasics.html">Administrating ArangoDB</a> <ul>
<li>
<a class="el" href="DbaManualBasics.html#DbaManualBasicsDurability">Mostly Memory/Durability</a> </li>
<li>
<a class="el" href="DbaManualBasics.html#DbaManualBasicsMvcc">AppendOnly/MVCC</a> </li>
<li>
<a class="el" href="DbaManualBasics.html#DbaManualBasicsConfig">Configuration</a> <ul>
<li>
<a class="el" href="DbaManualBasics.html#DbaManualBasicsConfigGlobal">Global Configuration</a> </li>
<li>
<a class="el" href="DbaManualBasics.html#DbaManualBasicsConfigCollection">Per Collection Configuration</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="DbaManualAuthentication.html">Authentication and Authorisation</a> <ul>
<li>
<a class="el" href="DbaManualAuthentication.html#DbaManualAuthenticationCommandLine">Command-Line Options for the Authentication and Authorisation</a> </li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="DbaManualDatafileDebugger.html">Datafile Debugger</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="ShellIndex.html">Handling Indexes</a> <ul>
<li>
<a class="el" href="ShellIndex.html#ShellIndexIntro">Indexes, Identifiers, Handles</a> </li>
<li>
<a class="el" href="ShellIndex.html#ShellIndexResource">Address and ETag of an Index</a> </li>
<li>
<a class="el" href="ShellIndex.html#ShellIndexShell">Working with Indexes</a> <ul>
<li>
<a class="el" href="ShellIndex.html#ShellIndexCollectionMethods">Collection Methods</a> <ul>
<li>
<a class="el" href="ShellIndex.html#ShellIndexRead">collection.index</a> </li>
<li>
<a class="el" href="ShellIndex.html#ShellIndexReadAll">collection.getIndexes</a> </li>
<li>
<a class="el" href="ShellIndex.html#ShellIndexDelete">collection.dropIndex</a> </li>
</ul>
</li>
<li>
<a class="el" href="ShellIndex.html#ShellIndexDatabaseMethods">Database Methods</a> <ul>
<li>
<a class="el" href="ShellIndex.html#ShellIndexDbRead">db._index</a> </li>
<li>
<a class="el" href="ShellIndex.html#ShellIndexDbDelete">db._dropIndex</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="IndexCap.html">Cap Constraint</a> <ul>
<li>
<a class="el" href="IndexCap.html#IndexCapIntro">Cap Constraint</a> </li>
<li>
<a class="el" href="IndexCap.html#IndexCapShell">Accessing Cap Constraints from the Shell</a> <ul>
<li>
<a class="el" href="IndexCap.html#IndexCapShellEnsureCapConstraint">collection.ensureCapConstraint</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="IndexGeo.html">Geo Indexes</a> <ul>
<li>
<a class="el" href="IndexGeo.html#IndexGeoIntro">Geo Indexes</a> </li>
<li>
<a class="el" href="IndexGeo.html#IndexGeoShell">Accessing Geo Indexes from the Shell</a> <ul>
<li>
<a class="el" href="IndexGeo.html#IndexGeoShellEnsureGeoIndex">collection.ensureGeoIndex</a> </li>
<li>
<a class="el" href="IndexGeo.html#IndexGeoShellEnsureGeoConstraint">collection.ensureGeoConstraint</a> </li>
<li>
<a class="el" href="IndexGeo.html#IndexGeoShellGeo">collection.geo</a> </li>
<li>
<a class="el" href="IndexGeo.html#IndexGeoShellNear">collection.near</a> </li>
<li>
<a class="el" href="IndexGeo.html#IndexGeoShellWithin">collection.within</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="IndexHash.html">Hash Indexes</a> <ul>
<li>
<a class="el" href="IndexHash.html#IndexHashIntro">Hash Indexes</a> </li>
<li>
<a class="el" href="IndexHash.html#IndexHashShell">Accessing Hash Indexes from the Shell</a> <ul>
<li>
<a class="el" href="IndexHash.html#IndexHashShellEnsureUniqueConstraint">collection.ensureUniqueConstraint</a> </li>
<li>
<a class="el" href="IndexHash.html#IndexHashShellEnsureHashIndex">collection.ensureHashIndex</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
<ul>
<li>
<a class="el" href="IndexSkiplist.html">Skip-Lists</a> <ul>
<li>
<a class="el" href="IndexSkiplist.html#IndexSkiplistIntro">Skiplist Indexes</a> </li>
<li>
<a class="el" href="IndexSkiplist.html#IndexSkiplistShell">Accessing Skip-List Indexes from the Shell</a> <ul>
<li>
<a class="el" href="IndexSkiplist.html#IndexSkiplistShellEnsureUniqueSkiplist">collection.ensureUniqueSkiplist</a> </li>
<li>
<a class="el" href="IndexSkiplist.html#IndexSkiplistShellEnsureSkiplist">collection.ensureSkiplist</a> </li>
</ul>
</li>
</ul>
</li>
</ul>
</div></div>
</div></body></html>