diff --git a/README.md b/README.md index 414b70820..22826e246 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,140 @@ The driver is being tested with ArangoDB 2.5, 2.6 and 2.7 using Node.js 0.12, 4. As of version 4.0.0 of this driver, a minified standalone browser bundle is also available. +#Table of Contents +- [Install](README.md#install) +- [Basic usage example](README.md#basic-usage-example) +- [API](README.md#api) + - [Database API](README.md#database-api) + - [New database](README.md#new-database) + - [Manipulating databases](readme.md#manipulating-databases) + - [database.useDatabase](readme.md#databaseusedatabase) + - [database.createDatabase](readme.md#databasecreatedatabase) + - [database.get](readme.md#databaseget) + - [database.listDatabases](readme.md#databaselistdatabases) + - [database.listUserDatabases](readme.md#databaselistuserdatabases) + - [database.dropDatabase](readme.md#databasedropdatabase) + - [database.truncate](readme.md#databasetruncate) + - [Accessing Collections](readme.md#accessing-collections) + - [database.collection](readme.md#databasecollection) + - [database.edgeCollection](readme.md#databaseedgecollection) + - [database.listCollections](reamde.md#databaselistCollections) + - [database.collections](reamde.md#databasecollections) + - [Accessing graphs](readme.md#Accessing-graphs) + - [database.graph](reame.md#databasegraph) + - [database.listGraphs](readme.md#databaselistGraphs) + - [database.graphs](readme.md#databasegraphs) + - [Transactions](readme.md#transactions) + - [database.transaction](reamde.md#databasetransaction) + - [Queries](reamde.md#Queries) + - [database.query](reamde.md#databasequery) + - [aqlQuery](reamde.md#aqlQuery) + - [Managing AQL user functions](reamde.md#Managing-AQL-user-functions) + - [database.listFunctions](reamde.md#databaselistFunctions) + - [database.createFunction](reamde.md#databasecreateFunction) + - [database.dropFunction](reamde.md#databasedropFunction) + - [Arbitrary HTTP routes](reamde.md#Arbitrary-HTTP-routes) + - [database.route](reamde.md#databaseroute) + - [Cursor API](reamde.md#Cursor-API) + - [cursor.count](reamde.md#cursorcount) + - [cursor.all](reamde.md#cursorall) + - [cursor.next](reamde.md#cursornext) + - [cursor.hasNext](reamde.md#cursorhasNext) + - [cursor.each](reamde.md#cursoreach) + - [cursor.every](reamde.md#cursorevery) + - [cursor.some](reamde.md#cursorsome) + - [cursor.map](reamde.md#cursormap) + - [cursor.reduce](reamde.md#cursorreduce) + - [Route API](reamde.md#Route-API) + - [route.route](reamde.md#routeroute) + - [route.get](reamde.md#routeget) + - [route.post](reamde.md#routepost) + - [route.put](reamde.md#routeput) + - [route.patch](reamde.md#routepatch) + - [route.delete](reamde.md#routedelete) + - [route.head](reamde.md#routehead) + - [route.request](reamde.md#routerequest) + - [Collection API](reamde.md#Collection-API) + - [Getting information about the collection](reamde.md#Getting-information-about-the-collection) + - [collection.get](reamde.md#collectionget) + - [collection.properties](reamde.md#collectionproperties) + - [collection.count](reamde.md#collectioncount) + - [collection.figures](reamde.md#collectionfigures) + - [collection.revision](reamde.md#collectionrevision) + - [collection.checksum](reamde.md#collectionchecksum) + - [Manipulating the collection](reamde.md#Manipulating-the-collection) + - [collection.create](reamde.md#collectioncreate) + - [collection.load](reamde.md#collectionload) + - [collection.unload](reamde.md#collectionunload) + - [collection.setProperties](reamde.md#collectionsetProperties) + - [collection.rename](reamde.md#collectionrename) + - [collection.rotate](reamde.md#collectionrotate) + - [collection.truncate](reamde.md#collectiontruncate) + - [collection.drop](reamde.md#collectiondrop) + - [Manipulating indexes](reamde.md#Manipulating-indexes) + - [collection.createIndex](reamde.md#collectioncreateIndex) + - [collection.createCapConstraint](reamde.md#collectioncreateCapConstraint) + - [collection.createHashIndex](reamde.md#collectioncreateHashIndex) + - [collection.createSkipList](reamde.md#collectioncreateSkipList) + - [collection.createGeoIndex](reamde.md#collectioncreateGeoIndex) + - [collection.createFulltextIndex](reamde.md#collectioncreateFulltextIndex) + - [collection.index](reamde.md#collectionindex) + - [collection.indexes](reamde.md#collectionindexes) + - [collection.dropIndex](reamde.md#collection.dropIndex) + - [Simple queries](reamde.md#Simple-queries) + - [collection.all](reamde.md#collectionall) + - [collection.any](reamde.md#collectionany) + - [collection.first](reamde.md#collectionfirst) + - [collection.last](reamde.md#collectionlast) + - [collection.byExample](reamde.md#collectionbyExample) + - [collection.firstExample](reamde.md#collectionfirstExample) + - [collection.removeByExample](reamde.md#collectionremoveByExample) + - [collection.replaceByExample](reamde.md#collectionreplaceByExample) + - [collection.updateByExample](reamde.md#collectionupdateByExample) + - [collection.lookupByKeys](reamde.md#collectionlookupByKeys) + - [collection.removeByKeys](reamde.md#collectionremoveByKeys) + - [Bulk importing documents](reamde.md#Bulk-importing-documents) + - [collection.import](reamde.md#collectionimport) + - [Manipulating documents](reamde.md#Manipulating-documents) + - [collection.replace](reamde.md#collectionreplace) + - [collection.update](reamde.md#collectionupdate) + - [collection.remove](reamde.md#collectionremove) + - [collection.list](reamde.md#collectionlist) + - [DocumentCollection API](reamde.md#DocumentCollection-API) + - [documentCollection.document](reamde.md#documentCollectiondocument) + - [documentCollection.save](reamde.md#documentCollectionsave) + - [EdgeCollection API](reamde.md#EdgeCollection-API) + - [edgeCollection.edge](reamde.md#edgeCollectionedge) + - [edgeCollection.save](reamde.md#edgeCollectionsave) + - [edgeCollection.edges](reamde.md#edgeCollectionedges) + - [edgeCollection.inEdges](reamde.md#edgeCollectioninEdges) + - [edgeCollection.outEdges](reamde.md#edgeCollectionoutEdges) + - [edgeCollection.traversal](reamde.md#edgeCollectiontraversal) + - [Graph API](reamde.md#Graph-API) + - [graph.get](reamde.md#graphget) + - [graph.create](reamde.md#graphcreate) + - [graph.drop](reamde.md#graphdrop) + - [Manipulating vertices](reamde.md#Manipulating-vertices) + - [graph.vertexCollection](reamde.md#graphvertexCollection) + - [graph.addVertexCollection](reamde.md#graphaddVertexCollection) + - [graph.removeVertexCollection](reamde.md#graphremoveVertexCollection) + - [Manipulating edges](reamde.md#Manipulating-edges) + - [graph.edgeCollection](reamde.md#graphedgeCollection) + - [graph.addEdgeDefinition](reamde.md#graphaddEdgeDefinition) + - [graph.replaceEdgeDefinition](reamde.md#graphreplaceEdgeDefinition) + - [graph.removeEdgeDefinition](reamde.md#graphremoveEdgeDefinition) + - [graph.traversal](reamde.md#graphtraversal) + - [GraphVertexCollection API](reamde.md#GraphVertexCollection-API) + - [graphVertexCollection.vertex](reamde.md#graphVertexCollectionvertex) + - [graphVertexCollection.save](reamde.md#graphVertexCollectionsave) + - [GraphEdgeCollection API](reamde.md#GraphEdgeCollection-API) + - [graphEdgeCollection.edge](reamde.md#graphEdgeCollectionedge) + - [graphEdgeCollection.save](reamde.md#graphEdgeCollectionsave) + - [graphEdgeCollection.edges](reamde.md#graphEdgeCollectionedges) + - [graphEdgeCollection.inEdges](reamde.md#graphEdgeCollectioninEdges) + - [graphEdgeCollection.outEdges](reamde.md#graphEdgeCollectionoutEdges) + - [graphEdgeCollection.traversal](reamde.md#graphEdgeCollectiontraversal) + # Install ## With NPM