1
0
Fork 0
arangodb/Documentation/Books/Users
CoDEmanX 183adccbd9 Make version more prominent in documentation
Many ebook readers (and reading apps) generate covers from meta data like the book title. Therefore it makes sense to place the version string there instead of the first paragraph.
2015-08-21 00:18:32 +02:00
..
AdministratingArango issue #1020 2014-09-17 11:42:01 +02:00
Aql updated documentation 2015-08-20 20:35:28 +02:00
AqlExamples Rework index documentation; add more executed examples. 2015-08-04 18:42:44 +02:00
AqlExtending updated conventions documentation for AQL functions 2015-01-16 12:56:02 +01:00
ArangoActions to make foxx routing return 405 is not easily possible - document the 404 behaviour. 2015-08-12 09:26:00 +02:00
Arangodump Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
Arangoimp Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
Arangorestore Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
Arangosh Examplify 2015-08-07 11:45:39 +02:00
Blueprint-Graphs Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
Collections Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
ConfigureArango Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
Databases fix title: is -> list 2014-12-01 15:11:30 +01:00
DatafileDebugger extended dfdb capabilities, updated dfdb manual section 2015-05-21 15:26:12 +02:00
Documents Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
Edges Documentation: How to update edge 2015-08-16 19:00:23 +03: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 Work on the documentation to contain real examples. 2015-08-11 14:18:08 +02:00
Foxx Removed outdated documentation, has been replased by a newer version earlier 2015-08-18 16:36:13 +02:00
General-Graphs Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
GeneralHttp the great rename: array => object, list => array 2014-12-18 22:33:23 +01:00
Glossary issue #1409: Document values with null character truncated with 2.6.2 on Windows 2015-07-13 12:45:13 +02:00
HttpAdministrationAndMonitoring Changes in the documentation code for API 2014-07-01 14:18:12 +02:00
HttpApi updated manual for HTTP general 2014-07-06 01:12:30 +02:00
HttpAqlQuery Move documentation into the source. 2015-08-13 15:37:43 +02:00
HttpAqlQueryCache query cache, now with result limitations, HTTP and JavaScript APIs 2015-06-27 01:12:32 +02:00
HttpAqlQueryCursor query cache, now with result limitations, HTTP and JavaScript APIs 2015-06-27 01:12:32 +02:00
HttpAqlUserFunctions Even more changes in the API documentation code 2014-06-30 15:58:11 +02:00
HttpAsyncResultsManagement Move call documentation over into the source. 2015-08-13 10:49:04 +02:00
HttpBatchRequest Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
HttpBulkImports Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
HttpCollection Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
HttpDatabase Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
HttpDocument Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
HttpEdge Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02: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 Move documentation into the source files. 2015-08-12 17:38:41 +02:00
HttpGraphs Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
HttpIndexes Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
HttpMiscellaneousFunctions Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
HttpReplications Erased useless @startDocuBlocks 2014-07-08 11:16:56 +02:00
HttpShardingInterface Added Error codes and meanings 2014-07-09 14:20:23 +02:00
HttpSimpleQuery Move documentation into the source files. 2015-08-12 17:38:41 +02:00
HttpTasks add Documentation index for the Tasks API 2014-11-11 13:12:45 +01:00
HttpTransaction Changed API documentation in code 2014-06-30 17:29:15 +02:00
HttpTraversal Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
HttpUserManagement Fixed user storage not reloading internal users db. 2014-08-21 11:06:35 +02:00
IndexHandling Hook in stray docuBlocks 2015-08-13 18:54:38 +02:00
Installing somehow the previous commit messed it up. try fixing it 2015-06-18 14:22:35 +02: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
ModuleGraph Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
ModuleJavaScript Work on the documentation to contain real examples. 2015-08-11 14:18:08 +02:00
ModulePlanner add health check documentation. 2015-08-13 17:16:06 +02:00
ModuleProcess Work around sanitychecks for commented out md sections. 2015-05-26 18:35:19 +02:00
ModuleQueries make query handling examples more reliable. 2015-08-14 14:45:53 +02:00
ModuleRequest Added documentation. 2015-01-20 17:26:10 +01:00
ModuleTasks Fixed #1236. Updated the documentation for registerTask 2015-06-01 16:02:50 +02:00
ModuleWal wrote documentation for WAL 2014-07-06 18:31:41 +02:00
NamingConventions issue #1409: Document values with null character truncated with 2.6.2 on Windows 2015-07-13 12:45:13 +02:00
NewFeatures Fix broken links. 2015-08-11 16:50:27 +02:00
Replication the great rename: array => object, list => array 2014-12-18 22:33:23 +01:00
Sharding Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
SimpleQueries Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
Transactions fixed typos 2014-12-26 17:02:46 +01:00
Traversals issue #1372: fixed wrong parameter in traversal documentation 2015-06-12 16:08:41 +02:00
Upgrading More docs. 2015-08-11 13:34:57 +02:00
UsingJsUnity updated manual 2014-11-04 15:31:35 +01:00
WebInterface Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
WriteAheadLog write-ahead log documentation 2014-07-06 19:17:11 +02:00
styles removed wrong comment 2015-08-04 17:30:32 +02:00
README.mdpp Make version more prominent in documentation 2015-08-21 00:18:32 +02:00
SUMMARY.md Improved the documentation for Foxx controller 2015-08-18 16:14:39 +02:00
book.json Make version more prominent in documentation 2015-08-21 00:18:32 +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 modelling**: 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 Licence 2.0)

In this documentation you can inform yourself about all the functions, features and programs ArangoDB provides for you.

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 missbehaviour 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 anounce 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 actualy happening

We will respond as soon as possible.