mirror of https://gitee.com/bigwinds/arangodb
51 lines
3.0 KiB
HTML
51 lines
3.0 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>Accessing Cap Constraints via Http </h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="textblock"><hr/>
|
|
<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>
|
|
<hr/>
|
|
<a class="anchor" id="IndexCapHttpEnsureCapConstraint"></a> <hr/>
|
|
<em>POST /_api/index</em> (creates a cap constraint)<hr/>
|
|
<br/>
|
|
<code><b>POST /_api/index?collection=<em>collection-identifier</em></b></code></p>
|
|
<p>Creates a cap constraint for the collection <em>collection-identifier</em>, if it does not already exist. Expects an object containing the index details.</p>
|
|
<ul>
|
|
<li><code>type</code>: must be equal to <code>"cap"</code>.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>size</code>: The maximal size of documents.</li>
|
|
</ul>
|
|
<p>If the index does not already exists and could be created, then a <code>HTTP 201</code> is returned. If the index already exists, then a <code>HTTP 200</code> is returned.</p>
|
|
<p>If the <em>collection-identifier</em> is unknown, then a <code>HTTP 404</code> is returned. It is possible to specify a name instead of an identifier.</p>
|
|
<p><b>Examples</b><br/>
|
|
</p>
|
|
<p>Creating a cap collection</p>
|
|
<div class="fragment"><pre class="fragment">> curl --data @- -X POST --dump - http://localhost:8529/_api/index?collection=1786279
|
|
{ "type" : "cap", "size" : 10 }
|
|
|
|
HTTP/1.1 201 Created
|
|
content-type: application/json
|
|
|
|
{
|
|
"size": 10,
|
|
"code": 201,
|
|
"id": "1786279/2769319",
|
|
"type": "cap",
|
|
"isNewlyCreated": true,
|
|
"error": false
|
|
}
|
|
</pre></div> </div></div>
|
|
</div></body></html>
|