mirror of https://gitee.com/bigwinds/arangodb
202 lines
9.9 KiB
Markdown
202 lines
9.9 KiB
Markdown
#
|
|
# Summary
|
|
#
|
|
#* [First Steps](FirstSteps/README.md)
|
|
# * [Getting Familiar](FirstSteps/GettingFamiliar.md)
|
|
* [Getting Started](GettingStarted/README.md)
|
|
# move to administration (command line options)?
|
|
#* [Install and run the server](FirstSteps/Arangod.md)
|
|
* [Installing](GettingStarted/Installing/README.md)
|
|
* [Linux](GettingStarted/Installing/Linux.md)
|
|
* [Mac OS X](GettingStarted/Installing/MacOSX.md)
|
|
* [Windows](GettingStarted/Installing/Windows.md)
|
|
* [ARM](GettingStarted/Installing/ARM.md)
|
|
* [Compiling](GettingStarted/Installing/Compiling.md)
|
|
* [Cluster setup](GettingStarted/Installing/Cluster.md)
|
|
* [Using the Web Interface](GettingStarted/WebInterface.md)
|
|
* [Your first queries](GettingStarted/AqlQueries.md)
|
|
* [Coming from SQL](GettingStarted/ComingFromSql.md)
|
|
* [Coming from MongoDB](GettingStarted/ComingFromMongoDb.md)
|
|
#
|
|
* [Scalability](Scalability/README.md)
|
|
* [Joins](Scalability/Joins.md)
|
|
#
|
|
* [Data model & modeling](DataModeling/README.md)
|
|
#* [Collections](FirstSteps/CollectionsAndDocuments.md)
|
|
* [Concepts](DataModeling/Concepts.md)
|
|
* [Databases](DataModeling/Databases/README.md)
|
|
* [Working with Databases](DataModeling/Databases/WorkingWith.md)
|
|
* [Notes about Databases](DataModeling/Databases/Notes.md)
|
|
* [Collections](DataModeling/Collections/README.md)
|
|
* [Collection Methods](DataModeling/Collections/CollectionMethods.md)
|
|
* [Database Methods](DataModeling/Collections/DatabaseMethods.md)
|
|
* [Documents](DataModeling/Documents/README.md)
|
|
* [Basics and Terminology](DataModeling/Documents/DocumentAddress.md)
|
|
* [Collection Methods](DataModeling/Documents/DocumentMethods.md)
|
|
* [Database Methods](DataModeling/Documents/DatabaseMethods.md)
|
|
* [Graphs, Vertices & Edges](DataModeling/GraphsVerticesEdges.md)
|
|
* [Naming Conventions](DataModeling/NamingConventions/README.md)
|
|
* [Database Names](DataModeling/NamingConventions/DatabaseNames.md)
|
|
* [Collection Names](DataModeling/NamingConventions/CollectionNames.md)
|
|
* [Document Keys](DataModeling/NamingConventions/DocumentKeys.md)
|
|
* [Attribute Names](DataModeling/NamingConventions/AttributeNames.md)
|
|
* [Modeling Relationships](DataModeling/ModelingRelationships.md)
|
|
# Best practice? (Date handling, Versioning / Revisions
|
|
# Add a fake chapter for AQL to go to the AQL docs?
|
|
#* [AQL query language](Aql/README.md)
|
|
# * [10-minutes guide](Aql/TenMinutesGuide.md)
|
|
# * [Using Joins in AQL](Aql/UsingJoins.md)
|
|
# * [Dynamic attribute names](Aql/DynamicAttributes.md)
|
|
# ...
|
|
#
|
|
* [Indexing](Indexing/README.md)
|
|
* [Index Basics](Indexing/IndexBasics.md)
|
|
* [Which Index to use when](Indexing/WhichIndex.md)
|
|
* [How ArangoDB uses indexes](Indexing/HowArangoDBUsesIndexes.md)
|
|
* [Working with Indexes](Indexing/WorkingWithIndexes.md)
|
|
* [Hash Indexes](Indexing/Hash.md)
|
|
* [Skiplists](Indexing/Skiplist.md)
|
|
* [Fulltext Indexes](Indexing/Fulltext.md)
|
|
* [Geo Indexes](Indexing/Geo.md)
|
|
* [Cap Constraint](Indexing/Cap.md)
|
|
#
|
|
* [Graphs](Graphs/README.md)
|
|
* [General Graphs](Graphs/GeneralGraphs/README.md)
|
|
* [Graph Management](Graphs/GeneralGraphs/Management.md)
|
|
* [Graph Functions](Graphs/GeneralGraphs/Functions.md)
|
|
* [Fluent Query Interface](Graphs/GeneralGraphs/FluentAQLInterface.md)
|
|
* [Traversals](Graphs/Traversals/README.md)
|
|
* [Using Traversal Objects](Graphs/Traversals/UsingTraversalObjects.md)
|
|
* [Example Data](Graphs/Traversals/ExampleData.md)
|
|
* [Working with Edges](Graphs/Edges/README.md)
|
|
#
|
|
# Will be replaced by new FOTF docs
|
|
* [Foxx microservices](Foxx/README.md)
|
|
* [In a nutshell](Foxx/Nutshell/README.md)
|
|
* [Install](Foxx/Install/README.md)
|
|
* [Github](Foxx/Install/Github.md)
|
|
* [Store](Foxx/Install/Store.md)
|
|
* [Local](Foxx/Install/Local.md)
|
|
* [Remote](Foxx/Install/Remote.md)
|
|
* [Generate](Foxx/Install/Generate.md)
|
|
* [Development](Foxx/Develop/README.md)
|
|
* [Dev-Mode](Foxx/Develop/Developmentmode.md)
|
|
* [Debugging](Foxx/Develop/Debugging.md)
|
|
* [Source Files](Foxx/Develop/Folder.md)
|
|
* [Controller](Foxx/Develop/Controller.md)
|
|
* [Scripts](Foxx/Develop/Scripts.md)
|
|
* [Model](Foxx/Develop/Model.md)
|
|
* [Repository](Foxx/Develop/Repository.md)
|
|
* [Queries](Foxx/Develop/Queries.md)
|
|
* [Sessions](Foxx/Develop/Sessions.md)
|
|
* [Background Tasks](Foxx/Develop/Queues.md)
|
|
* [Console API](Foxx/Develop/Console.md)
|
|
* [Meta information](Foxx/Develop/Manifest.md)
|
|
* [Exports](Foxx/Develop/Exports.md)
|
|
* [Documentation](Foxx/Develop/ApiDocumentation.md)
|
|
* [Production](Foxx/Production/README.md)
|
|
* [Prod-Mode](Foxx/Production/Productionmode.md)
|
|
* [Debugging](Foxx/Production/Debugging.md)
|
|
* [New Versions](Foxx/Production/Upgrade.md)
|
|
* [Cluster](Foxx/Cluster/README.md)
|
|
* [Install](Foxx/Cluster/Install.md)
|
|
* [Setup & Teardown](Foxx/Cluster/Scripts.md)
|
|
* [Transactions](Transactions/README.md)
|
|
* [Transaction invocation](Transactions/TransactionInvocation.md)
|
|
* [Passing parameters](Transactions/Passing.md)
|
|
* [Locking and isolation](Transactions/LockingAndIsolation.md)
|
|
* [Durability](Transactions/Durability.md)
|
|
* [Limitations](Transactions/Limitations.md)
|
|
#
|
|
# Use cases / Advanced usage / Best practice (?)
|
|
#
|
|
* [Administration](Administration/README.md)
|
|
* [ArangoDB Shell](Administration/Arangosh/README.md)
|
|
* [Shell Output](Administration/Arangosh/Output.md)
|
|
* [Configuration](Administration/Arangosh/Configuration.md)
|
|
# relocate file?
|
|
* [Details](GettingStarted/Arangosh.md)
|
|
* [Arangoimp](Administration/Arangoimp.md)
|
|
* [Arangodump](Administration/Arangodump.md)
|
|
* [Arangorestore](Administration/Arangorestore.md)
|
|
* [Upgrading](Administration/Upgrading/README.md)
|
|
* [Upgrading to 2.8](Administration/Upgrading/Upgrading28.md)
|
|
* [Upgrading to 2.6](Administration/Upgrading/Upgrading26.md)
|
|
* [Upgrading to 2.5](Administration/Upgrading/Upgrading25.md)
|
|
* [Upgrading to 2.4](Administration/Upgrading/Upgrading24.md)
|
|
* [Upgrading to 2.3](Administration/Upgrading/Upgrading23.md)
|
|
* [Upgrading to 2.2](Administration/Upgrading/Upgrading22.md)
|
|
* [Server Configuration](Administration/Configuration/README.md)
|
|
* [Arangod options](Administration/Configuration/Arangod.md)
|
|
* [Write-ahead log options](Administration/Configuration/Wal.md)
|
|
* [Managing Endpoints](Administration/Configuration/Endpoint.md)
|
|
* [Cluster options](Administration/Configuration/Cluster.md)
|
|
* [Logging options](Administration/Configuration/Logging.md)
|
|
* [Communication options](Administration/Configuration/Communication.md)
|
|
* [Authentication](Administration/Configuration/Authentication.md)
|
|
* [Replication](Administration/Replication/README.md)
|
|
* [Components](Administration/Replication/Components.md)
|
|
* [Example Setup](Administration/Replication/ExampleSetup.md)
|
|
* [Syncing Collections](Administration/Replication/SyncingCollections.md)
|
|
* [Replication Limitations](Administration/Replication/Limitations.md)
|
|
* [Replication Overhead](Administration/Replication/Overhead.md)
|
|
* [Sharding](Administration/Sharding/README.md)
|
|
* [How to try it out](Administration/Sharding/HowTo.md)
|
|
* [Implementation](Administration/Sharding/StatusOfImplementation.md)
|
|
* [Authentication](Administration/Sharding/Authentication.md)
|
|
* [Firewall setup](Administration/Sharding/FirewallSetup.md)
|
|
#
|
|
* [Deployment](Deployment/README.md)
|
|
#
|
|
* [Troubleshooting](Troubleshooting/README.md)
|
|
* [Emergency Console](Troubleshooting/EmergencyConsole.md)
|
|
* [Datafile Debugger](Troubleshooting/DatafileDebugger.md)
|
|
* [Arangob](Troubleshooting/Arangob.md)
|
|
#
|
|
* [Architecture](Architecture/README.md)
|
|
* [Write-ahead log](Architecture/WriteAheadLog.md)
|
|
* [Server Internals](Architecture/ServerInternals.md)
|
|
#
|
|
* [Release notes](ReleaseNotes/README.md)
|
|
* [Whats New in 2.8](ReleaseNotes/NewFeatures28.md)
|
|
* [Whats New in 2.7](ReleaseNotes/NewFeatures27.md)
|
|
* [Whats New in 2.6](ReleaseNotes/NewFeatures26.md)
|
|
* [Whats New in 2.5](ReleaseNotes/NewFeatures25.md)
|
|
* [Whats New in 2.4](ReleaseNotes/NewFeatures24.md)
|
|
* [Whats New in 2.3](ReleaseNotes/NewFeatures23.md)
|
|
* [Whats New in 2.2](ReleaseNotes/NewFeatures22.md)
|
|
* [Whats New in 2.1](ReleaseNotes/NewFeatures21.md)
|
|
# Place next to Upgrading instead?
|
|
* [Incompatible changes in 2.8](ReleaseNotes/UpgradingChanges28.md)
|
|
* [Incompatible changes in 2.7](ReleaseNotes/UpgradingChanges27.md)
|
|
* [Incompatible changes in 2.6](ReleaseNotes/UpgradingChanges26.md)
|
|
* [Incompatible changes in 2.5](ReleaseNotes/UpgradingChanges25.md)
|
|
* [Incompatible changes in 2.4](ReleaseNotes/UpgradingChanges24.md)
|
|
* [Incompatible changes in 2.3](ReleaseNotes/UpgradingChanges23.md)
|
|
#
|
|
* [Appendix](Appendix/README.md)
|
|
* [JavaScript Modules](Appendix/JavaScriptModules/README.md)
|
|
* ["console"](Appendix/Modules/Console.md)
|
|
* ["fs"](Appendix/Modules/FS.md)
|
|
* ["process"](Appendix/Modules/Process.md)
|
|
* ["request"](Appendix/Modules/Request.md)
|
|
* ["actions"](Appendix/Modules/Actions.md)
|
|
* ["queries"](Appendix/Modules/Queries.md)
|
|
* ["planner"](Appendix/Modules/Planner.md)
|
|
* [Write-ahead log](Appendix/Modules/WAL.md)
|
|
* [Task Management](Appendix/Modules/Tasks.md)
|
|
* [Deprecated](Appendix/Deprecated/README.md)
|
|
* [Simple Queries](Appendix/Deprecated/SimpleQueries/README.md)
|
|
* [Sequential Access](Appendix/Deprecated/SimpleQueries/Access.md)
|
|
* [Pagination](Appendix/Deprecated/SimpleQueries/Pagination.md)
|
|
* [Modification Queries](Appendix/Deprecated/SimpleQueries/ModificationQueries.md)
|
|
* [Geo Queries](Appendix/Deprecated/SimpleQueries/GeoQueries.md)
|
|
* [Fulltext Queries](Appendix/Deprecated/SimpleQueries/FulltextQueries.md)
|
|
* [Actions](Appendix/Deprecated/Actions/README.md)
|
|
* [Delivering HTML Pages](Appendix/Deprecated/Actions/HtmlExample.md)
|
|
* [Json Objects](Appendix/Deprecated/Actions/JsonExample.md)
|
|
* [Modifying](Appendix/Deprecated/Actions/Modifying.md)
|
|
# Link to here from arangosh, actions, foxx, transactions
|
|
* [Error codes and meanings](Appendix/ErrorCodes/README.md)
|
|
* [Glossary](Appendix/Glossary.md)
|