1
0
Fork 0
arangodb/Documentation/Books/Users
Alan Plum 5b7f3d19d0 Deprecate CS in 2.9, not 2.8 2015-10-06 12:47:58 +02: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 Documentation formatting 2015-10-02 03:14:55 +02:00
AqlExamples Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
AqlExtending Add checker for MarkdownPP failures; fix existing failures (fixes #1497) 2015-09-17 17:26:01 +02:00
ArangoActions restore 2.6 behavior for db-based modules 2015-10-01 10:51:23 +02:00
Arangosh Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
Collections Changed README.html to index.html in the documentation 2015-06-09 09:40:12 +02:00
ConfigureArango added ARANGODB_DEFAULT_ROOT_PASSWORD 2015-09-29 13:15:25 +02:00
Databases fix title: is -> list 2014-12-01 15:11:30 +01:00
Documents Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +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 Cleanup documentation for remaining @-tags 2015-09-17 11:15:33 +02:00
Foxx Merge pull request #1498 from thurt/patch-1 2015-09-24 13:00:20 +02:00
GeneralGraphs Two more places to follow General-Graph -> GeneralGraph 2015-10-01 14:48:34 +02:00
GeneralHttp Fix anchor by using http escaped braces 2015-09-14 14:10:26 +02:00
Glossary updated hash index documentation 2015-09-15 00:16:36 +02:00
Graphs Fix links; currently links in REST-documentation only work in the RESTDESCRIPTION :-( 2015-10-01 13:30:55 +02:00
HttpAdministrationAndMonitoring Update RESTAPI documentation handling to work with the swagger 2 api 2015-09-16 16:35:13 +02:00
HttpApi Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02: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 More Americanization 2015-09-03 22:25:43 +02:00
HttpBatchRequest Update RESTAPI documentation handling to work with the swagger 2 api 2015-09-16 16:35:13 +02:00
HttpBulkImports Update RESTAPI documentation handling to work with the swagger 2 api 2015-09-16 16:35:13 +02:00
HttpCollection Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
HttpDatabase Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
HttpDocument Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +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 Fix links; currently links in REST-documentation only work in the RESTDESCRIPTION :-( 2015-10-01 13:30:55 +02:00
HttpIndexes Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02: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 Implement a starting resource for graph documentation 2015-09-24 18:53:23 +02:00
HttpUserManagement Upgrade the REST-API documentation to to swagger V2.0 2015-09-09 15:21:18 +02:00
IndexHandling updated hash index information 2015-09-14 17:45:01 +02:00
Installing removed remark about Micro Instance 2015-10-01 17:45:42 +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
ModuleJavaScript Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02: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 Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
ModuleRequest Added documentation. 2015-01-20 17:26:10 +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 additionally allow the following characters in document keys: 2015-09-15 00:16:08 +02:00
NewFeatures Add checker for MarkdownPP failures; fix existing failures (fixes #1497) 2015-09-17 17:26:01 +02:00
Replication fixed incremental sync method 2015-09-14 17:44:12 +02:00
Sharding Documentation: corrected typos and case, prefer American over British English 2015-09-01 17:19:13 +02:00
SimpleQueries Fix markdown, slightly re-organize simple query docs. 2015-09-04 22:48:58 +02:00
Transactions issue #1507: added optional *allowImplicit* sub-attribute for transactions 2015-09-24 15:50:00 +02:00
Traversals issue #1372: fixed wrong parameter in traversal documentation 2015-06-12 16:08:41 +02:00
Upgrading Deprecate CS in 2.9, not 2.8 2015-10-06 12:47:58 +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
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 Insert a blank 2015-10-01 17:25:08 +02:00
SUMMARY.md Fix links; currently links in REST-documentation only work in the RESTDESCRIPTION :-( 2015-10-01 13:30:55 +02: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.

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.