1
0
Fork 0
arangodb/Documentation/Books/Manual
Alan Plum 34e8fdb90f
Port Configuration.md
2016-06-19 23:45:49 +02:00
..
Administration frontend docu 2016-06-19 17:45:14 +02:00
Appendix Remove process module chapter 2016-06-19 21:57:13 +02:00
Architecture cleanup 2016-06-17 17:34:11 +02:00
DataModeling cleanup 2016-06-17 17:34:11 +02:00
Deployment One more reformatting. 2016-06-16 22:33:24 -07:00
Foxx Port Configuration.md 2016-06-19 23:45:49 +02:00
GettingStarted cleanup 2016-06-17 17:34:11 +02:00
Graphs cleanup 2016-06-17 17:34:11 +02:00
Indexing Add info about _from and _to in indexes 2016-06-14 02:19:46 +02:00
ReleaseNotes Make DataModification -> DataQueries in docs 2016-06-14 02:19:46 +02:00
Scalability A lot of progress with the Scalability chapter, nearly ready. 2016-06-18 23:33:41 -07:00
Transactions Rename Users documentation to Manual 2016-05-24 16:09:21 +02:00
Troubleshooting Pull out some content from stash and use it in Installing / Troubleshooting pages 2016-06-15 21:18:42 +02:00
styles Don't ever use IDs for styling 2016-06-17 17:27:49 +02:00
HEADER.html Don't ever use IDs for styling 2016-06-17 17:27:49 +02:00
README.mdpp cleanup 2016-06-17 17:34:11 +02:00
SUMMARY.md Later 2016-06-19 22:51:03 +02:00
book.json Properly reference that we need 2.6.7 without re-installing gitbook over and over. 2016-05-31 21:53:00 +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. 

New and eager to try it out? Start right away with our beginner's guide: [Getting Started](GettingStarted/README.md)

!SUBSECTION Overview

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:

* installing ArangoDB on a [**cluster**](Deployment/README.md) is as easy as installing an app on your mobile
* [**Flexible data modeling**](DataModeling/README.md): model your data as combination of key-value pairs, documents or graphs - perfect for social relations
* [**Powerful query language**](../AQL/index.html) (AQL) to retrieve and modify data 
* Use ArangoDB as an [**application server**](Foxx/README.md) and fuse your application and database together for maximal throughput
* [**Transactions**](Transactions/README.md): run queries on multiple documents or collections with optional transactional consistency and isolation
* [**Replication** and **Sharding**](Administration/README.md): set up the database in a master-slave configuration or spread bigger datasets across multiple servers
* 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
* JavaScript for all: **no language zoo**, you can use one language from your browser to your back-end
* It is **open source** (Apache License 2.0)

!SUBSECTION Structure of the Documentation

In this documentation you can inform yourself about all the functions, features and programs ArangoDB provides for you.  There are four handbooks: this manual which describes ArangoDB and its features in detail. The [AQL handbook](../AQL/index.html) explains the query language AQL of ArangoDB. The [HTTP handbook](../HTTP/index.html) which describes the internal API of ArangoDB that is used to communicate with clients. In general, the HTTP handbook will be of interest to driver developers. If you use any of the existing drivers for the language of your choice, you can skip this handbook. 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.

Features are illustrated with interactive usage examples; you can cut'n'paste them into [arangosh](Administration/Arangosh/README.md) to try them out. The http [REST-API](../HTTP/index.html) for driver developers 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.

!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.
- [Slack](http://slack.arangodb.com), our community chat

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.