mirror of https://gitee.com/bigwinds/arangodb
112 lines
3.7 KiB
Plaintext
112 lines
3.7 KiB
Plaintext
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief user guide guide
|
|
///
|
|
/// @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
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- USER MANUAL ARANGOSH
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page UserManualArangoshTOC
|
|
///
|
|
/// <ul>
|
|
/// <li>@ref UserManualArangosh
|
|
/// </li>
|
|
/// </ul>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page UserManualArangosh The Arango Shell
|
|
///
|
|
/// @NAVIGATE_UserManualArangosh
|
|
/// @EMBEDTOC{UserManualArangoshTOC}
|
|
///
|
|
/// @section UserManualArangoshOutput Arango Shell Output
|
|
/////////////////////////////////////////////////////////
|
|
///
|
|
/// In general the Arango Shells prints its as output to standard output channel
|
|
/// using the JSON stringifier.
|
|
///
|
|
/// @code
|
|
/// arangosh> db.five.all().toArray();
|
|
/// [{ _id : "2223655/3665447", _rev : "3665447", name : "one" },
|
|
/// { _id : "2223655/3730983", _rev : "3730983", name : "two" },
|
|
/// { _id : "2223655/3862055", _rev : "3862055", name : "four" },
|
|
/// { _id : "2223655/3993127", _rev : "3993127", name : "three" }]
|
|
/// @endcode
|
|
///
|
|
/// @CLEARPAGE
|
|
/// @FUN{start_pretty_print()}
|
|
///
|
|
/// While the standard JSON stringifier is very concise it is hard to read.
|
|
/// Calling the function @FN{start_pretty_print} will enable the pretty printer
|
|
/// which formats the output in a human readable way.
|
|
///
|
|
/// @code
|
|
/// arangosh> start_pretty_print();
|
|
/// using pretty printing
|
|
/// arangosh> db.five.all().toArray();
|
|
/// [
|
|
/// {
|
|
/// _id : "2223655/3665447",
|
|
/// _rev : "3665447",
|
|
/// name : "one"
|
|
/// },
|
|
/// {
|
|
/// _id : "2223655/3730983",
|
|
/// _rev : "3730983",
|
|
/// name : "two"
|
|
/// },
|
|
/// {
|
|
/// _id : "2223655/3862055",
|
|
/// _rev : "3862055",
|
|
/// name : "four"
|
|
/// },
|
|
/// {
|
|
/// _id : "2223655/3993127",
|
|
/// _rev : "3993127",
|
|
/// name : "three"
|
|
/// }
|
|
/// ]
|
|
/// @endcode
|
|
///
|
|
/// @CLEARPAGE
|
|
/// @FUN{stop_pretty_print()}
|
|
///
|
|
/// The functions disable the pretty printer, switching back to the standard
|
|
/// JSON output format.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: c++
|
|
// mode: outline-minor
|
|
// outline-regexp: "\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @section\\|/// @subsection\\|/// @\\}\\)"
|
|
// End:
|