1
0
Fork 0

added reference pages

This commit is contained in:
Frank Celler 2016-06-13 14:32:45 +02:00
parent 328b7681f1
commit a27fef1a5c
5 changed files with 94 additions and 6 deletions

View File

@ -0,0 +1,50 @@
!CHAPTER The "collection" Object
The following methods exists on the collection object (returned by *db.name*):
*Collection*
* [collection.checksum()](../../DataModeling/Collections/CollectionMethods.html#checksum)
* [collection.count()](../../DataModeling/Collections/CollectionMethods.html#count)
* [collection.drop()](../../DataModeling/Collections/CollectionMethods.html#drop)
* [collection.figures()](../../DataModeling/Collections/CollectionMethods.html#figures)
* [collection.load()](../../DataModeling/Collections/CollectionMethods.html#load)
* [collection.properties()](../../DataModeling/Collections/CollectionMethods.html#properties)
* [collection.reserve()](../../DataModeling/Collections/CollectionMethods.html#reserve)
* [collection.revision()](../../DataModeling/Collections/CollectionMethods.html#revision)
* [collection.rotate()](../../DataModeling/Collections/CollectionMethods.html#rotate)
* [collection.toArray()](../../DataModeling/Collections/CollectionMethods.html#toarray)
* [collection.truncate()](../../DataModeling/Collections/CollectionMethods.html#truncate)
* [collection.type()](../../DataModeling/Collections/CollectionMethods.html#type)
* [collection.unload()](../../DataModeling/Collections/CollectionMethods.html#unload)
*Indexes*
* [collection.dropIndex(index)](../../Indexing/WorkingWithIndexes.html#dropping-an-index)
* [collection.ensureIndex(description)](../../Indexing/WorkingWithIndexes.html#creating-an-index)
* [collection.getIndexes(name)](../../Indexing/WorkingWithIndexes.html#listing-all-indexes-of-a-collection)
* [collection.index(index)](../../Indexing/WorkingWithIndexes.html#index-identifiers-and-handles)
*Document*
* [collection.all()](../../DataModeling/Collections/CollectionMethods.html#all)
* [collection.any()](../../DataModeling/Collections/CollectionMethods.html#any)
* [collection.closedRange(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.html#closed-range)
* [collection.document(object)](../../DataModeling/Collections/CollectionMethods.html#document)
* [collection.documents(keys)](../../DataModeling/Collections/CollectionMethods.html#lookup-by-keys)
* [collection.edges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc)
* [collection.exists(object)](../../DataModeling/Collections/CollectionMethods.html#exists)
* [collection.firstExample(example)](../../DataModeling/Collections/CollectionMethods.html#first-example)
* [collection.inEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc)
* [collection.insert(data)](../../DataModeling/Collections/CollectionMethods.html#insert)
* [collection.iterate(iterator,options)](../../DataModeling/Collections/CollectionMethods.html#misc)
* [collection.outEdges(vertex-id)](../../DataModeling/Collections/CollectionMethods.html#misc)
* [collection.queryByExample(example)](../../DataModeling/Collections/CollectionMethods.html#query-by-example)
* [collection.range(attribute, left, right)](../../DataModeling/Collections/CollectionMethods.html#range)
* [collection.remove(selector)](../../DataModeling/Collections/CollectionMethods.html#remove)
* [collection.removeByKeys(keys)](../../DataModeling/Collections/CollectionMethods.html#remove-by-keys)
* [collection.rename()](../../DataModeling/Collections/CollectionMethods.html#rename)
* [collection.replace(selector, data)](../../DataModeling/Collections/CollectionMethods.html#replace)
* [collection.replaceByExample(example, data)](../../DataModeling/Collections/CollectionMethods.html#replace-by-example)
* [collection.update(selector, data)](../../DataModeling/Collections/CollectionMethods.html#update)
* [collection.updateByExample(example, data)](../../DataModeling/Collections/CollectionMethods.html#update-by-example)

View File

@ -0,0 +1,40 @@
!CHAPTER The "db" Object
*db.name* returns a [collection object](CollectionObject.md) for the collection *name*.
The following methods exists on the *_db* object:
*Database*
* [db._createDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.html#create-database)
* [db._databases()](../../DataModeling/Databases/WorkingWith.html#list-databases)
* [db._dropDatabase(name, options, users)](../../DataModeling/Databases/WorkingWith.html#drop-database)
* [db._useDatabase(name)](../../DataModeling/Databases/WorkingWith.html#use-database)
*Indexes*
* [db._index(index)](../../Indexing/WorkingWithIndexes.html#fetching-an-index-by-handle)
* [db._dropIndex(index)](../../Indexing/WorkingWithIndexes.html#dropping-an-index)
*Properties*
* [db._id()](../../DataModeling/Databases/WorkingWith.html#id)
* [db._isSystem()](../../DataModeling/Databases/WorkingWith.html#issystem)
* [db._name()](../../DataModeling/Databases/WorkingWith.html#name)
* [db._path()](../../DataModeling/Databases/WorkingWith.html#path)
* [db._version()](../../DataModeling/Documents/DocumentMethods.html#get-the-version-of-arangodb)
*Collection*
* [db._collection(name)](../../DataModeling/Collections/DatabaseMethods.html#collection)
* [db._create(name)](../../DataModeling/Collections/DatabaseMethods.html#create)
* [db._drop(name)](../../DataModeling/Collections/DatabaseMethods.html#drop)
* [db._truncate(name)](../../DataModeling/Collections/DatabaseMethods.html#truncate)
*Document*
* [db._document(object)](../../DataModeling/Documents/DatabaseMethods.html#document)
* [db._exists(object)](../../DataModeling/Documents/DatabaseMethods.html#exists)
* [db._remove(selector)](../../DataModeling/Documents/DatabaseMethods.html#remove)
* [db._replace(selector,data)](../../DataModeling/Documents/DatabaseMethods.html#replace)
* [db._update(selector,data)](../../DataModeling/Documents/DatabaseMethods.html#update)

View File

@ -0,0 +1 @@
!CHAPTER References

View File

@ -1224,9 +1224,3 @@ as second argument.
~ db._drop("example");
@END_EXAMPLE_ARANGOSH_OUTPUT
@endDocuBlock accessViaGeoIndex
`edge.setProperty(name, value)`
Changes or sets the property *name* an *edges* to *value*.

View File

@ -169,6 +169,9 @@
* [Incompatible changes in 2.3](ReleaseNotes/UpgradingChanges23.md)
#
* [Appendix](Appendix/README.md)
* [References](Appendix/References/README.md)
* [db](Appendix/References/DBObject.md)
* [collection](Appendix/References/CollectionObject.md)
* [JavaScript Modules](Appendix/JavaScriptModules/README.md)
* ["console"](Appendix/JavaScriptModules/Console.md)
* ["fs"](Appendix/JavaScriptModules/FS.md)