mirror of https://gitee.com/bigwinds/arangodb
converting .dox to .md
This commit is contained in:
Frank Celler
parent
2be9e32a7b
commit
35819ea70e
|
|
@ -0,0 +1,56 @@
|
|||
HTTP Interface for Indexes {#HttpIndex}
|
||||
=======================================
|
||||
|
||||
@EMBEDTOC{HttpIndexTOC}
|
||||
@section HttpIndexIntro Indexes
|
||||
|
||||
This is an introduction to ArangoDB's Http interface for indexes in
|
||||
general. There are special sections for various index types.
|
||||
|
||||
@copydoc GlossaryIndex
|
||||
|
||||
@copydoc GlossaryIndexHandle
|
||||
|
||||
@copydoc GlossaryIndexGeo
|
||||
|
||||
@copydoc GlossaryIndexHash
|
||||
|
||||
@copydoc GlossaryIndexEdge
|
||||
|
||||
@copydoc GlossaryIndexSkiplist
|
||||
|
||||
@copydoc GlossaryIndexFulltext
|
||||
|
||||
The basic operations (create, read, update, delete) for documents are mapped to
|
||||
the standard HTTP methods (`POST`, `GET`, `PUT`, `DELETE`).
|
||||
|
||||
Address of an Index {#HttpIndexResource}
|
||||
========================================
|
||||
|
||||
All indexes in ArangoDB have an unique handle. This index handle identifies an
|
||||
index and is managed by ArangoDB. All indexes are found under the URI
|
||||
|
||||
http://server:port/_api/index/index-handle
|
||||
|
||||
For example: Assume that the index handle is `demo/63563528` then the URL of
|
||||
that index is:
|
||||
|
||||
http://localhost:8529/_api/index/demo/63563528
|
||||
|
||||
Working with Indexes using HTTP {#HttpIndexHttp}
|
||||
================================================
|
||||
|
||||
@anchor HttpIndexRead
|
||||
@copydetails JSF_GET_api_index
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor HttpIndexCreate
|
||||
@copydetails JSF_POST_api_index
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor HttpIndexDelete
|
||||
@copydetails JSF_DELETE_api_index
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor HttpIndexReadAll
|
||||
@copydetails JSF_GET_api_indexes
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
TOC {#HttpIndexTOC}
|
||||
===================
|
||||
|
||||
- @ref HttpIndex
|
||||
- @ref HttpIndexIntro
|
||||
- @ref HttpIndexResource
|
||||
- @ref HttpIndexHttp
|
||||
- @ref HttpIndexRead "GET /_api/index/index-handle"
|
||||
- @ref HttpIndexCreate "POST /_api/index?collection=collection-name"
|
||||
- @ref HttpIndexDelete "DELETE /_api/index/index-handle"
|
||||
- @ref HttpIndexReadAll "GET /_api/index?collection=index-handle"
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
HTTP Interface for Administration and Monitoring {#HttpSystem}
|
||||
==============================================================
|
||||
|
||||
@EMBEDTOC{HttpSystemTOC}
|
||||
|
||||
This is an introduction to ArangoDB's Http interface for administration and
|
||||
monitoring of the server.
|
||||
|
||||
@anchor HttpSystemLog
|
||||
@copydetails triagens::admin::RestAdminLogHandler::execute
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor HttpSystemStatus
|
||||
@copydetails JSF_GET_admin_status
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor HttpSystemConnectionStatistics
|
||||
@copydetails triagens::arango::ConnectionStatisticsHandler::compute
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor HttpSystemRequestStatistics
|
||||
@copydetails triagens::arango::RequestStatisticsHandler::compute
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
TOC {#HttpSystemTOC}
|
||||
====================
|
||||
|
||||
- @ref HttpSystem
|
||||
- @ref HttpSystemLog "GET /_admin/log"
|
||||
- @ref HttpSystemStatus "GET /_admin/status"
|
||||
- @ref HttpSystemConnectionStatistics "GET /_admin/connection-statistics"
|
||||
- @ref HttpSystemRequestStatistics "GET /_admin/request-statistics"
|
||||
|
|
@ -3,39 +3,18 @@ ArangoDB for API Implementors (@VERSION) {#ImplementorManual}
|
|||
|
||||
@NAVIGATE_ImplementorManual
|
||||
|
||||
@if LATEX
|
||||
- @ref RestDocument</li>
|
||||
- @ref RestEdge</li>
|
||||
- @ref HttpCursor</li>
|
||||
- @ref HttpSimple</li>
|
||||
- @ref IndexCapHttp</li>
|
||||
- @ref IndexHashHttp</li>
|
||||
- @ref IndexSkiplistHttp</li>
|
||||
- @ref IndexGeoHttp</li>
|
||||
- @ref IndexFulltextHttp</li>
|
||||
- @ref HttpCollection</li>
|
||||
- @ref HttpIndex</li>
|
||||
- @ref HttpSystem</li>
|
||||
- @ref HttpMisc</li>
|
||||
- @ref HttpBatch</li>
|
||||
- @ref HttpImport</li>
|
||||
- @ref Communication</li>
|
||||
- @ref NamingConventions</li>
|
||||
- @ref ArangoErrors</li>
|
||||
- @ref Glossary</li>
|
||||
@else
|
||||
@CHAPTER_REF{RestDocument}
|
||||
@CHAPTER_REF{RestEdge}
|
||||
@CHAPTER_REF{HttpCursor}
|
||||
@CHAPTER_REF{HttpQuery}
|
||||
@CHAPTER_REF{HttpSimple}
|
||||
@CHAPTER_REF{HttpCollection}
|
||||
@CHAPTER_REF{HttpIndex}
|
||||
@CHAPTER_REF{IndexCapHttp}
|
||||
@CHAPTER_REF{IndexHashHttp}
|
||||
@CHAPTER_REF{IndexSkiplistHttp}
|
||||
@CHAPTER_REF{IndexGeoHttp}
|
||||
@CHAPTER_REF{IndexFulltextHttp}
|
||||
@CHAPTER_REF{HttpCollection}
|
||||
@CHAPTER_REF{HttpIndex}
|
||||
@CHAPTER_REF{HttpSystem}
|
||||
@CHAPTER_REF{HttpMisc}
|
||||
@CHAPTER_REF{HttpGraph}
|
||||
|
|
@ -45,4 +24,4 @@ ArangoDB for API Implementors (@VERSION) {#ImplementorManual}
|
|||
@CHAPTER_REF{CommunicationCors}
|
||||
@CHAPTER_REF{NamingConventions}
|
||||
@CHAPTER_REF{ArangoErrors}
|
||||
@endif
|
||||
@CHAPTER_REF{Glossary}
|
||||
|
|
|
|||
|
|
@ -245,7 +245,7 @@ ALIASES += \
|
|||
# table of content
|
||||
ALIASES += \
|
||||
"BOOK_REF{1}=@ref \1" \
|
||||
"CHAPTER_REF{1}=@copydetails \1TOC"
|
||||
"CHAPTER_REF{1}=@if LATEX @copydetails \1@else@copydetails \1TOC@endif"
|
||||
|
||||
# other aliases
|
||||
ALIASES += \
|
||||
|
|
|
|||
|
|
@ -1,116 +0,0 @@
|
|||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief over the wire protocol
|
||||
///
|
||||
/// @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 HttpIndexTOC
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref HttpIndex
|
||||
/// <ul>
|
||||
/// <li>@ref HttpIndexIntro</li>
|
||||
/// <li>@ref HttpIndexResource</li>
|
||||
/// <li>@ref HttpIndexHttp
|
||||
/// @copydetails HttpIndexCallsTOC
|
||||
/// </li>
|
||||
/// </ul>
|
||||
/// </li>
|
||||
/// </ul>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page HttpIndexCallsTOC
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref HttpIndexRead "GET /_api/index/index-handle"</li>
|
||||
/// <li>@ref HttpIndexCreate "POST /_api/index?collection=collection-name"</li>
|
||||
/// <li>@ref HttpIndexDelete "DELETE /_api/index/index-handle"</li>
|
||||
/// <li>@ref HttpIndexReadAll "GET /_api/index?collection=index-handle"</li>
|
||||
/// </ul>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page HttpIndex HTTP Interface for Indexes
|
||||
///
|
||||
/// This is an introduction to ArangoDB's Http interface for indexes in
|
||||
/// general. There are special sections for various index types.
|
||||
///
|
||||
/// @EMBEDTOC{HttpIndexTOC}
|
||||
///
|
||||
/// @section HttpIndexIntro Indexes
|
||||
///////////////////////////////////
|
||||
///
|
||||
/// @copydoc GlossaryIndex
|
||||
///
|
||||
/// @copydoc GlossaryIndexHandle
|
||||
///
|
||||
/// @copydoc GlossaryIndexGeo
|
||||
///
|
||||
/// @copydoc GlossaryIndexHash
|
||||
///
|
||||
/// @copydoc GlossaryIndexEdge
|
||||
///
|
||||
/// @copydoc GlossaryIndexSkiplist
|
||||
///
|
||||
/// @copydoc GlossaryIndexFulltext
|
||||
///
|
||||
/// The basic operations (create, read, update, delete) for documents are mapped
|
||||
/// to the standard HTTP methods (POST, GET, PUT, DELETE).
|
||||
///
|
||||
/// @section HttpIndexResource Address of an Index
|
||||
//////////////////////////////////////////////////
|
||||
///
|
||||
/// All indexes in ArangoDB have an unique handle. This index handle identifies
|
||||
/// an index and is managed by ArangoDB. All indexes are found under the URI
|
||||
///
|
||||
/// @LIT{http://server:port/_api/index/index-handle}
|
||||
///
|
||||
/// For example: Assume that the index handle is @LIT{demo/63563528} then
|
||||
/// the URL of that index is:
|
||||
///
|
||||
/// @LIT{http://localhost:8529/_api/index/demo/63563528}
|
||||
///
|
||||
/// @section HttpIndexHttp Working with Indexes using HTTP
|
||||
//////////////////////////////////////////////////////////
|
||||
///
|
||||
/// @anchor HttpIndexRead
|
||||
/// @copydetails JSF_GET_api_index
|
||||
///
|
||||
/// @anchor HttpIndexCreate
|
||||
/// @copydetails JSF_POST_api_index
|
||||
///
|
||||
/// @anchor HttpIndexDelete
|
||||
/// @copydetails JSF_DELETE_api_index
|
||||
///
|
||||
/// @anchor HttpIndexReadAll
|
||||
/// @copydetails JSF_GET_api_indexes
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// Local Variables:
|
||||
// mode: c++
|
||||
// mode: outline-minor
|
||||
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
||||
// End:
|
||||
|
|
@ -1,68 +0,0 @@
|
|||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief over the wire protocol
|
||||
///
|
||||
/// @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 HttpSystemTOC
|
||||
///
|
||||
/// <ul>
|
||||
/// <li>@ref HttpSystem
|
||||
/// <ul>
|
||||
/// <li>@ref HttpSystemLog "GET /_admin/log"</li>
|
||||
/// <li>@ref HttpSystemStatus "GET /_admin/status"</li>
|
||||
/// <li>@ref HttpSystemConnectionStatistics "GET /_admin/connection-statistics"</li>
|
||||
/// <li>@ref HttpSystemRequestStatistics "GET /_admin/request-statistics"</li>
|
||||
/// </ul>
|
||||
/// </li>
|
||||
/// </ul>
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @page HttpSystem HTTP Interface for Administration and Monitoring
|
||||
///
|
||||
/// This is an introduction to ArangoDB's Http interface for administration
|
||||
/// and monitoring of the server.
|
||||
///
|
||||
/// @EMBEDTOC{HttpSystemTOC}
|
||||
///
|
||||
/// @anchor HttpSystemLog
|
||||
/// @copydetails triagens::admin::RestAdminLogHandler::execute
|
||||
///
|
||||
/// @anchor HttpSystemStatus
|
||||
/// @copydetails JSF_GET_admin_status
|
||||
///
|
||||
/// @anchor HttpSystemConnectionStatistics
|
||||
/// @copydetails triagens::arango::ConnectionStatisticsHandler::compute
|
||||
///
|
||||
/// @anchor HttpSystemRequestStatistics
|
||||
/// @copydetails triagens::arango::RequestStatisticsHandler::compute
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// Local Variables:
|
||||
// mode: c++
|
||||
// mode: outline-minor
|
||||
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
||||
// End:
|
||||
Loading…
Reference in New Issue