1
0
Fork 0
arangodb/Documentation/Books/Users
Wilfried Goesgens 4b861dd44a Merge branch 'devel' of github.com:arangodb/ArangoDB into JHMH 2015-12-01 16:37:06 +01:00
..
AdministratingArango Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
Advanced Documentation formatting 2015-10-02 03:14:55 +02:00
Aql Merge branch 'devel' of github.com:arangodb/arangodb into JHMH 2015-11-27 09:29:01 +01:00
AqlExamples Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
AqlExtending Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
ArangoActions Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Arangosh Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
Collections Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
ConfigureArango Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Databases fix title: is -> list 2014-12-01 15:11:30 +01:00
Documents Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Edges Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +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 dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Foxx Link README.md instead of leaning on directory access. 2015-11-27 13:45:30 +01:00
GeneralGraphs Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
GeneralHttp Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Glossary Fix links not to point to .html - .md is right, else the non-html generators won't work properly. 2015-11-27 11:51:29 +01:00
Graphs - move aql graph features into a graph topic 2015-11-18 17:38:44 +01: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 Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
HttpAqlUserFunctions Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
HttpAsyncResultsManagement Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpBatchRequest Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpBulkImports Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpCollection Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpDatabase Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpDocument Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
HttpEdge Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +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 Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +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 Added Error codes and meanings 2014-07-09 14:20:23 +02:00
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 Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Installing Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
ModuleActions Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
ModuleConsole Removed mention of 'collapsing' in console docs. 2015-05-06 17:22:17 +02:00
ModuleFs Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
ModuleJavaScript Wording 2015-11-23 15:03:25 +01:00
ModulePlanner add health check documentation. 2015-08-13 17:16:06 +02:00
ModuleProcess Add checker for MarkdownPP failures; fix existing failures (fixes #1497) 2015-09-17 17:26:01 +02:00
ModuleQueries Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
ModuleRequest Set returnBodyOnError: true by default in org/arangodb/request 2015-11-24 15:00:11 +01:00
ModuleTasks Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
ModuleWal wrote documentation for WAL 2014-07-06 18:31:41 +02:00
NamingConventions issue #1587 2015-11-24 17:01:14 +01:00
NewFeatures Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Replication documentation 2015-12-01 12:53:02 +01:00
Sharding Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
SimpleQueries Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Transactions notes on deadlocks and deadlock detection 2015-11-04 17:15:56 +01:00
Traversals Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
Upgrading Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
UsingJsUnity updated manual 2014-11-04 15:31:35 +01:00
WebInterface Fix dangling anchors and add checker script to the make target. 2015-11-26 18:51:39 +01:00
styles Deleted localstorage used for searching in the docs. This search is not used anymore but still the result was ddisplayed for old searches 2015-09-22 17:22:28 +02:00
README.mdpp Add hint that drivers may provide re-implementations of the examples 2015-11-20 16:23:14 +01:00
SUMMARY.md Merge branch 'devel' of github.com:arangodb/arangodb into JHMH 2015-11-30 14:17:44 +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.