arangodb/Documentation/Books/Manual/SUMMARY.md

Summary

* First Steps #TODO

* Getting Familiar #TODO

• Getting Started

  move to administration (command line options)?

  * Install and run the server #TODO

  • Installing
    • Linux
    • Mac OS X
    • Windows
    • Compiling
    • Cluster setup
  • Authentication
  • Accessing the Web Interface
  • Coming from SQL

  * Coming from MongoDB #TODO

• Scalability
  • Architecture
  • Data models
  • Limitations

• Data model & modeling

* Collections #TODO

• Concepts
• Databases
  • Working with Databases
  • Notes about Databases
• Collections
  • Collection Methods
  • Database Methods
• Documents
  • Basics and Terminology
  • Collection Methods
  • Database Methods
• Graphs, Vertices & Edges
• Naming Conventions
  • Database Names
  • Collection Names
  • Document Keys
  • Attribute Names
• Modeling Relationships

• Indexing
  • Index Basics
  • Which index to use when
  • Index Utilization
  • Working with Indexes
    • Hash Indexes
    • Skiplists
    • Persistent
    • Fulltext Indexes
    • Geo Indexes

• Graphs
  • General Graphs
    • Graph Management
    • Graph Functions
  • Traversals
    • Using Traversal Objects
    • Example Data
  • Working with Edges

• Foxx Microservices
  • At a glance
  • Getting started
  • Service manifest
  • Service context
  • Configuration
  • Dependencies
  • Routers
    • Endpoints
    • Middleware
    • Request
    • Response
  • Sessions middleware
    • Session storages
      • Collection storage
      • JWT storage
    • Session transports
      • Cookie transport
      • Header transport
  • Serving files
  • Writing tests
  • Scripts and queued jobs
  • Migrating 2.x services
  • Legacy compatibility mode
  • User management
  • Related modules
    • Authentication
    • OAuth 2.0
• Transactions
  • Transaction invocation
  • Passing parameters
  • Locking and isolation
  • Durability
  • Limitations

Use cases / Advanced usage / Best practice (?)

• Deployment
  • Single instance
  • Cluster: Local test
  • Cluster: DC/OS
  • Cluster: Docker

• Administration
  • Managing Users
  • Durability
  • ArangoDB Shell
    • Shell Output
    • Configuration

    relocate file?

    • Details
  • Arangoimp
  • Arangodump
  • Arangorestore
  • Upgrading
    • Upgrading to 3.0
    • Upgrading to 2.8
    • Upgrading to 2.6
    • Upgrading to 2.5
    • Upgrading to 2.4
    • Upgrading to 2.3
    • Upgrading to 2.2
  • Server Configuration
    • Arangod options
    • Write-ahead log options
    • Managing Endpoints
    • Cluster options
    • Logging options
    • Communication options
    • Authentication
  • Replication
    • Asynchronous Replication
      • Components
      • Example Setup
      • Syncing Collections
      • Replication Limitations
    • Synchronous Replication
      • Implementation
      • Configuration
  • Sharding

* Authentication

* Firewall setup

• Web Interface
  • Queries
  • Collections
  • Cluster
    • Nodes
  • Graphs
    • Graph Viewer

• Troubleshooting
  • arangod
  • Emergency Console
  • Datafile Debugger
  • Arangobench

• Architecture
  • Write-ahead log
  • Server Internals

• Release notes
  • Whats New in 3.0
  • Whats New in 2.8
  • Whats New in 2.7
  • Whats New in 2.6
  • Whats New in 2.5
  • Whats New in 2.4
  • Whats New in 2.3
  • Whats New in 2.2
  • Whats New in 2.1

  Place next to Upgrading instead?

  • Incompatible changes in 3.0
  • Incompatible changes in 2.8
  • Incompatible changes in 2.7
  • Incompatible changes in 2.6
  • Incompatible changes in 2.5
  • Incompatible changes in 2.4
  • Incompatible changes in 2.3

• Appendix
  • References
    • db
    • collection
  • JavaScript Modules
    • console
    • fs
    • process
    • request
    • actions
    • queries
    • Write-ahead log
    • Task Management
  • Deprecated
    • Simple Queries
      • Sequential Access
      • Pagination
      • Modification Queries
      • Geo Queries
      • Fulltext Queries
    • Actions
      • Delivering HTML Pages
      • Json Objects
      • Modifying

  Link to here from arangosh, actions, foxx, transactions

  • Error codes and meanings
  • Glossary