1
0
Fork 0
arangodb/Documentation/Books/Users
jsteemann 18f54c2dde Merge branch 'devel' of https://github.com/arangodb/arangodb into devel 2016-04-15 17:21:35 +02:00
..
AdministratingArango Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
Advanced org/arangodb -> @arangodb 2015-12-15 15:51:44 +01:00
Aql added optimizer rule "inline-subqueries" 2016-04-15 17:21:22 +02:00
AqlExamples Documentation: Aql with ArangoDB Web Interface 2016-01-30 15:05:29 +01:00
AqlExtending doc: added link between User Defined and HTTP Aql chapters 2016-02-09 04:35:21 +01:00
AqlOperations Documentation: Aql update 2016-01-27 19:55:34 +01:00
ArangoActions org/arangodb -> @arangodb 2015-12-15 15:51:44 +01:00
Arangosh updated documentation 2016-01-04 14:51:40 +01:00
Collections remove @brief. 2016-01-12 19:13:46 +01:00
ConfigureArango fixed /_admin/log 2016-02-04 00:41:50 +01:00
Databases Replace @EXAMPLES 2016-01-12 19:10:00 +01:00
Documents fix syntax. 2016-01-12 20:03:25 +01:00
Edges remove @brief. 2016-01-12 19:13:46 +01:00
ErrorCodes Work on documentation - not all documentation from the code seems to appear in the generated documentation. 2015-05-22 15:37:23 +02:00
FirstSteps fix extraneous word and fixup sentence in CollectionsAndDocuments.mdpp 2016-01-02 16:19:11 -05:00
Foxx Replace @EXAMPLES 2016-01-12 19:10:00 +01:00
GeneralGraphs Replace @PARAM by markdown 2016-01-12 20:03:25 +01:00
GeneralHttp Clarify fire and forget jobs. 2016-02-03 16:24:58 +01:00
Glossary documentation: typo correction 2016-01-17 19:32:04 +01:00
Graphs documentation: Clean up typos on graphs page. 2016-02-12 17:33:32 -05:00
HttpAdministrationAndMonitoring Update RESTAPI documentation handling to work with the swagger 2 api 2015-09-16 16:35:13 +02:00
HttpApi Rework HTTP basics 2015-11-05 13:51:56 +01:00
HttpAqlQuery More Americanization 2015-09-03 22:25:43 +02:00
HttpAqlQueryCache query cache, now with result limitations, HTTP and JavaScript APIs 2015-06-27 01:12:32 +02:00
HttpAqlQueryCursor Remove whitespaces that may irretate our parser, add checks. 2015-12-04 15:17:36 +01:00
HttpAqlUserFunctions Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
HttpAsyncResultsManagement Clarify fire and forget jobs. 2016-02-03 16:24:58 +01:00
HttpBatchRequest Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpBulkImports allow specifying collection name prefixes for `_from` and `_to` in arangoimp: 2016-04-15 16:18:23 +02:00
HttpCollection Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpDatabase Remove whitespaces that may irretate our parser, add checks. 2015-12-04 15:17:36 +01:00
HttpDocument Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpEdge Relayout the graph documentation to have one start chapter with explanations, and each others only document their function and link back to the global explanation. 2016-01-07 14:17:14 +01:00
HttpEndpoints Deleted two startDocuBlock that aren't used anymore 2015-07-22 11:27:16 +02:00
HttpExport refactored cursor API, added export API 2015-03-30 18:03:42 +02:00
HttpGharial Relayout the graph documentation to have one start chapter with explanations, and each others only document their function and link back to the global explanation. 2016-01-07 14:17:14 +01:00
HttpIndexes Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpMiscellaneousFunctions updated documentation 2015-09-10 01:38:18 +02:00
HttpReplications updated documentation 2015-09-09 15:23:47 +02:00
HttpShardingInterface
HttpSimpleQuery Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
HttpTasks Upgrade the REST-API documentation to to swagger V2.0 2015-09-09 15:21:18 +02:00
HttpTransaction Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
HttpTraversal Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpUserManagement Upgrade the REST-API documentation to to swagger V2.0 2015-09-09 15:21:18 +02:00
IndexHandling documentation: links between fulltext chapters 2016-02-02 17:41:40 +01:00
Installing fix typos in Cluster.mdpp 2016-01-02 16:23:53 -05:00
ModuleActions de-externalise docublocks. 2016-01-11 17:18:22 +01:00
ModuleConsole Removed mention of 'collapsing' in console docs. 2015-05-06 17:22:17 +02:00
ModuleFs added fs.append 2016-01-24 11:34:13 +01:00
ModuleJavaScript Wording 2015-11-23 15:03:25 +01:00
ModulePlanner de-externalise docublocks. 2016-01-11 17:18:22 +01:00
ModuleProcess Add checker for MarkdownPP failures; fix existing failures (fixes #1497) 2015-09-17 17:26:01 +02:00
ModuleQueries org/arangodb -> @arangodb 2015-12-15 15:51:44 +01:00
ModuleRequest org/arangodb -> @arangodb 2015-12-15 15:51:44 +01:00
ModuleTasks org/arangodb -> @arangodb 2015-12-15 15:51:44 +01:00
ModuleWal remove @brief. 2016-01-12 19:13:46 +01:00
NamingConventions issue #1587 2015-11-24 17:01:14 +01:00
NewFeatures updated CHANGELOG 2015-12-22 20:06:37 +01:00
Replication updated CHANGELOG 2016-02-06 00:37:59 +01:00
Sharding org/arangodb -> @arangodb 2015-12-15 15:51:44 +01:00
SimpleQueries Documentation: links between Geo features 2016-01-16 11:37:57 +01:00
Transactions make example copyable 2016-01-21 09:55:02 +01:00
Traversals Relayout the graph documentation to have one start chapter with explanations, and each others only document their function and link back to the global explanation. 2016-01-07 14:17:14 +01:00
Upgrading updated documentation 2016-01-19 00:25:16 +01:00
UsingJsUnity updated manual 2014-11-04 15:31:35 +01:00
WebInterface Documentation: Aql with ArangoDB Web Interface 2016-01-30 15:05:29 +01:00
styles Fix style as Info pointed out 2015-12-04 13:22:34 +01:00
README.mdpp Add hint that drivers may provide re-implementations of the examples 2015-11-20 16:23:14 +01:00
SUMMARY.md Clarify fire and forget jobs. 2016-02-03 16:24:58 +01:00
book.json Use the same plugin for the index as the docs.arangodb.com does 2015-09-21 16:50:19 +02:00

README.mdpp

!BOOK ArangoDB VERSION_NUMBER Documentation

Welcome to the ArangoDB documentation!

The documentation introduces ArangoDB for you as a user, developer and administrator and describes all of its functions in detail. 

ArangoDB is a multi-model, open-source database with flexible data models for documents, graphs, and key-values. Build high performance applications using a convenient SQL-like query language or JavaScript extensions. Use ACID transactions if you require them. Scale horizontally and vertically with a few mouse clicks.

Key features include:

* **Schema-free schemata** let you combine the space efficiency of MySQL with the performance power of NoSQL
* 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
* ArangoDB is **multi-threaded** - exploit the power of all your cores
* **Flexible data modeling**: model your data as combination of key-value pairs, documents or graphs - perfect for social relations
* Free **index choice**: use the correct index for your problem, be it 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** and **Sharding**: set up the database in a master-slave configuration or spread bigger datasets across multiple servers
* It is **open source** (Apache License 2.0)

In this documentation you can inform yourself about all the functions, features and programs ArangoDB provides for you.
Features are ilustrated with interactive usage examples; you can cut'n'paste them into [arangosh](Arangosh/README.md) to try them out.
The http REST-API is demonstrated with cut'n'paste recepies intended to be used with the [cURL](http://curl.haxx.se).
Drivers may provide their own examples based on these .js based examples to improve understandeability for their respective users.
I.e. for the [java driver](https://github.com/arangodb/arangodb-java-driver#learn-more) some of the samples are re-implemented.

You can also go to our [cookbook](https://docs.arangodb.com/cookbook) and look through some recipes to learn more about ArangoDB specific problems and solutions.

!SUBSECTION Community

If you have questions regarding ArangoDB, Foxx, drivers, or this documentation don't hesitate to contact us on:

- [Github](https://github.com/arangodb/arangodb/issues) for issues and misbehavior or [pull requests](https://www.arangodb.com/community/)
- [Google groups](https://groups.google.com/forum/?hl=de#!forum/arangodb) for discussions about ArangoDB in general or to announce your new Foxx App
- [Stackoverflow](http://stackoverflow.com/questions/tagged/arangodb) for questions about AQL, usage scenarios etc.

Please describe:

- the environment you run ArangoDB in
- the ArangoDB version you use
- whether you're using Foxx
- the client you're using
- which parts of the Documentation you're working with (link)
- what you expect to happen
- whats actually happening

We will respond as soon as possible.