Skip to content

Commit c520cb1

Browse files
committed
Add TOC to README.md
Fixes #122.
1 parent 645143b commit c520cb1

File tree

1 file changed

+133
-0
lines changed

1 file changed

+133
-0
lines changed

README.md

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,139 @@ try {
9292
}
9393
```
9494

95+
## Table of Contents
96+
97+
* [Database API](#database-api)
98+
* [new Database](#new-database)
99+
* [Manipulating databases](#manipulating-databases)
100+
* [database.useDatabase](#databaseusedatabase)
101+
* [database.createDatabase](#databasecreatedatabase)
102+
* [database.get](#databaseget)
103+
* [database.listDatabases](#databaselistdatabases)
104+
* [database.listUserDatabases](#databaselistuserdatabases)
105+
* [database.dropDatabase](#databasedropdatabase)
106+
* [database.truncate](#databasetruncate)
107+
* [Accessing collections](#accessing-collections)
108+
* [database.collection](#databasecollection)
109+
* [database.edgeCollection](#databaseedgecollection)
110+
* [database.listCollections](#databaselistcollections)
111+
* [database.collections](#databasecollections)
112+
* [Accessing graphs](#accessing-graphs)
113+
* [database.graph](#databasegraph)
114+
* [database.listGraphs](#databaselistgraphs)
115+
* [database.graphs](#databasegraphs)
116+
* [Transactions](#transactions)
117+
* [database.transaction](#databasetransaction)
118+
* [Queries](#queries)
119+
* [database.query](#databasequery)
120+
* [aqlQuery](#aqlquery)
121+
* [Managing AQL user functions](#managing-aql-user-functions)
122+
* [database.listFunctions](#databaselistfunctions)
123+
* [database.createFunction](#databasecreatefunction)
124+
* [database.dropFunction](#databasedropfunction)
125+
* [Arbitrary HTTP routes](#arbitrary-http-routes)
126+
* [database.route](#databaseroute)
127+
* [Cursor API](#cursor-api)
128+
* [cursor.count](#cursorcount)
129+
* [cursor.all](#cursorall)
130+
* [cursor.next](#cursornext)
131+
* [cursor.hasNext](#cursorhasnext)
132+
* [cursor.each](#cursoreach)
133+
* [cursor.every](#cursorevery)
134+
* [cursor.some](#cursorsome)
135+
* [cursor.map](#cursormap)
136+
* [cursor.reduce](#cursorreduce)
137+
* [Route API](#route-api)
138+
* [route.route](#routeroute)
139+
* [route.get](#routeget)
140+
* [route.post](#routepost)
141+
* [route.put](#routeput)
142+
* [route.patch](#routepatch)
143+
* [route.delete](#routedelete)
144+
* [route.head](#routehead)
145+
* [route.request](#routerequest)
146+
* [Collection API](#collection-api)
147+
* [Getting information about the collection](#getting-information-about-the-collection)
148+
* [collection.get](#collectionget)
149+
* [collection.properties](#collectionproperties)
150+
* [collection.count](#collectioncount)
151+
* [collection.figures](#collectionfigures)
152+
* [collection.revision](#collectionrevision)
153+
* [collection.checksum](#collectionchecksum)
154+
* [Manipulating the collection](#manipulating-the-collection)
155+
* [collection.create](#collectioncreate)
156+
* [collection.load](#collectionload)
157+
* [collection.unload](#collectionunload)
158+
* [collection.setProperties](#collectionsetproperties)
159+
* [collection.rename](#collectionrename)
160+
* [collection.rotate](#collectionrotate)
161+
* [collection.truncate](#collectiontruncate)
162+
* [collection.drop](#collectiondrop)
163+
* [Manipulating indexes](#manipulating-indexes)
164+
* [collection.createIndex](#collectioncreateindex)
165+
* [collection.createCapConstraint](#collectioncreatecapconstraint)
166+
* [collection.createHashIndex](#collectioncreatehashindex)
167+
* [collection.createSkipList](#collectioncreateskiplist)
168+
* [collection.createGeoIndex](#collectioncreategeoindex)
169+
* [collection.createFulltextIndex](#collectioncreatefulltextindex)
170+
* [collection.index](#collectionindex)
171+
* [collection.indexes](#collectionindexes)
172+
* [collection.dropIndex](#collectiondropindex)
173+
* [Simple queries](#simple-queries)
174+
* [collection.all](#collectionall)
175+
* [collection.any](#collectionany)
176+
* [collection.first](#collectionfirst)
177+
* [collection.last](#collectionlast)
178+
* [collection.byExample](#collectionbyexample)
179+
* [collection.firstExample](#collectionfirstexample)
180+
* [collection.removeByExample](#collectionremovebyexample)
181+
* [collection.replaceByExample](#collectionreplacebyexample)
182+
* [collection.updateByExample](#collectionupdatebyexample)
183+
* [collection.lookupByKeys](#collectionlookupbykeys)
184+
* [collection.removeByKeys](#collectionremovebykeys)
185+
* [collection.fulltext](#collectionfulltext)
186+
* [Bulk importing documents](#bulk-importing-documents)
187+
* [collection.import](#collectionimport)
188+
* [Manipulating documents](#manipulating-documents)
189+
* [collection.replace](#collectionreplace)
190+
* [collection.update](#collectionupdate)
191+
* [collection.remove](#collectionremove)
192+
* [collection.list](#collectionlist)
193+
* [DocumentCollection API](#documentcollection-api)
194+
* [documentCollection.document](#documentcollectiondocument)
195+
* [documentCollection.save](#documentcollectionsave)
196+
* [EdgeCollection API](#edgecollection-api)
197+
* [edgeCollection.edge](#edgecollectionedge)
198+
* [edgeCollection.save](#edgecollectionsave)
199+
* [edgeCollection.edges](#edgecollectionedges)
200+
* [edgeCollection.inEdges](#edgecollectioninedges)
201+
* [edgeCollection.outEdges](#edgecollectionoutedges)
202+
* [edgeCollection.traversal](#edgecollectiontraversal)
203+
* [Graph API](#graph-api)
204+
* [graph.get](#graphget)
205+
* [graph.create](#graphcreate)
206+
* [graph.drop](#graphdrop)
207+
* [Manipulating vertices](#manipulating-vertices)
208+
* [graph.vertexCollection](#graphvertexcollection)
209+
* [graph.addVertexCollection](#graphaddvertexcollection)
210+
* [graph.removeVertexCollection](#graphremovevertexcollection)
211+
* [Manipulating edges](#manipulating-edges)
212+
* [graph.edgeCollection](#graphedgecollection)
213+
* [graph.addEdgeDefinition](#graphaddedgedefinition)
214+
* [graph.replaceEdgeDefinition](#graphreplaceedgedefinition)
215+
* [graph.removeEdgeDefinition](#graphremoveedgedefinition)
216+
* [graph.traversal](#graphtraversal)
217+
* [GraphVertexCollection API](#graphvertexcollection-api)
218+
* [graphVertexCollection.vertex](#graphvertexcollectionvertex)
219+
* [graphVertexCollection.save](#graphvertexcollectionsave)
220+
* [GraphEdgeCollection API](#graphedgecollection-api)
221+
* [graphEdgeCollection.edge](#graphedgecollectionedge)
222+
* [graphEdgeCollection.save](#graphedgecollectionsave)
223+
* [graphEdgeCollection.edges](#graphedgecollectionedges)
224+
* [graphEdgeCollection.inEdges](#graphedgecollectioninedges)
225+
* [graphEdgeCollection.outEdges](#graphedgecollectionoutedges)
226+
* [graphEdgeCollection.traversal](#graphedgecollectiontraversal)
227+
95228
## Database API
96229

97230
### new Database

0 commit comments

Comments
 (0)