From ead2e27175413fe2725175e650bc3acda9daf413 Mon Sep 17 00:00:00 2001 From: Simran Brucherseifer Date: Mon, 2 May 2016 20:26:59 +0200 Subject: [PATCH] Remove redundant documentation of key features, move programs overview --- .../Books/Users/GettingStarted/README.mdpp | 77 ++++++------------- 1 file changed, 24 insertions(+), 53 deletions(-) diff --git a/Documentation/Books/Users/GettingStarted/README.mdpp b/Documentation/Books/Users/GettingStarted/README.mdpp index 74923685b1..1cb96449b0 100644 --- a/Documentation/Books/Users/GettingStarted/README.mdpp +++ b/Documentation/Books/Users/GettingStarted/README.mdpp @@ -1,60 +1,31 @@ -!CHAPTER First Steps in ArangoDB - -For installation instructions, please refer to the -[Installation Manual](../Installing/README.md). - -As you know from the introduction ArangoDB is a multi-model open-source -Database. You can see the Key features below or look directly at the programs in -the ArangoDB package. - -Key features include: - -* *Schema-free schemata*: Lets you combine the space efficiency of MySQL with - the performance power of NoSQL -* *Application server*: Use ArangoDB as an application server and fuse your - application and database together for maximal throughput -* *JavaScript for all*: No language zoo, you can use one language from your - browser to your back-end -* *Flexible data modeling*: Model your data as combinations of key-value pairs, - documents or graphs - perfect for social relations -* *Free index choice*: Use the correct index for your problem, may it be a skip - list or a fulltext search -* *Configurable durability*: Let the application decide if it needs more - durability or more performance -* *No-nonsense storage*: ArangoDB uses all of the power of modern storage - hardware, like SSD and large caches -* *Powerful query language* (AQL) to retrieve and modify data -* *Transactions*: Run queries on multiple documents or collections with - optional transactional consistency and isolation -* *Replication*: Set up the database in a master-slave configuration -* It is open source (*Apache License 2.0*) - -For more in-depth information: - -* Read more on the - [Design Goals](https://www.arangodb.com/2012/03/07/avocadodbs-design-objectives) - of ArangoDB -* [Watch the video](http://vimeo.com/36411892): Martin Schönert, - architect of ArangoDB, gives an introduction of what the ArangoDB project - is about -* Or give it a [try](https://www.arangodb.com/tryitout) - +!CHAPTER Getting started !SECTION ArangoDB programs The ArangoDB package comes with the following programs: -* _arangod_: The ArangoDB database daemon. This server program is +* `arangod`: The ArangoDB database daemon. This server program is intended to run as a daemon process and to serve the various clients - connection to the server via TCP / HTTP. See [Details about the ArangoDB Server](../FirstSteps/Arangod.md) -* _arangosh_: The ArangoDB shell. A client that implements a + connection to the server via TCP / HTTP. + See [Details about the ArangoDB Server](../GettingStarted/Arangod.md) + +* `arangosh`: The ArangoDB shell. A client that implements a read-eval-print loop (REPL) and provides functions to access and - administrate the ArangoDB server. See [Details about the ArangoDB Shell](../FirstSteps/Arangosh.md). -* _arangoimp_: A bulk importer for the ArangoDB server. - See [Details about Arangoimp](../HttpBulkImports/Arangoimp.md). -* _arangodump_: A tool to create backups of an ArangoDB database. See - [Details about Arangodump](../HttpBulkImports/Arangodump.md). -* _arangorestore_: A tool to reload data from a backup into an ArangoDB database. - See [Details about Arangorestore](../HttpBulkImports/Arangorestore.md) -* _arango-dfdb_: A datafile debugger for ArangoDB. It is intended to be - used primarily during development of ArangoDB + administrate the ArangoDB server. + See [Details about the ArangoDB Shell](../Administration/Arangosh/README.md) + +* `arangoimp`: A bulk importer for the ArangoDB server. + See [Details about Arangoimp](../Administration/Arangoimp.md) + +* `arangodump`: A tool to create backups of an ArangoDB database. See + [Details about Arangodump](../Administration/Arangodump.md) + +* `arangorestore`: A tool to reload data from a backup into an ArangoDB database. + See [Details about Arangorestore](../Administration/Arangorestore.md) + +* `arango-dfdb`: A datafile debugger for ArangoDB. It is intended to be + used primarily during development of ArangoDB. + See [Details about Arango-DFDB](../Troubleshooting/ArangoDfdb.md) + +* `arangobench`: A benchmark and test tool. It can be used for performance and + server function testing. See [Details about Arangobench](../Troubleshooting/Arangobench.md)