mirror of https://gitee.com/bigwinds/arangodb
94 lines
3.1 KiB
Plaintext
94 lines
3.1 KiB
Plaintext
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief indexes
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2012 triagens GmbH, Cologne, Germany
|
|
///
|
|
/// Licensed under the Apache License, Version 2.0 (the "License");
|
|
/// you may not use this file except in compliance with the License.
|
|
/// You may obtain a copy of the License at
|
|
///
|
|
/// http://www.apache.org/licenses/LICENSE-2.0
|
|
///
|
|
/// Unless required by applicable law or agreed to in writing, software
|
|
/// distributed under the License is distributed on an "AS IS" BASIS,
|
|
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
/// See the License for the specific language governing permissions and
|
|
/// limitations under the License.
|
|
///
|
|
/// Copyright holder is triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// @author Dr. Frank Celler
|
|
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexCapTOC
|
|
///
|
|
/// <ul>
|
|
/// <li>@ref IndexCap
|
|
/// <ul>
|
|
/// <li>@ref IndexCapIntro
|
|
/// </li>
|
|
/// <li>@ref IndexCapShell
|
|
/// <ul>
|
|
/// <li>@ref IndexCapShellEnsureCapConstraint "collection.ensureCapConstraint"</li>
|
|
/// </ul>
|
|
/// </li>
|
|
/// </ul>
|
|
/// </li>
|
|
/// </ul>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexCap Cap Constraint
|
|
///
|
|
/// This is an introduction to ArangoDB's size restrictions aka cap for
|
|
/// collections.
|
|
///
|
|
/// @EMBEDTOC{IndexCapTOC}
|
|
///
|
|
/// @section IndexCapIntro Cap Constraint
|
|
/////////////////////////////////////////
|
|
///
|
|
/// It is possible to restrict the size of collection. If you add a document and
|
|
/// the size exceeds the limit, then the least recently created or updated
|
|
/// document will be dropped.
|
|
///
|
|
/// @section IndexCapShell Accessing Cap Constraints from the Shell
|
|
///////////////////////////////////////////////////////////////////
|
|
///
|
|
/// @anchor IndexCapShellEnsureCapConstraint
|
|
/// @copydetails JS_EnsureCapConstraintVocbaseCol
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexCapHttpTOC
|
|
///
|
|
/// <ul>
|
|
/// <li>@ref IndexCapHttp
|
|
/// <ul>
|
|
/// <li>@ref IndexCapHttpEnsureCapConstraint "POST /_api/index"</li>
|
|
/// </ul>
|
|
/// </li>
|
|
/// </ul>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page IndexCapHttp Accessing Cap Constraints via Http
|
|
///
|
|
/// @EMBEDTOC{IndexCapHttpTOC}
|
|
///
|
|
/// @anchor IndexCapHttpEnsureCapConstraint
|
|
/// @copydetails JSF_POST_api_index_cap
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// Local Variables:
|
|
// mode: c++
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
|
// End:
|