mirror of https://gitee.com/bigwinds/arangodb
327 lines
13 KiB
HTML
327 lines
13 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 Reference Manual for API Implementors (1.0.0) </h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="textblock"><ul>
|
|
<li>
|
|
REST Interface <ul>
|
|
<li>
|
|
<a class="el" href="RestDocument.html">REST Interface for Documents</a> <ul>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentIntro">Documents, Identifiers, Handles</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentResource">Address and ETag of an Document</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentHttp">Working with Documents using REST</a> <ul>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentRead">GET /_api/document/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentCreate">POST /_api/document?collection=collection-identifier</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentReplace">PUT /_api/document/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentUpdate">PATCH /_api/document/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentDelete">DELETE /_api/document/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentHead">HEAD /_api/document/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestDocument.html#RestDocumentReadAll">GET /_api/document?collection=collection-identifier</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="RestEdge.html">REST Interface for Edges</a> <ul>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeIntro">Documents, Identifiers, Handles</a> </li>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeResource">Address and ETag of an Edge</a> </li>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeHttp">Working with Edges using REST</a> <ul>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeRead">GET /_api/edge/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeCreate">POST /_api/edge?collection=collection-identifier&from=from-handle&to=to-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeUpdate">PUT /_api/edge/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeDelete">DELETE /_api/edge/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeHead">HEAD /_api/edge/document-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="RestEdge.html#RestEdgeEdges">GET /_api/edges/collection-identifier?vertex=vertex-handle&directory=direction</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Light-Weight HTTP for Queries and Cursors <ul>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html">HTTP Interface for AQL Query Cursors</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorResults">Retrieving query results</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorResultsSingle">Single roundtrip</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorResultsCursor">Using a Cursor</a> </li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorHttp">Accessing Cursors via HTTP</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorPost">POST /_api/cursor</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorPostQuery">POST /_api/query</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorPut">PUT /_api/cursor/cursor-identifier</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCursor.html#HttpCursorDelete">DELETE /_api/cursor/cursor-identifier</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="HttpQueries.html">HTTP Interface for AQL Queries</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpQueries.html#HttpExplainPost">POST /_api/explain</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpQueries.html#HttpQueryPost">POST /_api/query</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html">HTTP Interface for Simple Queries</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleIntro">Simple Queries</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleHttp">Working with Simples Queries using HTTP</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleAll">POST /_api/simple/all</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleByExample">POST /_api/simple/by-example</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleFirstExample">POST /_api/simple/first-example</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleRange">POST /_api/simple/range</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleNear">POST /_api/simple/near</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSimple.html#HttpSimpleWithin">POST /_api/simple/within</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="IndexCapHttp.html">Accessing Cap Constraints via Http</a> <ul>
|
|
<li>
|
|
<a class="el" href="IndexCapHttp.html#IndexCapHttpEnsureCapConstraint">POST /_api/index</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="IndexGeoHttp.html">Accessing Geo Indexes via Http</a> <ul>
|
|
<li>
|
|
<a class="el" href="IndexGeoHttp.html#IndexGeoHttpEnsureGeo">POST /_api/index</a> </li>
|
|
<li>
|
|
<a class="el" href="IndexGeoHttp.html#IndexGeoHttpNear">POST /_api/simple/near</a> </li>
|
|
<li>
|
|
<a class="el" href="IndexGeoHttp.html#IndexGeoHttpWithin">POST /_api/simple/within</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="IndexHashHttp.html">Accessing Hash Indexes via Http</a> <ul>
|
|
<li>
|
|
<a class="el" href="IndexHashHttp.html#IndexHashHttpEnsureHash">POST /_api/index</a> </li>
|
|
<li>
|
|
<a class="el" href="IndexHashHttp.html#IndexHashHttpByExample">POST /_api/simple/by-example</a> </li>
|
|
<li>
|
|
<a class="el" href="IndexHashHttp.html#IndexHashHttpFirstExample">POST /_api/simple/first-example</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="IndexSkiplistHttp.html">Accessing Skip-List Indexes via Http</a> <ul>
|
|
<li>
|
|
<a class="el" href="IndexSkiplistHttp.html#IndexSkiplistHttpEnsureSkiplist">POST /_api/index</a> </li>
|
|
<li>
|
|
<a class="el" href="IndexSkiplistHttp.html#IndexSkiplistHttpRange">POST /_api/simple/range</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Light-Weight HTTP for Administration <ul>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html">HTTP Interface for Collections</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionIntro">Collections</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionResource">Address of a Collection</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionHttp">Working with Collections using HTTP</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionConstructor">Creating and Deleting Collections</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionCreate">POST /_api/collection</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionDelete">DELETE /_api/collection/collection-identifier</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionTruncate">PUT /_api/collection/collection-identifier/truncate</a> </li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionReading">Getting Information about a Collection</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionRead">GET /_api/collection/collection-identifier</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionRead">GET /_api/collection/collection-identifier/properties</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionRead">GET /_api/collection/collection-identifier/count</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionRead">GET /_api/collection/collection-identifier/figures</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionRead">GET /_api/collection/collection-identifier</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionReadAll">GET /_api/collection/</a> </li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionChanging">Modifying a Collection</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionLoad">PUT /_api/collection/collection-identifier/load</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionUnload">PUT /_api/collection/collection-identifier/unload</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionProperties">PUT /_api/collection/collection-identifier/properties</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpCollection.html#HttpCollectionRename">PUT /_api/collection/collection-identifier/rename</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html">HTTP Interface for Indexes</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html#HttpIndexIntro">Indexes</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html#HttpIndexResource">Address of an Index</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html#HttpIndexHttp">Working with Indexes using HTTP</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html#HttpIndexRead">GET /_api/index/index-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html#HttpIndexCreate">POST /_api/index?collection=collection-identifier</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html#HttpIndexDelete">DELETE /_api/index/index-handle</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpIndex.html#HttpIndexReadAll">GET /_api/index?collection=index-handle</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html">HTTP Interface for Administration and Monitoring</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemLog">GET /_admin/log</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemStatus">GET /_admin/status</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemConnectionStatistics">GET /_admin/connection-statistics</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemRequestStatistics">GET /_admin/request-statistics</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemConfigDescription">GET /_admin/config/description</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemConfigConfiguration">GET /_admin/config/configuration</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemSessionManagement">Front-End Session Management</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemSessionGet">POST /_admin/user-manager/session/sid</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemSessionPost">POST /_admin/user-manager/session</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemSessionLogin">PUT /_admin/user-manager/session/sid/login</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemSessionLogout">PUT /_admin/user-manager/session/sid/logout</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpSystem.html#HttpSystemSessionPassword">PUT /_admin/user-manager/session/sid/password</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Interface for bulk imports <ul>
|
|
<li>
|
|
<a class="el" href="HttpImport.html">HTTP Interface for bulk imports</a> <ul>
|
|
<li>
|
|
<a class="el" href="HttpImport.html#HttpImportSelfContained">Importing self-contained documents</a> </li>
|
|
<li>
|
|
<a class="el" href="HttpImport.html#HttpImportHeaderData">Importing headers and values</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Advanced Topics <ul>
|
|
<li>
|
|
<a class="el" href="ArangoErrors.html">Error codes and meanings</a> </li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Under Construction <ul>
|
|
<li>
|
|
<a class="el" href="IndexSkiplistHttp.html">Accessing Skip-List Indexes via Http</a> <ul>
|
|
<li>
|
|
<a class="el" href="IndexSkiplistHttp.html#IndexSkiplistHttpEnsureSkiplist">POST /_api/index</a> </li>
|
|
<li>
|
|
<a class="el" href="IndexSkiplistHttp.html#IndexSkiplistHttpRange">POST /_api/simple/range</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li>
|
|
<a class="el" href="Key-Value.html">REST Interface for storing key-value pairs</a> <ul>
|
|
<li>
|
|
<a class="el" href="Key-Value.html#Key-ValuePost">POST /_api/key/collection-name/key</a> </li>
|
|
<li>
|
|
<a class="el" href="Key-Value.html#Key-ValuePut">PUT /_api/key/collection-name/key</a> </li>
|
|
<li>
|
|
<a class="el" href="Key-Value.html#Key-ValueGet">GET /_api/key/collection-name/key</a> </li>
|
|
<li>
|
|
<a class="el" href="Key-Value.html#Key-ValueDelete">DELETE /_api/key/collection-name/key</a> </li>
|
|
<li>
|
|
<a class="el" href="Key-Value.html#Key-ValueSearch">GET /_api/keys/collection-name/prefix</a> </li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div></div>
|
|
</div></body></html>
|