diff --git a/html/admin/api-docs/collection.json b/html/admin/api-docs/collection.json
index 1399788e19..e0328808e6 100644
--- a/html/admin/api-docs/collection.json
+++ b/html/admin/api-docs/collection.json
@@ -19,7 +19,7 @@
"notes": "Creates an new collection with a given name. The request must contain an object with the following attributes.
- name: The name of the collection.
- waitForSync (optional, default: false): If true then the data is synchronised to disk before returning from a create or update of a document.
- doCompact (optional, default is true): whether or not the collection will be compacted.
- journalSize (optional, default is a @ref CommandLineArangod \"configuration parameter\"): The maximal size of a journal or datafile. Note that this also limits the maximal size of a single object. Must be at least 1MB.
- isSystem (optional, default is false): If true, create a system collection. In this case collection-name should start with an underscore. End users should normally create non-system collections only. API implementors may be required to create system collections in very special occasions, but normally a regular collection will do.
- isVolatile (optional, default is false): If true then the collection data is kept in-memory only and not made persistent. Unloading the collection will cause the collection data to be discarded. Stopping or re-starting the server will also cause full loss of data in the collection. Setting this option will make the resulting collection be slightly faster than regular collections because ArangoDB does not enforce any synchronisation to disk and does not calculate any CRC checksums for datafiles (as there are no datafiles).
This option should threrefore be used for cache-type collections only, and not for data that cannot be re-created otherwise.
- keyOptions (optional) additional options for key generation. If specified, then keyOptions should be a JSON array containing the following attributes (note: some of them are optional): - type: specifies the type of the key generator. The currently available generators are traditional and autoincrement. - allowUserKeys: if set to true, then it is allowed to supply own key values in the _key attribute of a document. If set to false, then the key generator will solely be responsible for generating keys and supplying own key values in the _key attribute of documents is considered an error. - increment: increment value for autoincrement key generator. Not used for other key generator types. - offset: initial offset value for autoincrement key generator. Not used for other key generator types.
- type (optional, default is 2): the type of the collection to create. The following values for type are valid: - 2: document collection - 3: edges collection
",
"summary": "creates a collection",
"httpMethod": "POST",
- "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\"testCollectionBasics\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionBasics\n\n{ \n \"id\" : \"21355350\", \n \"name\" : \"testCollectionBasics\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\nunix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\"testCollectionEdges\",\"type\":3}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionEdges\n\n{ \n \"id\" : \"22338390\", \n \"name\" : \"testCollectionEdges\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 3, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\"testCollectionUsers\",\"keyOptions\":{\"type\":\"autoincrement\",\"increment\":5,\"allowUserKeys\":true}}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionUsers\n\n{ \n \"id\" : \"23255894\", \n \"name\" : \"testCollectionUsers\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\"testCollectionBasics\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionBasics\n\n{ \n \"id\" : \"21185069\", \n \"name\" : \"testCollectionBasics\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\nunix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\"testCollectionEdges\",\"type\":3}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionEdges\n\n{ \n \"id\" : \"22168109\", \n \"name\" : \"testCollectionEdges\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 3, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\"testCollectionUsers\",\"keyOptions\":{\"type\":\"autoincrement\",\"increment\":5,\"allowUserKeys\":true}}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/testCollectionUsers\n\n{ \n \"id\" : \"23085613\", \n \"name\" : \"testCollectionUsers\", \n \"waitForSync\" : false, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "createsACollection"
}
],
@@ -41,7 +41,7 @@
"notes": "Returns an object with an attribute collections containing a list of all collection descriptions. The same information is also available in the names as hash map with the collection names as keys.
By providing the optional URL parameter excludeSystem with a value of true, all system collections will be excluded from the response.
",
"summary": "reads all collections",
"httpMethod": "GET",
- "examples": "Return information about all collections:
unix> curl --dump - http://localhost:8529/_api/collection\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"collections\" : [ \n { \n \"id\" : \"5823318\", \n \"name\" : \"_aal\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"9362262\", \n \"name\" : \"_replication\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"17095510\", \n \"name\" : \"demo\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"1694550\", \n \"name\" : \"_graphs\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"18602838\", \n \"name\" : \"animals\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"7396182\", \n \"name\" : \"_fishbowl\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"3201878\", \n \"name\" : \"_routing\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"6740822\", \n \"name\" : \"_aqlfunctions\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"2546518\", \n \"name\" : \"_modules\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"4971350\", \n \"name\" : \"_structures\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"8575830\", \n \"name\" : \"_trx\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"121686\", \n \"name\" : \"_users\", \n \"status\" : 3, \n \"type\" : 2 \n } \n ], \n \"names\" : { \n \"_aal\" : { \n \"id\" : \"5823318\", \n \"name\" : \"_aal\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_replication\" : { \n \"id\" : \"9362262\", \n \"name\" : \"_replication\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"demo\" : { \n \"id\" : \"17095510\", \n \"name\" : \"demo\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_graphs\" : { \n \"id\" : \"1694550\", \n \"name\" : \"_graphs\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"animals\" : { \n \"id\" : \"18602838\", \n \"name\" : \"animals\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_fishbowl\" : { \n \"id\" : \"7396182\", \n \"name\" : \"_fishbowl\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_routing\" : { \n \"id\" : \"3201878\", \n \"name\" : \"_routing\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_aqlfunctions\" : { \n \"id\" : \"6740822\", \n \"name\" : \"_aqlfunctions\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_modules\" : { \n \"id\" : \"2546518\", \n \"name\" : \"_modules\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_structures\" : { \n \"id\" : \"4971350\", \n \"name\" : \"_structures\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_trx\" : { \n \"id\" : \"8575830\", \n \"name\" : \"_trx\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_users\" : { \n \"id\" : \"121686\", \n \"name\" : \"_users\", \n \"status\" : 3, \n \"type\" : 2 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Return information about all collections:
unix> curl --dump - http://localhost:8529/_api/collection\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"collections\" : [ \n { \n \"id\" : \"82477\", \n \"name\" : \"_users\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"9257517\", \n \"name\" : \"_replication\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"8536621\", \n \"name\" : \"_trx\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"18432557\", \n \"name\" : \"animals\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"5784109\", \n \"name\" : \"_aal\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"1655341\", \n \"name\" : \"_graphs\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"7356973\", \n \"name\" : \"_fishbowl\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"3162669\", \n \"name\" : \"_routing\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"6701613\", \n \"name\" : \"_aqlfunctions\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"2507309\", \n \"name\" : \"_modules\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"4932141\", \n \"name\" : \"_structures\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n { \n \"id\" : \"16925229\", \n \"name\" : \"demo\", \n \"status\" : 3, \n \"type\" : 2 \n } \n ], \n \"names\" : { \n \"_users\" : { \n \"id\" : \"82477\", \n \"name\" : \"_users\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_replication\" : { \n \"id\" : \"9257517\", \n \"name\" : \"_replication\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_trx\" : { \n \"id\" : \"8536621\", \n \"name\" : \"_trx\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"animals\" : { \n \"id\" : \"18432557\", \n \"name\" : \"animals\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_aal\" : { \n \"id\" : \"5784109\", \n \"name\" : \"_aal\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_graphs\" : { \n \"id\" : \"1655341\", \n \"name\" : \"_graphs\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_fishbowl\" : { \n \"id\" : \"7356973\", \n \"name\" : \"_fishbowl\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_routing\" : { \n \"id\" : \"3162669\", \n \"name\" : \"_routing\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_aqlfunctions\" : { \n \"id\" : \"6701613\", \n \"name\" : \"_aqlfunctions\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_modules\" : { \n \"id\" : \"2507309\", \n \"name\" : \"_modules\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"_structures\" : { \n \"id\" : \"4932141\", \n \"name\" : \"_structures\", \n \"status\" : 3, \n \"type\" : 2 \n }, \n \"demo\" : { \n \"id\" : \"16925229\", \n \"name\" : \"demo\", \n \"status\" : 3, \n \"type\" : 2 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsAllCollections"
}
],
@@ -99,7 +99,7 @@
"notes": "In addition to the above, the result will always contain the waitForSync, doCompact, journalSize, and isVolatile properties. This is achieved by forcing a load of the underlying collection.
- waitForSync: If true then creating or changing a document will wait until the data has been synchronised to disk.
- doCompact: Whether or not the collection will be compacted.
- journalSize: The maximal size setting for journals / datafiles.
- isVolatile: If true then the collection data will be kept in memory only and ArangoDB will not write or sync the data to disk.
",
"summary": "reads the properties of a collection",
"httpMethod": "GET",
- "examples": "Using an identifier:
unix> curl --dump - http://localhost:8529/_api/collection/23911254/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/properties\n\n{ \n \"id\" : \"23911254\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using a name:
unix> curl --dump - http://localhost:8529/_api/collection/products/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/properties\n\n{ \n \"id\" : \"24566614\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Using an identifier:
unix> curl --dump - http://localhost:8529/_api/collection/23740973/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/properties\n\n{ \n \"id\" : \"23740973\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using a name:
unix> curl --dump - http://localhost:8529/_api/collection/products/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/properties\n\n{ \n \"id\" : \"24396333\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsThePropertiesOfACollection"
}
],
@@ -130,7 +130,7 @@
"notes": "In addition to the above, the result also contains the number of documents. Note that this will always load the collection into memory.
- count: The number of documents inside the collection.
",
"summary": "returns the number of documents in a collection",
"httpMethod": "GET",
- "examples": "Using an identifier and requesting the number of documents:
unix> curl --dump - http://localhost:8529/_api/collection/25287510/count\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/count\n\n{ \n \"id\" : \"25287510\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"count\" : 100, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Using an identifier and requesting the number of documents:
unix> curl --dump - http://localhost:8529/_api/collection/25117229/count\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/count\n\n{ \n \"id\" : \"25117229\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"count\" : 100, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "returnsTheNumberOfDocumentsInACollection"
}
],
@@ -158,10 +158,10 @@
"description": ""
}
],
- "notes": "In addition to the above, the result also contains the number of documents and additional statistical information about the collection. Note that this will always load the collection into memory.
- count: The number of documents inside the collection.
- figures.alive.count: The number of living documents.
- figures.alive.size: The total size in bytes used by all living documents.
- figures.dead.count: The number of dead documents.
- figures.dead.size: The total size in bytes used by all dead documents.
- figures.dead.deletion: The total number of deletion markers.
- figures.datafiles.count: The number of active datafiles.- figures.datafiles.fileSize: The total filesize of datafiles.
- figures.journals.count: The number of journal files.- figures.journals.fileSize: The total filesize of journal files.
- figures.shapes.count: The total number of shapes used in the collection (this includes shapes that are not in use anymore)
- figures.attributes.count: The total number of attributes used in the collection (this includes attributes that are not in use anymore)
- journalSize: The maximal size of the journal in bytes.
Note: the filesizes of shapes and compactor files are not reported.
",
+ "notes": "In addition to the above, the result also contains the number of documents and additional statistical information about the collection. Note that this will always load the collection into memory.
- count: The number of documents currently present in the collection.
- figures.alive.count: The number of currently active documents.
- figures.alive.size: The total size in bytes used by all active documents.
- figures.dead.count: The number of dead documents. This includes document versions that have been deleted or replaced by a newer version.
- figures.dead.size: The total size in bytes used by all dead documents.
- figures.dead.deletion: The total number of deletion markers in the collection.
- figures.datafiles.count: The number of current datafiles.- figures.datafiles.fileSize: The total filesize of all datafiles.
- figures.journals.count: The number of journal files.- figures.journals.fileSize: The total filesize of all journal files.
- figures.shapes.count: The total number of shapes in the collection (this includes shapes that are not in use anymore)
- figures.attributes.count: The total number of attributes in the collection (this includes attributes that are not in use anymore)
- journalSize: The maximal size of the journal in bytes.
Note: the filesizes of shapes and compactor files are not reported.
That means that the figures reported do not reflect the actual disk usage of the collection with 100% accuracy. The actual disk usage of a collection is normally higher than the sum of the reported fileSize values. Still the sum of the fileSize values can still be used as a lower bound approximation of the disk usage.
",
"summary": "returns the stats for a collection",
"httpMethod": "GET",
- "examples": "Using an identifier and requesting the figures of the collection:
unix> curl --dump - http://localhost:8529/_api/collection/45865814/figures\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/figures\n\n{ \n \"id\" : \"45865814\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"count\" : 0, \n \"figures\" : { \n \"alive\" : { \n \"count\" : 0, \n \"size\" : 0 \n }, \n \"dead\" : { \n \"count\" : 0, \n \"size\" : 0, \n \"deletion\" : 0 \n }, \n \"datafiles\" : { \n \"count\" : 0, \n \"fileSize\" : 0 \n }, \n \"journals\" : { \n \"count\" : 0, \n \"fileSize\" : 0 \n }, \n \"shapes\" : { \n \"count\" : 6 \n }, \n \"attributes\" : { \n \"count\" : 0 \n } \n }, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Using an identifier and requesting the figures of the collection:
unix> curl --dump - http://localhost:8529/_api/collection/45695533/figures\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/figures\n\n{ \n \"id\" : \"45695533\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"count\" : 0, \n \"figures\" : { \n \"alive\" : { \n \"count\" : 0, \n \"size\" : 0 \n }, \n \"dead\" : { \n \"count\" : 0, \n \"size\" : 0, \n \"deletion\" : 0 \n }, \n \"datafiles\" : { \n \"count\" : 0, \n \"fileSize\" : 0 \n }, \n \"journals\" : { \n \"count\" : 0, \n \"fileSize\" : 0 \n }, \n \"shapes\" : { \n \"count\" : 6 \n }, \n \"attributes\" : { \n \"count\" : 0 \n } \n }, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "returnsTheStatsForACollection"
}
],
@@ -192,7 +192,7 @@
"notes": "In addition to the above, the result will also contain the collection's revision id. The revision id is a server-generated string that clients can use to check whether data in a collection has changed since the last revision check.
- revision: The collection revision id as a string.
",
"summary": "return a collection revision id",
"httpMethod": "GET",
- "examples": "Retrieving the revision of a collection
unix> curl --dump - http://localhost:8529/_api/collection/46652246/revision\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"46652246\", \n \"name\" : \"products\", \n \"status\" : 3, \n \"type\" : 2, \n \"revision\" : \"0\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Retrieving the revision of a collection
unix> curl --dump - http://localhost:8529/_api/collection/46481965/revision\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"46481965\", \n \"name\" : \"products\", \n \"status\" : 3, \n \"type\" : 2, \n \"revision\" : \"0\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "returnACollectionRevisionId"
}
],
@@ -230,7 +230,7 @@
"notes": "Will calculate checksum of the meta-data (keys and revision ids) and optionally document data in the collection.
The checksum can be used to compare if two collections on different ArangoDB instances contain the same contents. The current revision of the collection is returned too so one can make sure the checksums are calculated for the same state of data.
By default, the checksum will only be calculated on the _key and _rev system attributes of the documents contained in the collection. For edge collections, the system attributes _from and _to will also be included in the calculation.
By providing the optional URL parameter withData with a value of true, the user-defined document attributes will be included in the calculation too. Note that including user-defined attributes will make the checksumming slower.
- checksum: The calculated checksum as a number.
- revision: The collection revision id as a string.
",
"summary": "returns a checksum for the collection",
"httpMethod": "GET",
- "examples": "Retrieving the checksum of a collection:
unix> curl --dump - http://localhost:8529/_api/collection/47438678/checksum\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"47438678\", \n \"name\" : \"products\", \n \"status\" : 3, \n \"type\" : 2, \n \"checksum\" : 871934454, \n \"revision\" : \"48421718\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Retrieving the checksum of a collection:
unix> curl --dump - http://localhost:8529/_api/collection/47268397/checksum\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"47268397\", \n \"name\" : \"products\", \n \"status\" : 3, \n \"type\" : 2, \n \"checksum\" : 3100623192, \n \"revision\" : \"48251437\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "returnsAChecksumForTheCollection"
}
],
@@ -261,7 +261,7 @@
"notes": "Loads a collection into memory. Returns the collection on success.
The request might optionally contain the following attribute:
- count: If set, this controls whether the return value should include the number of documents in the collection. Setting count to false may speed up loading a collection. The default value for count is true.
On success an object with the following attributes is returned:
- id: The identifier of the collection.
- name: The name of the collection.
- count: The number of documents inside the collection. This is only returned if the count input parameters is set to true or has not been specified.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
",
"summary": "loads a collection",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/48552790/load\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"48552790\", \n \"name\" : \"products\", \n \"count\" : 0, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/48382509/load\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"48382509\", \n \"name\" : \"products\", \n \"count\" : 0, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "loadsACollection"
}
],
@@ -292,7 +292,7 @@
"notes": "Removes a collection from memory. This call does not delete any documents. You can use the collection afterwards; in which case it will be loaded into memory, again. On success an object with the following attributes is returned:
- id: The identifier of the collection.
- name: The name of the collection.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
",
"summary": "unloads a collection",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/49273686/unload\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"49273686\", \n \"name\" : \"products\", \n \"status\" : 2, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/49103405/unload\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"49103405\", \n \"name\" : \"products\", \n \"status\" : 2, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "unloadsACollection"
}
],
@@ -314,7 +314,7 @@
"notes": "Removes all documents from the collection, but leaves the indexes intact.
",
"summary": "truncates a collection",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/49994582/truncate\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"49994582\", \n \"name\" : \"products\", \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/collection/49824301/truncate\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"49824301\", \n \"name\" : \"products\", \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "truncatesACollection"
}
],
@@ -336,7 +336,7 @@
"notes": "Changes the properties of a collection. Expects an object with the attribute(s)
- waitForSync: If true then creating or changing a document will wait until the data has been synchronised to disk.
- journalSize: Size (in bytes) for new journal files that are created for the collection.
If returns an object with the attributes
- id: The identifier of the collection.
- name: The name of the collection.
- waitForSync: The new value.
- journalSize: The new value.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
Note: some other collection properties, such as type or isVolatile cannot be changed once the collection is created.
",
"summary": "changes the properties of a collection",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/collection/50715478/properties\n{\"waitForSync\":true}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"50715478\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/collection/50545197/properties\n{\"waitForSync\":true}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"50545197\", \n \"name\" : \"products\", \n \"doCompact\" : true, \n \"isVolatile\" : false, \n \"isSystem\" : false, \n \"journalSize\" : 1048576, \n \"keyOptions\" : { \n \"type\" : \"traditional\", \n \"allowUserKeys\" : true \n }, \n \"waitForSync\" : true, \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "changesThePropertiesOfACollection"
}
],
@@ -358,7 +358,7 @@
"notes": "Renames a collection. Expects an object with the attribute(s)
- name: The new name.
If returns an object with the attributes
- id: The identifier of the collection.
- name: The new name of the collection.
- status: The status of the collection as number.
- type: The collection type. Valid types are: - 2: document collection - 3: edges collection
",
"summary": "renames a collection",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/collection/51436374/rename\n{\"name\":\"newname\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"51436374\", \n \"name\" : \"newname\", \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/collection/51266093/rename\n{\"name\":\"newname\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"51266093\", \n \"name\" : \"newname\", \n \"status\" : 3, \n \"type\" : 2, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "renamesACollection"
}
],
@@ -389,7 +389,7 @@
"notes": "Deletes a collection identified by collection-name.
If the collection was successfully deleted then, an object is returned with the following attributes:
- error: false
- id: The identifier of the deleted collection.
",
"summary": "deletes a collection",
"httpMethod": "DELETE",
- "examples": "Using an identifier:
unix> curl -X DELETE --dump - http://localhost:8529/_api/collection/52091734\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"52091734\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using a name:
unix> curl -X DELETE --dump - http://localhost:8529/_api/collection/products1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"52747094\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Using an identifier:
unix> curl -X DELETE --dump - http://localhost:8529/_api/collection/51921453\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"51921453\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using a name:
unix> curl -X DELETE --dump - http://localhost:8529/_api/collection/products1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"52576813\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "deletesACollection"
}
],
diff --git a/html/admin/api-docs/cursor.json b/html/admin/api-docs/cursor.json
index 22b835fa88..1f25751d86 100644
--- a/html/admin/api-docs/cursor.json
+++ b/html/admin/api-docs/cursor.json
@@ -32,7 +32,7 @@
"notes": "The query details include the query string plus optional query options and bind parameters. These values need to be passed in a JSON representation in the body of the POST request.
The following attributes can be used inside the JSON object:
- query: contains the query string to be executed (mandatory)
- count: boolean flag that indicates whether the number of documents in the result set should be returned in the \"count\" attribute of the result (optional). Calculating the \"count\" attribute might in the future have a performance impact for some queries so this option is turned off by default, and \"count\" is only returned when requested.
- batchSize: maximum number of result documents to be transferred from the server to the client in one roundtrip (optional). If this attribute is not set, a server-controlled default value will be used.
- bindVars: key/value list of bind parameters (optional).
If the result set can be created by the server, the server will respond with HTTP 201. The body of the response will contain a JSON object with the result set.
The JSON object has the following properties:
- error: boolean flag to indicate that an error occurred (false in this case)
- code: the HTTP status code
- result: an array of result documents (might be empty if query has no results)
- hasMore: a boolean indicator whether there are more results available on the server
- count: the total number of result documents available (only available if the query was executed with the count attribute set.
- id: id of temporary cursor created on the server (optional, see above)
If the JSON representation is malformed or the query specification is missing from the request, the server will respond with HTTP 400.
The body of the response will contain a JSON object with additional error details. The object has the following attributes:
- error: boolean flag to indicate that an error occurred (true in this case)
- code: the HTTP status code
- errorNum: the server error number
- errorMessage: a descriptive error message
If the query specification is complete, the server will process the query. If an error occurs during query processing, the server will respond with HTTP 400. Again, the body of the response will contain details about the error.
A list of query errors can be found the manual here.
",
"summary": "creates a cursor",
"httpMethod": "POST",
- "examples": "Executes a query and extract the result in a single go:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 2 RETURN p\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/54713174\", \n \"_rev\" : \"54713174\", \n \"_key\" : \"54713174\", \n \"hello2\" : \"world1\" \n }, \n { \n \"_id\" : \"products/54319958\", \n \"_rev\" : \"54319958\", \n \"_key\" : \"54319958\", \n \"hello1\" : \"world1\" \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Executes a query and extract part of the result:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 5 RETURN p\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/56154966\", \n \"_rev\" : \"56154966\", \n \"_key\" : \"56154966\", \n \"hello2\" : \"world1\" \n }, \n { \n \"_id\" : \"products/57138006\", \n \"_rev\" : \"57138006\", \n \"_key\" : \"57138006\", \n \"hello5\" : \"world1\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"57334614\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Bad queries: Missing body:
unix> curl -X POST --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 400, \n \"errorNum\" : 1502, \n \"errorMessage\" : \"query is empty\" \n}\n\n
Unknown collection:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR u IN unknowncoll LIMIT 2 RETURN u\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 404, \n \"errorNum\" : 1203, \n \"errorMessage\" : \"cannot execute query: collection not found: 'unknowncoll'\" \n}\n\n
",
+ "examples": "Executes a query and extract the result in a single go:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 2 RETURN p\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/54149677\", \n \"_rev\" : \"54149677\", \n \"_key\" : \"54149677\", \n \"hello1\" : \"world1\" \n }, \n { \n \"_id\" : \"products/54542893\", \n \"_rev\" : \"54542893\", \n \"_key\" : \"54542893\", \n \"hello2\" : \"world1\" \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Executes a query and extract part of the result:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 5 RETURN p\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/56312365\", \n \"_rev\" : \"56312365\", \n \"_key\" : \"56312365\", \n \"hello3\" : \"world1\" \n }, \n { \n \"_id\" : \"products/55591469\", \n \"_rev\" : \"55591469\", \n \"_key\" : \"55591469\", \n \"hello1\" : \"world1\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"57164333\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Bad queries: Missing body:
unix> curl -X POST --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 400, \n \"errorNum\" : 1502, \n \"errorMessage\" : \"query is empty\" \n}\n\n
Unknown collection:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR u IN unknowncoll LIMIT 2 RETURN u\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 404, \n \"errorNum\" : 1203, \n \"errorMessage\" : \"cannot execute query: collection not found: 'unknowncoll'\" \n}\n\n
",
"nickname": "createsACursor"
}
],
@@ -63,7 +63,7 @@
"notes": "
If the cursor is still alive, returns an object with the following attributes.
- id: the cursor-identifier- result: a list of documents for the current batch- hasMore: false if this was the last batch- count: if present the total number of elements
Note that even if hasMore returns true, the next call might still return no documents. If, however, hasMore is false, then the cursor is exhausted. Once the hasMore attribute has a value of false, the client can stop.
",
"summary": "reads next batch from a cursor",
"httpMethod": "PUT",
- "examples": "Valid request for next batch:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 5 RETURN p\",\"count\":true,\"batchSize\":2}\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/cursor/59824982\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/59628374\", \n \"_rev\" : \"59628374\", \n \"_key\" : \"59628374\", \n \"hello5\" : \"world1\" \n }, \n { \n \"_id\" : \"products/58973014\", \n \"_rev\" : \"58973014\", \n \"_key\" : \"58973014\", \n \"hello3\" : \"world1\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"59824982\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Missing identifier
unix> curl -X PUT --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 400, \n \"errorNum\" : 400, \n \"errorMessage\" : \"bad parameter\" \n}\n\n
Unknown identifier
unix> curl -X PUT --dump - http://localhost:8529/_api/cursor/123123\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 400, \n \"errorNum\" : 1600, \n \"errorMessage\" : \"cursor not found\" \n}\n\n
",
+ "examples": "Valid request for next batch:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 5 RETURN p\",\"count\":true,\"batchSize\":2}\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/cursor/59654701\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/58475053\", \n \"_rev\" : \"58475053\", \n \"_key\" : \"58475053\", \n \"hello2\" : \"world1\" \n }, \n { \n \"_id\" : \"products/58802733\", \n \"_rev\" : \"58802733\", \n \"_key\" : \"58802733\", \n \"hello3\" : \"world1\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"59654701\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Missing identifier
unix> curl -X PUT --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 400, \n \"errorNum\" : 400, \n \"errorMessage\" : \"bad parameter\" \n}\n\n
Unknown identifier
unix> curl -X PUT --dump - http://localhost:8529/_api/cursor/123123\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 400, \n \"errorNum\" : 1600, \n \"errorMessage\" : \"cursor not found\" \n}\n\n
",
"nickname": "readsNextBatchFromACursor"
}
],
@@ -94,7 +94,7 @@
"notes": "Deletes the cursor and frees the resources associated with it.
The cursor will automatically be destroyed on the server when the client has retrieved all documents from it. The client can also explicitly destroy the cursor at any earlier time using an HTTP DELETE request. The cursor id must be included as part of the URL.
Note: the server will also destroy abandoned cursors automatically after a certain server-controlled timeout to avoid resource leakage.
",
"summary": "deletes a cursor",
"httpMethod": "DELETE",
- "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 5 RETURN p\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/61135702\", \n \"_rev\" : \"61135702\", \n \"_key\" : \"61135702\", \n \"hello2\" : \"world1\" \n }, \n { \n \"_id\" : \"products/61791062\", \n \"_rev\" : \"61791062\", \n \"_key\" : \"61791062\", \n \"hello4\" : \"world1\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"62315350\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 201 \n}\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/cursor/62315350\n\n
",
+ "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/cursor\n{\"query\":\"FOR p IN products LIMIT 5 RETURN p\",\"count\":true,\"batchSize\":2}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/60965421\", \n \"_rev\" : \"60965421\", \n \"_key\" : \"60965421\", \n \"hello2\" : \"world1\" \n }, \n { \n \"_id\" : \"products/61620781\", \n \"_rev\" : \"61620781\", \n \"_key\" : \"61620781\", \n \"hello4\" : \"world1\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"62145069\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 201 \n}\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/cursor/62145069\n\n
",
"nickname": "deletesACursor"
}
],
diff --git a/html/admin/api-docs/document.json b/html/admin/api-docs/document.json
index 5532294711..daf27c19f8 100644
--- a/html/admin/api-docs/document.json
+++ b/html/admin/api-docs/document.json
@@ -55,7 +55,7 @@
"notes": "Creates a new document in the collection named collection. A JSON representation of the document must be passed as the body of the POST request.
If the document was created successfully, then the \"Location\" header contains the path to the newly created document. The \"ETag\" header field contains the revision of the document.
The body of the response contains a JSON object with the following attributes:
- _id contains the document handle of the newly created document- _key contains the document key- _rev contains the document revision
If the collection parameter waitForSync is false, then the call returns as soon as the document has been accepted. It will not wait until the document has been synced to disk.
Optionally, the URL parameter waitForSync can be used to force synchronisation of the document creation operation to disk even in case that the waitForSync flag had been disabled for the entire collection. Thus, the waitForSync URL parameter can be used to force synchronisation of just this specific operations. To use this, set the waitForSync parameter to true. If the waitForSync parameter is not specified or set to false, then the collection's default waitForSync behavior is applied. The waitForSync URL parameter cannot be used to disable synchronisation for collections that have a default waitForSync value of true.
",
"summary": "creates a document",
"httpMethod": "POST",
- "examples": "Create a document given a collection named products. Note that the revision identifier might or might not by equal to the auto-generated key.
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"302832470\"\nlocation: /_api/document/products/302832470\n\n{ \n \"error\" : false, \n \"_id\" : \"products/302832470\", \n \"_rev\" : \"302832470\", \n \"_key\" : \"302832470\" \n}\n\n
Create a document in a collection named products with a collection-level waitForSync value of false.
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"303815510\"\nlocation: /_api/document/products/303815510\n\n{ \n \"error\" : false, \n \"_id\" : \"products/303815510\", \n \"_rev\" : \"303815510\", \n \"_key\" : \"303815510\" \n}\n\n
Create a document in a collection with a collection-level waitForSync value of false, but using the waitForSync URL parameter.
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products&waitForSync=true\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"304864086\"\nlocation: /_api/document/products/304864086\n\n{ \n \"error\" : false, \n \"_id\" : \"products/304864086\", \n \"_rev\" : \"304864086\", \n \"_key\" : \"304864086\" \n}\n\n
Create a document in a new, named collection
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products&createCollection=true\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"305912662\"\nlocation: /_api/document/products/305912662\n\n{ \n \"error\" : false, \n \"_id\" : \"products/305912662\", \n \"_rev\" : \"305912662\", \n \"_key\" : \"305912662\" \n}\n\n
Unknown collection name:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"collection /_api/collection/products not found\", \n \"code\" : 404, \n \"errorNum\" : 1203 \n}\n\n
Illegal document:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ 1: \"World\" }\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"expecting attribute name\", \n \"code\" : 400, \n \"errorNum\" : 600 \n}\n\n
",
+ "examples": "Create a document given a collection named products. Note that the revision identifier might or might not by equal to the auto-generated key.
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"302596653\"\nlocation: /_api/document/products/302596653\n\n{ \n \"error\" : false, \n \"_id\" : \"products/302596653\", \n \"_rev\" : \"302596653\", \n \"_key\" : \"302596653\" \n}\n\n
Create a document in a collection named products with a collection-level waitForSync value of false.
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"303645229\"\nlocation: /_api/document/products/303645229\n\n{ \n \"error\" : false, \n \"_id\" : \"products/303645229\", \n \"_rev\" : \"303645229\", \n \"_key\" : \"303645229\" \n}\n\n
Create a document in a collection with a collection-level waitForSync value of false, but using the waitForSync URL parameter.
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products&waitForSync=true\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"304693805\"\nlocation: /_api/document/products/304693805\n\n{ \n \"error\" : false, \n \"_id\" : \"products/304693805\", \n \"_rev\" : \"304693805\", \n \"_key\" : \"304693805\" \n}\n\n
Create a document in a new, named collection
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products&createCollection=true\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"305742381\"\nlocation: /_api/document/products/305742381\n\n{ \n \"error\" : false, \n \"_id\" : \"products/305742381\", \n \"_rev\" : \"305742381\", \n \"_key\" : \"305742381\" \n}\n\n
Unknown collection name:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ \"Hello\": \"World\" }\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"collection /_api/collection/products not found\", \n \"code\" : 404, \n \"errorNum\" : 1203 \n}\n\n
Illegal document:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/document?collection=products\n{ 1: \"World\" }\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"expecting attribute name\", \n \"code\" : 400, \n \"errorNum\" : 600 \n}\n\n
",
"nickname": "createsADocument"
}
],
@@ -106,7 +106,7 @@
"notes": "Returns the document identified by document-handle. The returned document contains two special attributes: _id containing the document handle and _rev containing the revision.
",
"summary": "reads a document",
"httpMethod": "GET",
- "examples": "Use a document handle:
unix> curl --dump - http://localhost:8529/_api/document/products/307026774\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"307026774\"\n\n{ \n \"hello\" : \"world\", \n \"_id\" : \"products/307026774\", \n \"_rev\" : \"307026774\", \n \"_key\" : \"307026774\" \n}\n\n
Use a document handle and an etag:
unix> curl --header 'If-None-Match:\"308075350\"' --dump - http://localhost:8529/_api/document/products/308075350\n\n
Unknown document handle:
unix> curl --dump - http://localhost:8529/_api/document/products/unknownhandle\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/unknownhandle not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n
",
+ "examples": "Use a document handle:
unix> curl --dump - http://localhost:8529/_api/document/products/306790957\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"306790957\"\n\n{ \n \"hello\" : \"world\", \n \"_id\" : \"products/306790957\", \n \"_rev\" : \"306790957\", \n \"_key\" : \"306790957\" \n}\n\n
Use a document handle and an etag:
unix> curl --header 'If-None-Match:\"307905069\"' --dump - http://localhost:8529/_api/document/products/307905069\n\n
Unknown document handle:
unix> curl --dump - http://localhost:8529/_api/document/products/unknownhandle\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/unknownhandle not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n
",
"nickname": "readsADocument"
}
],
@@ -137,7 +137,7 @@
"notes": "Returns a list of all URI for all documents from the collection identified by collection.
",
"summary": "reads all documents from collection",
"httpMethod": "GET",
- "examples": "Returns a collection.
unix> curl --dump - http://localhost:8529/_api/document/?collection=products\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"documents\" : [ \n \"/_api/document/products/309254998\", \n \"/_api/document/products/309648214\", \n \"/_api/document/products/309975894\" \n ] \n}\n\n
Collection does not exist.
unix> curl --dump - http://localhost:8529/_api/document/?collection=doesnotexist\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"collection /_api/collection/doesnotexist not found\", \n \"code\" : 404, \n \"errorNum\" : 1203 \n}\n\n
",
+ "examples": "Returns a collection.
unix> curl --dump - http://localhost:8529/_api/document/?collection=products\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"documents\" : [ \n \"/_api/document/products/309477933\", \n \"/_api/document/products/309084717\", \n \"/_api/document/products/309805613\" \n ] \n}\n\n
Collection does not exist.
unix> curl --dump - http://localhost:8529/_api/document/?collection=doesnotexist\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"collection /_api/collection/doesnotexist not found\", \n \"code\" : 404, \n \"errorNum\" : 1203 \n}\n\n
",
"nickname": "readsAllDocumentsFromCollection"
}
],
@@ -194,7 +194,7 @@
"notes": "Like GET, but only returns the header fields and not the body. You can use this call to get the current revision of a document or check if the document was deleted.
",
"summary": "reads a document header",
"httpMethod": "HEAD",
- "examples": "
unix> curl -X HEAD --dump - http://localhost:8529/_api/document/products/311024470\n\n
",
+ "examples": "
unix> curl -X HEAD --dump - http://localhost:8529/_api/document/products/310919725\n\n
",
"nickname": "readsADocumentHeader"
}
],
@@ -261,7 +261,7 @@
"notes": "Completely updates (i.e. replaces) the document identified by document-handle. If the document exists and can be updated, then a HTTP 201 is returned and the \"ETag\" header field contains the new revision of the document.
If the new document passed in the body of the request contains the document-handle in the attribute _id and the revision in _rev, these attributes will be ignored. Only the URI and the \"ETag\" header are relevant in order to avoid confusion when using proxies.
Optionally, the URL parameter waitForSync can be used to force synchronisation of the document replacement operation to disk even in case that the waitForSync flag had been disabled for the entire collection. Thus, the waitForSync URL parameter can be used to force synchronisation of just specific operations. To use this, set the waitForSync parameter to true. If the waitForSync parameter is not specified or set to false, then the collection's default waitForSync behavior is applied. The waitForSync URL parameter cannot be used to disable synchronisation for collections that have a default waitForSync value of true.
The body of the response contains a JSON object with the information about the handle and the revision. The attribute _id contains the known document-handle of the updated document, the attribute _rev contains the new document revision.
If the document does not exist, then a HTTP 404 is returned and the body of the response contains an error document.
There are two ways for specifying the targeted document revision id for conditional replacements (i.e. replacements that will only be executed if the revision id found in the database matches the document revision id specified in the request): - specifying the target revision in the rev URL query parameter- specifying the target revision in the if-match HTTP header
Specifying a target revision is optional, however, if done, only one of the described mechanisms must be used (either the rev URL parameter or the if-match HTTP header). Regardless which mechanism is used, the parameter needs to contain the target document revision id as returned in the _rev attribute of a document or by an HTTP etag header.
For example, to conditionally replace a document based on a specific revision id, you the following request:
- PUT /_api/document/document-handle?rev=etag
If a target revision id is provided in the request (e.g. via the etag value in the rev URL query parameter above), ArangoDB will check that the revision id of the document found in the database is equal to the target revision id provided in the request. If there is a mismatch between the revision id, then by default a HTTP 412 conflict is returned and no replacement is performed.
The conditional update behavior can be overriden with the policy URL query parameter:
- PUT /_api/document/document-handle?policy=policy
If policy is set to error, then the behavior is as before: replacements will fail if the revision id found in the database does not match the target revision id specified in the request.
If policy is set to last, then the replacement will succeed, even if the revision id found in the database does not match the target revision id specified in the request. You can use the last `policy` to force replacements.
",
"summary": "replaces a document",
"httpMethod": "PUT",
- "examples": "Using document handle:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/312138582\n{\"Hello\": \"you\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"312531798\"\nlocation: /_api/document/products/312138582\n\n{ \n \"error\" : false, \n \"_id\" : \"products/312138582\", \n \"_rev\" : \"312531798\", \n \"_key\" : \"312138582\" \n}\n\n
Unknown document handle:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/313514838\n{}\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/313514838 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n
Produce a revision conflict:
unix> curl -X PUT --header 'If-Match:\"315284310\"' --data @- --dump - http://localhost:8529/_api/document/products/314891094\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/314891094\", \n \"_rev\" : \"314891094\", \n \"_key\" : \"314891094\" \n}\n\n
Last write wins:
unix> curl -X PUT --header 'If-Match:\"316857174\"' --data @- --dump - http://localhost:8529/_api/document/products/316463958?policy=last\n{}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"317119318\"\nlocation: /_api/document/products/316463958\n\n{ \n \"error\" : false, \n \"_id\" : \"products/316463958\", \n \"_rev\" : \"317119318\", \n \"_key\" : \"316463958\" \n}\n\n
Alternative to header field:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/318102358?rev=318495574\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/318102358\", \n \"_rev\" : \"318102358\", \n \"_key\" : \"318102358\" \n}\n\n
",
+ "examples": "Using document handle:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/311968301\n{\"Hello\": \"you\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"312361517\"\nlocation: /_api/document/products/311968301\n\n{ \n \"error\" : false, \n \"_id\" : \"products/311968301\", \n \"_rev\" : \"312361517\", \n \"_key\" : \"311968301\" \n}\n\n
Unknown document handle:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/313344557\n{}\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/313344557 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n
Produce a revision conflict:
unix> curl -X PUT --header 'If-Match:\"315114029\"' --data @- --dump - http://localhost:8529/_api/document/products/314720813\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/314720813\", \n \"_rev\" : \"314720813\", \n \"_key\" : \"314720813\" \n}\n\n
Last write wins:
unix> curl -X PUT --header 'If-Match:\"316686893\"' --data @- --dump - http://localhost:8529/_api/document/products/316293677?policy=last\n{}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"316949037\"\nlocation: /_api/document/products/316293677\n\n{ \n \"error\" : false, \n \"_id\" : \"products/316293677\", \n \"_rev\" : \"316949037\", \n \"_key\" : \"316293677\" \n}\n\n
Alternative to header field:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/317932077?rev=318325293\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/317932077\", \n \"_rev\" : \"317932077\", \n \"_key\" : \"317932077\" \n}\n\n
",
"nickname": "replacesADocument"
}
],
@@ -334,7 +334,7 @@
"notes": "Partially updates the document identified by document-handle. The body of the request must contain a JSON document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.
Setting an attribute value to null in the patch document will cause a value of null be saved for the attribute by default.
Optionally, the URL parameter waitForSync can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection. Thus, the waitForSync URL parameter can be used to force synchronisation of just specific operations. To use this, set the waitForSync parameter to true. If the waitForSync parameter is not specified or set to false, then the collection's default waitForSync behavior is applied. The waitForSync URL parameter cannot be used to disable synchronisation for collections that have a default waitForSync value of true.
The body of the response contains a JSON object with the information about the handle and the revision. The attribute _id contains the known document-handle of the updated document, the attribute _rev contains the new document revision.
If the document does not exist, then a HTTP 404 is returned and the body of the response contains an error document.
You can conditionally update a document based on a target revision id by using either the rev URL parameter or the if-match HTTP header. To control the update behavior in case there is a revision mismatch, you can use the policy parameter. This is the same as when replacing documents (see replacing documents for details).
",
"summary": "patches a document",
"httpMethod": "PATCH",
- "examples": "patches an existing document with new content.
unix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/document/products/319675222\n{\"hello\":\"world\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"320068438\"\nlocation: /_api/document/products/319675222\n\n{ \n \"error\" : false, \n \"_id\" : \"products/319675222\", \n \"_rev\" : \"320068438\", \n \"_key\" : \"319675222\" \n}\n\nunix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/document/products/319675222\n{\"numbers\":{\"one\":1,\"two\":2,\"three\":3,\"empty\":null}}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"320658262\"\nlocation: /_api/document/products/319675222\n\n{ \n \"error\" : false, \n \"_id\" : \"products/319675222\", \n \"_rev\" : \"320658262\", \n \"_key\" : \"319675222\" \n}\n\nunix> curl --dump - http://localhost:8529/_api/document/products/319675222\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"320658262\"\n\n{ \n \"one\" : \"world\", \n \"hello\" : \"world\", \n \"numbers\" : { \n \"empty\" : null, \n \"one\" : 1, \n \"two\" : 2, \n \"three\" : 3 \n }, \n \"_id\" : \"products/319675222\", \n \"_rev\" : \"320658262\", \n \"_key\" : \"319675222\" \n}\n\nunix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/document/products/319675222?keepNull=false\n{\"hello\":null,\"numbers\":{\"four\":4}}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"321117014\"\nlocation: /_api/document/products/319675222\n\n{ \n \"error\" : false, \n \"_id\" : \"products/319675222\", \n \"_rev\" : \"321117014\", \n \"_key\" : \"319675222\" \n}\n\nunix> curl --dump - http://localhost:8529/_api/document/products/319675222\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"321117014\"\n\n{ \n \"one\" : \"world\", \n \"numbers\" : { \n \"empty\" : null, \n \"one\" : 1, \n \"two\" : 2, \n \"three\" : 3, \n \"four\" : 4 \n }, \n \"_id\" : \"products/319675222\", \n \"_rev\" : \"321117014\", \n \"_key\" : \"319675222\" \n}\n\n
",
+ "examples": "patches an existing document with new content.
unix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/document/products/319504941\n{\"hello\":\"world\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"319898157\"\nlocation: /_api/document/products/319504941\n\n{ \n \"error\" : false, \n \"_id\" : \"products/319504941\", \n \"_rev\" : \"319898157\", \n \"_key\" : \"319504941\" \n}\n\nunix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/document/products/319504941\n{\"numbers\":{\"one\":1,\"two\":2,\"three\":3,\"empty\":null}}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"320487981\"\nlocation: /_api/document/products/319504941\n\n{ \n \"error\" : false, \n \"_id\" : \"products/319504941\", \n \"_rev\" : \"320487981\", \n \"_key\" : \"319504941\" \n}\n\nunix> curl --dump - http://localhost:8529/_api/document/products/319504941\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"320487981\"\n\n{ \n \"one\" : \"world\", \n \"hello\" : \"world\", \n \"numbers\" : { \n \"empty\" : null, \n \"one\" : 1, \n \"two\" : 2, \n \"three\" : 3 \n }, \n \"_id\" : \"products/319504941\", \n \"_rev\" : \"320487981\", \n \"_key\" : \"319504941\" \n}\n\nunix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/document/products/319504941?keepNull=false\n{\"hello\":null,\"numbers\":{\"four\":4}}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"320946733\"\nlocation: /_api/document/products/319504941\n\n{ \n \"error\" : false, \n \"_id\" : \"products/319504941\", \n \"_rev\" : \"320946733\", \n \"_key\" : \"319504941\" \n}\n\nunix> curl --dump - http://localhost:8529/_api/document/products/319504941\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"320946733\"\n\n{ \n \"one\" : \"world\", \n \"numbers\" : { \n \"empty\" : null, \n \"one\" : 1, \n \"two\" : 2, \n \"three\" : 3, \n \"four\" : 4 \n }, \n \"_id\" : \"products/319504941\", \n \"_rev\" : \"320946733\", \n \"_key\" : \"319504941\" \n}\n\n
",
"nickname": "patchesADocument"
}
],
@@ -397,7 +397,7 @@
"notes": "The body of the response contains a JSON object with the information about the handle and the revision. The attribute _id contains the known document-handle of the updated document, the attribute _rev contains the known document revision.
If the waitForSync parameter is not specified or set to false, then the collection's default waitForSync behavior is applied. The waitForSync URL parameter cannot be used to disable synchronisation for collections that have a default waitForSync value of true.
",
"summary": "deletes a document",
"httpMethod": "DELETE",
- "examples": "Using document handle:
unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/322231126\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : false, \n \"_id\" : \"products/322231126\", \n \"_rev\" : \"322231126\", \n \"_key\" : \"322231126\" \n}\n\n
Unknown document handle:
unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/323476310\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/323476310 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n
Revision conflict:
unix> curl -X DELETE --header 'If-Match:\"325180246\"' --dump - http://localhost:8529/_api/document/products/324787030\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/324787030\", \n \"_rev\" : \"324787030\", \n \"_key\" : \"324787030\" \n}\n\n
",
+ "examples": "Using document handle:
unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/322060845\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : false, \n \"_id\" : \"products/322060845\", \n \"_rev\" : \"322060845\", \n \"_key\" : \"322060845\" \n}\n\n
Unknown document handle:
unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/323240493\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/323240493 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n
Revision conflict:
unix> curl -X DELETE --header 'If-Match:\"325009965\"' --dump - http://localhost:8529/_api/document/products/324616749\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/324616749\", \n \"_rev\" : \"324616749\", \n \"_key\" : \"324616749\" \n}\n\n
",
"nickname": "deletesADocument"
}
],
diff --git a/html/admin/api-docs/edge.json b/html/admin/api-docs/edge.json
index 225a7b7f96..df14637fbd 100644
--- a/html/admin/api-docs/edge.json
+++ b/html/admin/api-docs/edge.json
@@ -49,7 +49,7 @@
"notes": "from handle and to handle are immutable once the edge has been created.
In all other respects the method works like POST /document, see the manual for details.
",
"summary": "creates an edge",
"httpMethod": "POST",
- "examples": "Create an edge and reads it back:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/edge/?collection=edges&from=vertices/1&to=vertices/2\n{\"name\":\"Emil\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"328588118\"\nlocation: /_api/document/edges/328588118\n\n{ \n \"error\" : false, \n \"_id\" : \"edges/328588118\", \n \"_rev\" : \"328588118\", \n \"_key\" : \"328588118\" \n}\n\nunix> curl --dump - http://localhost:8529/_api/edge/edges/328588118\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"328588118\"\n\n{ \n \"name\" : \"Emil\", \n \"_id\" : \"edges/328588118\", \n \"_rev\" : \"328588118\", \n \"_key\" : \"328588118\", \n \"_from\" : \"vertices/1\", \n \"_to\" : \"vertices/2\" \n}\n\n
",
+ "examples": "Create an edge and reads it back:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/edge/?collection=edges&from=vertices/1&to=vertices/2\n{\"name\":\"Emil\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"328417837\"\nlocation: /_api/document/edges/328417837\n\n{ \n \"error\" : false, \n \"_id\" : \"edges/328417837\", \n \"_rev\" : \"328417837\", \n \"_key\" : \"328417837\" \n}\n\nunix> curl --dump - http://localhost:8529/_api/edge/edges/328417837\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"328417837\"\n\n{ \n \"name\" : \"Emil\", \n \"_id\" : \"edges/328417837\", \n \"_rev\" : \"328417837\", \n \"_key\" : \"328417837\", \n \"_from\" : \"vertices/1\", \n \"_to\" : \"vertices/2\" \n}\n\n
",
"nickname": "createsAnEdge"
}
],
diff --git a/html/admin/api-docs/edges.json b/html/admin/api-docs/edges.json
index 8ab9df9c95..e923cf7fc6 100644
--- a/html/admin/api-docs/edges.json
+++ b/html/admin/api-docs/edges.json
@@ -32,7 +32,7 @@
"notes": "Returns the list of edges starting or ending in the vertex identified by vertex-handle.
",
"summary": "reads in- or outbound edges",
"httpMethod": "GET",
- "examples": "Any direction
unix> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"edges\" : [ \n { \n \"_id\" : \"edges/6\", \n \"_rev\" : \"67296086\", \n \"_key\" : \"6\", \n \"_from\" : \"vertices/2\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v2 -> v1\" \n }, \n { \n \"_id\" : \"edges/7\", \n \"_rev\" : \"67885910\", \n \"_key\" : \"7\", \n \"_from\" : \"vertices/4\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v4 -> v1\" \n }, \n { \n \"_id\" : \"edges/5\", \n \"_rev\" : \"66706262\", \n \"_key\" : \"5\", \n \"_from\" : \"vertices/1\", \n \"_to\" : \"vertices/3\", \n \"$label\" : \"v1 -> v3\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
In edges
unix> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=in\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"edges\" : [ \n { \n \"_id\" : \"edges/6\", \n \"_rev\" : \"73063254\", \n \"_key\" : \"6\", \n \"_from\" : \"vertices/2\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v2 -> v1\" \n }, \n { \n \"_id\" : \"edges/7\", \n \"_rev\" : \"73653078\", \n \"_key\" : \"7\", \n \"_from\" : \"vertices/4\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v4 -> v1\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Out edges
unix> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=out\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"edges\" : [ \n { \n \"_id\" : \"edges/5\", \n \"_rev\" : \"78240598\", \n \"_key\" : \"5\", \n \"_from\" : \"vertices/1\", \n \"_to\" : \"vertices/3\", \n \"$label\" : \"v1 -> v3\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Any direction
unix> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"edges\" : [ \n { \n \"_id\" : \"edges/6\", \n \"_rev\" : \"67125805\", \n \"_key\" : \"6\", \n \"_from\" : \"vertices/2\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v2 -> v1\" \n }, \n { \n \"_id\" : \"edges/7\", \n \"_rev\" : \"67715629\", \n \"_key\" : \"7\", \n \"_from\" : \"vertices/4\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v4 -> v1\" \n }, \n { \n \"_id\" : \"edges/5\", \n \"_rev\" : \"66535981\", \n \"_key\" : \"5\", \n \"_from\" : \"vertices/1\", \n \"_to\" : \"vertices/3\", \n \"$label\" : \"v1 -> v3\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
In edges
unix> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=in\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"edges\" : [ \n { \n \"_id\" : \"edges/6\", \n \"_rev\" : \"72892973\", \n \"_key\" : \"6\", \n \"_from\" : \"vertices/2\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v2 -> v1\" \n }, \n { \n \"_id\" : \"edges/7\", \n \"_rev\" : \"73482797\", \n \"_key\" : \"7\", \n \"_from\" : \"vertices/4\", \n \"_to\" : \"vertices/1\", \n \"$label\" : \"v4 -> v1\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Out edges
unix> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=out\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"edges\" : [ \n { \n \"_id\" : \"edges/5\", \n \"_rev\" : \"78070317\", \n \"_key\" : \"5\", \n \"_from\" : \"vertices/1\", \n \"_to\" : \"vertices/3\", \n \"$label\" : \"v1 -> v3\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsIn-OrOutboundEdges"
}
],
diff --git a/html/admin/api-docs/graph.json b/html/admin/api-docs/graph.json
index 889f1376ac..75ea580b14 100644
--- a/html/admin/api-docs/graph.json
+++ b/html/admin/api-docs/graph.json
@@ -38,7 +38,7 @@
"notes": "Creates a new graph.
Returns an object with an attribute graph containing a list of all graph properties.
",
"summary": "create graph",
"httpMethod": "POST",
- "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/\n{\"_key\":\"graph\",\"vertices\":\"vertices\",\"edges\":\"edges\"}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: 84073302\n\n{ \n \"graph\" : { \n \"_id\" : \"_graphs/graph\", \n \"_rev\" : \"84073302\", \n \"_key\" : \"graph\", \n \"edges\" : \"edges\", \n \"vertices\" : \"vertices\" \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/\n{\"_key\":\"graph\",\"vertices\":\"vertices\",\"edges\":\"edges\"}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: 83968557\n\n{ \n \"graph\" : { \n \"_id\" : \"_graphs/graph\", \n \"_rev\" : \"83968557\", \n \"_key\" : \"graph\", \n \"edges\" : \"edges\", \n \"vertices\" : \"vertices\" \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createGraph"
}
],
@@ -89,7 +89,7 @@
"notes": "
If graph-name is specified, returns an object with an attribute graph containing a JSON hash with all properties of the specified graph.
If graph-name is not specified, returns a list of graph objects.
",
"summary": "get the properties of a specific or all graphs",
"httpMethod": "GET",
- "examples": "get graph by name
unix> curl --dump - http://localhost:8529/_api/graph/graph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 86498134\n\n{ \n \"graph\" : { \n \"_id\" : \"_graphs/graph\", \n \"_rev\" : \"86498134\", \n \"_key\" : \"graph\", \n \"edges\" : \"edges\", \n \"vertices\" : \"vertices\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
get all graphs
unix> curl --dump - http://localhost:8529/_api/graph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"graphs\" : [ \n { \n \"_id\" : \"_graphs/graph2\", \n \"_rev\" : \"91151190\", \n \"_key\" : \"graph2\", \n \"edges\" : \"edges2\", \n \"vertices\" : \"vertices2\" \n }, \n { \n \"_id\" : \"_graphs/graph1\", \n \"_rev\" : \"88988502\", \n \"_key\" : \"graph1\", \n \"edges\" : \"edges1\", \n \"vertices\" : \"vertices1\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "get graph by name
unix> curl --dump - http://localhost:8529/_api/graph/graph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 86327853\n\n{ \n \"graph\" : { \n \"_id\" : \"_graphs/graph\", \n \"_rev\" : \"86327853\", \n \"_key\" : \"graph\", \n \"edges\" : \"edges\", \n \"vertices\" : \"vertices\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
get all graphs
unix> curl --dump - http://localhost:8529/_api/graph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"graphs\" : [ \n { \n \"_id\" : \"_graphs/graph2\", \n \"_rev\" : \"91046445\", \n \"_key\" : \"graph2\", \n \"edges\" : \"edges2\", \n \"vertices\" : \"vertices2\" \n }, \n { \n \"_id\" : \"_graphs/graph1\", \n \"_rev\" : \"88752685\", \n \"_key\" : \"graph1\", \n \"edges\" : \"edges1\", \n \"vertices\" : \"vertices1\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "getThePropertiesOfASpecificOrAllGraphs"
}
],
@@ -178,7 +178,7 @@
"notes": "Creates a vertex in a graph.
Returns an object with an attribute vertex containing a list of all vertex properties.
",
"summary": "create vertex",
"httpMethod": "POST",
- "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertex\n{\"_key\":\"v1\",\"optional1\":\"val1\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 97049430\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"97049430\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
+ "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertex\n{\"_key\":\"v1\",\"optional1\":\"val1\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 96879149\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"96879149\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
"nickname": "createVertex"
}
],
@@ -235,7 +235,7 @@
"notes": "Returns an object with an attribute vertex containing a list of all vertex properties.
",
"summary": "get vertex",
"httpMethod": "GET",
- "examples": "get vertex properties by name
unix> curl --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 99867478\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"99867478\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "get vertex properties by name
unix> curl --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 99697197\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"99697197\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "getVertex"
}
],
@@ -356,7 +356,7 @@
"notes": "Replaces the vertex properties.
Returns an object with an attribute vertex containing a list of all vertex properties.
",
"summary": "update vertex",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{\"optional1\":\"val2\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 106814294\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"106814294\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val2\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{\"optional1\":\"val2\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 106644013\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"106644013\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val2\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
"nickname": "updateVertex"
}
],
@@ -426,7 +426,7 @@
"notes": "Partially updates the vertex properties.
Setting an attribute value to null in the patch document will cause a value of null be saved for the attribute by default. If the intention is to delete existing attributes with the patch command, the URL parameter keepNull can be used with a value of false. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of null. Returns an object with an attribute vertex containing a list of all vertex properties.
",
"summary": "update vertex",
"httpMethod": "PATCH",
- "examples": "
unix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{\"optional1\":\"vertexPatch\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 110222166\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"110222166\", \n \"_key\" : \"v1\", \n \"optional1\" : \"vertexPatch\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\nunix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{\"optional1\":null}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 110746454\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"110746454\", \n \"_key\" : \"v1\", \n \"optional1\" : null \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
+ "examples": "
unix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{\"optional1\":\"vertexPatch\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 110051885\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"110051885\", \n \"_key\" : \"v1\", \n \"optional1\" : \"vertexPatch\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\nunix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{\"optional1\":null}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 110576173\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"110576173\", \n \"_key\" : \"v1\", \n \"optional1\" : null \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
"nickname": "updateVertex"
}
],
@@ -460,7 +460,7 @@
"notes": "Returns a cursor.
The call expects a JSON hash array as body to filter the result:
- batchSize: the batch size of the returned cursor- limit: limit the result size- count: return the total number of results (default \"false\")- filter: a optional filter
The attributes of filter - properties: filter by an array of vertex properties
The attributes of a property filter - key: filter the result vertices by a key value pair- value: the value of the key- compare: a compare operator
",
"summary": "get vertices",
"httpMethod": "POST",
- "examples": "Select all vertices
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertices\n{\"batchSize\":100}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v5\", \n \"_rev\" : \"114940758\", \n \"_key\" : \"v5\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v4\", \n \"_rev\" : \"114613078\", \n \"_key\" : \"v4\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"113630038\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v3\", \n \"_rev\" : \"114285398\", \n \"_key\" : \"v3\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v2\", \n \"_rev\" : \"113957718\", \n \"_key\" : \"v2\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Select all vertices
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertices\n{\"batchSize\":100}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v5\", \n \"_rev\" : \"114770477\", \n \"_key\" : \"v5\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v4\", \n \"_rev\" : \"114442797\", \n \"_key\" : \"v4\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"113394221\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v3\", \n \"_rev\" : \"114115117\", \n \"_key\" : \"v3\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v2\", \n \"_rev\" : \"113787437\", \n \"_key\" : \"v2\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "getVertices"
}
],
@@ -494,7 +494,7 @@
"notes": "Returns a cursor.
The call expects a JSON hash array as body to filter the result:
- batchSize: the batch size of the returned cursor- limit: limit the result size- count: return the total number of results (default \"false\")- filter: a optional filter
The attributes of filter - direction: Filter for inbound (value \"in\") or outbound (value \"out\") neighbors. Default value is \"any\". - labels: filter by an array of edge labels (empty array means no restriction)- properties: filter neighbors by an array of edge properties
The attributes of a property filter - key: filter the result vertices by a key value pair- value: the value of the key- compare: a compare operator
",
"summary": "get vertices",
"httpMethod": "POST",
- "examples": "Select all vertices
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertices/v2\n{\"batchSize\" : 100, \"filter\" : {\"direction\" : \"any\", \"properties\":[] }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"117889878\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v4\", \n \"_rev\" : \"118938454\", \n \"_key\" : \"v4\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Select vertices by direction and property filter
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertices/v2\n{\"batchSize\" : 100, \"filter\" : {\"direction\" : \"out\", \"properties\":[ { \"key\": \"optional1\", \"value\": \"val2\", \"compare\" : \"==\" }, ] }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v4\", \n \"_rev\" : \"126081878\", \n \"_key\" : \"v4\", \n \"optional1\" : \"val2\" \n }, \n { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"125033302\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Select all vertices
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertices/v2\n{\"batchSize\" : 100, \"filter\" : {\"direction\" : \"any\", \"properties\":[] }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"117719597\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v4\", \n \"_rev\" : \"118768173\", \n \"_key\" : \"v4\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Select vertices by direction and property filter
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/vertices/v2\n{\"batchSize\" : 100, \"filter\" : {\"direction\" : \"out\", \"properties\":[ { \"key\": \"optional1\", \"value\": \"val2\", \"compare\" : \"==\" }, ] }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v4\", \n \"_rev\" : \"125911597\", \n \"_key\" : \"v4\", \n \"optional1\" : \"val2\" \n }, \n { \n \"_id\" : \"vertices/v1\", \n \"_rev\" : \"124928557\", \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "getVertices"
}
],
@@ -538,7 +538,7 @@
"notes": "Creates an edge in a graph.
The call expects a JSON hash array as body with the edge properties:
- _key: The name of the edge.- _from: The name of the from vertex.- _to: The name of the to vertex.- $label: A label for the edge (optional).- further optional attributes.
Returns an object with an attribute edge containing the list of all edge properties.
",
"summary": "create edge",
"httpMethod": "POST",
- "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/edge\n{\"_key\":\"edge1\",\"_from\":\"vert2\",\"_to\":\"vert1\",\"optional1\":\"val1\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 133290838\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"133290838\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert2\", \n \"_to\" : \"vertices/vert1\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
+ "examples": "
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/edge\n{\"_key\":\"edge1\",\"_from\":\"vert2\",\"_to\":\"vert1\",\"optional1\":\"val1\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 133120557\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"133120557\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert2\", \n \"_to\" : \"vertices/vert1\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
"nickname": "createEdge"
}
],
@@ -595,7 +595,7 @@
"notes": "Returns an object with an attribute edge containing a list of all edge properties.
",
"summary": "get edge",
"httpMethod": "GET",
- "examples": "
unix> curl --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 137222998\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"137222998\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 137052717\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"137052717\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "getEdge"
}
],
@@ -716,7 +716,7 @@
"notes": "Replaces the optional edge properties.
The call expects a JSON hash array as body with the new edge properties.
Returns an object with an attribute edge containing a list of all edge properties.
",
"summary": "update edge",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n{\"optional1\":\"val2\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 146135894\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"146135894\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val2\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n{\"optional1\":\"val2\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 145965613\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"145965613\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val2\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
"nickname": "updateEdge"
}
],
@@ -786,7 +786,7 @@
"notes": "Partially updates the edge properties.
Setting an attribute value to null in the patch document will cause a value of null be saved for the attribute by default. If the intention is to delete existing attributes with the patch command, the URL parameter keepNull can be used with a value of false. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of null.
Returns an object with an attribute edge containing a list of all edge properties.
",
"summary": "update edge",
"httpMethod": "PATCH",
- "examples": "
unix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n{\"optional3\":\"val3\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 150657878\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"150657878\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val1\", \n \"optional3\" : \"val3\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
+ "examples": "
unix> curl -X PATCH --data @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n{\"optional3\":\"val3\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 150487597\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"150487597\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val1\", \n \"optional3\" : \"val3\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n\n
",
"nickname": "updateEdge"
}
],
@@ -820,7 +820,7 @@
"notes": "Returns a cursor.
The call expects a JSON hash array as body to filter the result:
- batchSize: the batch size of the returned cursor- limit: limit the result size- count: return the total number of results (default \"false\")- filter: a optional filter
The attributes of filter - labels: filter by an array of edge labels- properties: filter by an array of edge properties
The attributes of a property filter - key: filter the result edges by a key value pair- value: the value of the key- compare: a compare operator
",
"summary": "get edges",
"httpMethod": "POST",
- "examples": "Select all edges
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/edges\n{\"batchSize\":100}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"edges/edge4\", \n \"_rev\" : \"157408086\", \n \"_key\" : \"edge4\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v5\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"155638614\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge2\", \n \"_rev\" : \"156228438\", \n \"_key\" : \"edge2\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v3\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge3\", \n \"_rev\" : \"156818262\", \n \"_key\" : \"edge3\", \n \"_from\" : \"vertices/v2\", \n \"_to\" : \"vertices/v4\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Select all edges
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/edges\n{\"batchSize\":100}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"edges/edge4\", \n \"_rev\" : \"157237805\", \n \"_key\" : \"edge4\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v5\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"155468333\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge2\", \n \"_rev\" : \"156058157\", \n \"_key\" : \"edge2\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v3\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge3\", \n \"_rev\" : \"156647981\", \n \"_key\" : \"edge3\", \n \"_from\" : \"vertices/v2\", \n \"_to\" : \"vertices/v4\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "getEdges"
}
],
@@ -861,7 +861,7 @@
"notes": "
Returns a cursor.
The call expects a JSON hash array as body to filter the result:
- batchSize: the batch size of the returned cursor- limit: limit the result size- count: return the total number of results (default \"false\")- filter: a optional filter
The attributes of filter - direction: Filter for inbound (value \"in\") or outbound (value \"out\") neighbors. Default value is \"any\". - labels: filter by an array of edge labels- properties: filter neighbors by an array of properties
The attributes of a property filter - key: filter the result vertices by a key value pair- value: the value of the key- compare: a compare operator
",
"summary": "get edges",
"httpMethod": "POST",
- "examples": "Select all edges
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/edges/v2\n{\"batchSize\" : 100, \"filter\" : { \"direction\" : \"any\" }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"162519894\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge3\", \n \"_rev\" : \"163699542\", \n \"_key\" : \"edge3\", \n \"_from\" : \"vertices/v2\", \n \"_to\" : \"vertices/v4\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Select all edges
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/graph/graph/edges/v2\n{\"batchSize\" : 100, \"filter\" : { \"direction\" : \"any\" }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"edges/edge1\", \n \"_rev\" : \"162349613\", \n \"_key\" : \"edge1\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge3\", \n \"_rev\" : \"163529261\", \n \"_key\" : \"edge3\", \n \"_from\" : \"vertices/v2\", \n \"_to\" : \"vertices/v4\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "getEdges"
}
],
diff --git a/html/admin/api-docs/index.json b/html/admin/api-docs/index.json
index c565974745..f233e7aa17 100644
--- a/html/admin/api-docs/index.json
+++ b/html/admin/api-docs/index.json
@@ -92,7 +92,7 @@
"notes": "
Creates a cap constraint (the manual) for the collection collection-name, if it does not already exist. Expects an object containing the index details.
- type: must be equal to \"cap\".
- size: The maximal number of documents for the collection.
- byteSize: The maximal size of the active document data in the collection.
Note that the cap constraint does not index particular attributes of the documents in a collection, but limits the number of documents in the collection to a maximum value. The cap constraint thus does not support attribute names specified in the fields attribute nor uniqueness of any kind via the unique attribute.
It is allowed to specify either size or byteSize, or both at the same time. If both are specified, then the automatic document removal will be triggered by the first non-met constraint.
",
"summary": "creates a cap constraint",
"httpMethod": "POST",
- "examples": "Creating a cap constraint
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{\"type\":\"cap\",\"size\":10}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/167107414\", \n \"type\" : \"cap\", \n \"unique\" : false, \n \"size\" : 10, \n \"byteSize\" : 0, \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Creating a cap constraint
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{\"type\":\"cap\",\"size\":10}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/166937133\", \n \"type\" : \"cap\", \n \"unique\" : false, \n \"size\" : 10, \n \"byteSize\" : 0, \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createsACapConstraint"
}
],
@@ -134,7 +134,7 @@
"notes": "
Creates a geo-spatial index in the collection collection-name, if it does not already exist. Expects an object containing the index details.
- type: must be equal to \"geo\".
- fields: A list with one or two attribute paths.
If it is a list with one attribute path location, then a geo-spatial index on all documents is created using location as path to the coordinates. The value of the attribute must be a list with at least two double values. The list must contain the latitude (first value) and the longitude (second value). All documents, which do not have the attribute path or with value that are not suitable, are ignored.
If it is a list with two attribute paths latitude and longitude, then a geo-spatial index on all documents is created using latitude and longitude as paths the latitude and the longitude. The value of the attribute latitude and of the attribute longitude must a double. All documents, which do not have the attribute paths or which values are not suitable, are ignored.
- geoJson: If a geo-spatial index on a location is constructed and geoJson is true, then the order within the list is longitude followed by latitude. This corresponds to the format described in http://geojson.org/geojson-spec.html#positions
- constraint: If constraint is true, then a geo-spatial constraint is created. The constraint is a non-unique variant of the index. Note that it is also possible to set the unique attribute instead of the constraint attribute.
- ignoreNull: If a geo-spatial constraint is created and ignoreNull is true, then documents with a null in location or at least one null in latitude or longitude are ignored.
",
"summary": "creates a geo-spatial index",
"httpMethod": "POST",
- "examples": "Creating a geo index with a location attribute:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"geo\", \"fields\" : [ \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/167959382\", \n \"type\" : \"geo1\", \n \"unique\" : false, \n \"geoJson\" : false, \n \"constraint\" : false, \n \"fields\" : [ \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Creating a geo index with latitude and longitude attributes:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"geo\", \"fields\" : [ \"e\", \"f\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/168811350\", \n \"type\" : \"geo2\", \n \"unique\" : false, \n \"constraint\" : false, \n \"fields\" : [ \n \"e\", \n \"f\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Creating a geo index with a location attribute:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"geo\", \"fields\" : [ \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/167789101\", \n \"type\" : \"geo1\", \n \"unique\" : false, \n \"geoJson\" : false, \n \"constraint\" : false, \n \"fields\" : [ \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Creating a geo index with latitude and longitude attributes:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"geo\", \"fields\" : [ \"e\", \"f\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/168641069\", \n \"type\" : \"geo2\", \n \"unique\" : false, \n \"constraint\" : false, \n \"fields\" : [ \n \"e\", \n \"f\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createsAGeo-spatialIndex"
}
],
@@ -180,7 +180,7 @@
"notes": "
Creates a hash index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.
- type: must be equal to \"hash\".
- fields: A list of attribute paths.
- unique: If true, then create a unique index.
",
"summary": "creates a hash index",
"httpMethod": "POST",
- "examples": "Creating an unique constraint:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"hash\", \"unique\" : true, \"fields\" : [ \"a\", \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/169794390\", \n \"type\" : \"hash\", \n \"unique\" : true, \n \"fields\" : [ \n \"a\", \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Creating a hash index:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"hash\", \"unique\" : false, \"fields\" : [ \"a\", \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/170711894\", \n \"type\" : \"hash\", \n \"unique\" : false, \n \"fields\" : [ \n \"a\", \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Creating an unique constraint:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"hash\", \"unique\" : true, \"fields\" : [ \"a\", \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/169624109\", \n \"type\" : \"hash\", \n \"unique\" : true, \n \"fields\" : [ \n \"a\", \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Creating a hash index:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"hash\", \"unique\" : false, \"fields\" : [ \"a\", \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/170541613\", \n \"type\" : \"hash\", \n \"unique\" : false, \n \"fields\" : [ \n \"a\", \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createsAHashIndex"
}
],
@@ -226,7 +226,7 @@
"notes": "
Creates a skip-list index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.
- type: must be equal to \"skiplist\".
- fields: A list of attribute paths.
- unique: If true, then create a unique index.
",
"summary": "creates a skip list",
"httpMethod": "POST",
- "examples": "Creating a skiplist:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"skiplist\", \"unique\" : false, \"fields\" : [ \"a\", \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/171694934\", \n \"type\" : \"skiplist\", \n \"unique\" : false, \n \"fields\" : [ \n \"a\", \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Creating a skiplist:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\": \"skiplist\", \"unique\" : false, \"fields\" : [ \"a\", \"b\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/171524653\", \n \"type\" : \"skiplist\", \n \"unique\" : false, \n \"fields\" : [ \n \"a\", \n \"b\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createsASkipList"
}
],
@@ -268,7 +268,7 @@
"notes": "
Creates a fulltext index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.
- type: must be equal to \"fulltext\".
- fields: A list of attribute names. Currently, the list is limited to exactly one attribute, so the value of fields should look like this for example: [ \"text\" ].
- minLength: Minimum character length of words to index. Will default to a server-defined value if unspecified. It is thus recommended to set this value explicitly when creating the index.
",
"summary": "creates a fulltext index",
"httpMethod": "POST",
- "examples": "Creating a fulltext index:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\" : \"fulltext\", \"fields\" : [ \"text\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/172546902\", \n \"type\" : \"fulltext\", \n \"unique\" : false, \n \"minLength\" : 2, \n \"fields\" : [ \n \"text\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Creating a fulltext index:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\" : \"fulltext\", \"fields\" : [ \"text\" ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/172376621\", \n \"type\" : \"fulltext\", \n \"unique\" : false, \n \"minLength\" : 2, \n \"fields\" : [ \n \"text\" \n ], \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createsAFulltextIndex"
}
],
@@ -310,7 +310,7 @@
"notes": "
Creates a bitarray index for the collection collection-name, if it does not already exist. The call expects an object containing the index details.
- type: must be equal to \"bitarray\".
- fields: A list of pairs. A pair consists of an attribute path followed by a list of values.
- unique: Must always be set to false.
",
"summary": "creates a bitarray index",
"httpMethod": "POST",
- "examples": "Creating a bitarray index:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\" : \"bitarray\", \"unique\" : false, \"fields\" : [ \"x\", [0,1,[]], \"y\", [\"a\",\"b\",[]] ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/173464406\", \n \"type\" : \"bitarray\", \n \"unique\" : false, \n \"fields\" : [ \n [ \n \"x\", \n [ \n 0, \n 1, \n [ ] \n ] \n ], \n [ \n \"y\", \n [ \n \"a\", \n \"b\", \n [ ] \n ] \n ] \n ], \n \"undefined\" : false, \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Creating a bitarray index:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/index?collection=products\n{ \"type\" : \"bitarray\", \"unique\" : false, \"fields\" : [ \"x\", [0,1,[]], \"y\", [\"a\",\"b\",[]] ] }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/173294125\", \n \"type\" : \"bitarray\", \n \"unique\" : false, \n \"fields\" : [ \n [ \n \"x\", \n [ \n 0, \n 1, \n [ ] \n ] \n ], \n [ \n \"y\", \n [ \n \"a\", \n \"b\", \n [ ] \n ] \n ] \n ], \n \"undefined\" : false, \n \"isNewlyCreated\" : true, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "createsABitarrayIndex"
}
],
@@ -375,7 +375,7 @@
"notes": "
Deletes an index with index-handle.
",
"summary": "deletes an index",
"httpMethod": "DELETE",
- "examples": "
unix> curl -X DELETE --dump - http://localhost:8529/_api/index/products/174381910\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/174381910\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X DELETE --dump - http://localhost:8529/_api/index/products/174211629\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"id\" : \"products/174211629\", \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "deletesAnIndex"
}
],
diff --git a/html/admin/api-docs/replication.json b/html/admin/api-docs/replication.json
index 3012c9a52d..cc46b794db 100644
--- a/html/admin/api-docs/replication.json
+++ b/html/admin/api-docs/replication.json
@@ -78,7 +78,7 @@
"notes": "Returns the current state of the server's replication logger. The state will include information about whether the logger is running and about the last logged tick value. This tick value is important for incremental fetching of data.
The state API can be called regardless of whether the logger is currently running or not.
The body of the response contains a JSON object with the following attributes:
- state: the current logger state as a JSON hash array with the following sub-attributes:
- running: whether or not the logger is running
- lastLogTick: the tick value of the latest tick the logger has logged. This value can be used for incremental fetching of log data.
- time: the current date and time on the logger server
- server: a JSON hash with the following sub-attributes:
- version: the logger server's version
- serverId: the logger server's id
- clients: a list of all replication clients that ever connected to the logger since it was started. This list can be used to determine approximately how much data the individual clients have already fetched from the logger server.
",
"summary": "returns the replication logger state",
"httpMethod": "GET",
- "examples": "Returns the state of an inactive replication logger.
unix> curl --dump - http://localhost:8529/_api/replication/logger-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : false, \n \"lastLogTick\" : \"329440086\", \n \"time\" : \"2013-07-31T08:10:23Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"91240505282090\" \n }, \n \"clients\" : [ ] \n}\n\n
Returns the state of an active replication logger.
unix> curl --dump - http://localhost:8529/_api/replication/logger-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : true, \n \"lastLogTick\" : \"329636694\", \n \"time\" : \"2013-07-31T08:10:23Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"91240505282090\" \n }, \n \"clients\" : [ ] \n}\n\n
",
+ "examples": "Returns the state of an inactive replication logger.
unix> curl --dump - http://localhost:8529/_api/replication/logger-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : false, \n \"lastLogTick\" : \"329335341\", \n \"time\" : \"2013-08-01T12:54:42Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"214732365112692\" \n }, \n \"clients\" : [ ] \n}\n\n
Returns the state of an active replication logger.
unix> curl --dump - http://localhost:8529/_api/replication/logger-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : true, \n \"lastLogTick\" : \"329597485\", \n \"time\" : \"2013-08-01T12:54:42Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"214732365112692\" \n }, \n \"clients\" : [ ] \n}\n\n
",
"nickname": "returnsTheReplicationLoggerState"
}
],
@@ -102,10 +102,10 @@
}
],
"parameters": [],
- "notes": "Returns the configuration of the replication logger.
The body of the response is a JSON hash with the configuration. The following attributes may be present in the configuration:
- logRemoteChanges: whether or not externally created changes should be logged by the local logger
",
+ "notes": "Returns the configuration of the replication logger.
The body of the response is a JSON hash with the configuration. The following attributes may be present in the configuration:
- logRemoteChanges: whether or not externally created changes should be logged by the local logger
- maxEvents: the maximum number of log events kept by the replication logger before deleting oldest events
- maxEventsSize: the maximum cumulated size of log event data kept by the replication logger before deleting oldest events
",
"summary": "returns the configuration of the replication logger",
"httpMethod": "GET",
- "examples": "
unix> curl --dump - http://localhost:8529/_api/replication/logger-config\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"logRemoteChanges\" : false \n}\n\n
",
+ "examples": "
unix> curl --dump - http://localhost:8529/_api/replication/logger-config\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"logRemoteChanges\" : false, \n \"maxEvents\" : 1048576, \n \"maxEventsSize\" : 0 \n}\n\n
",
"nickname": "returnsTheConfigurationOfTheReplicationLogger"
}
],
@@ -141,10 +141,10 @@
"description": "A JSON representation of the configuration. "
}
],
- "notes": "Sets the configuration of the replication logger.
The body of the request must be JSON hash with the configuration. The following attributes are allowed for the configuration:
- logRemoteChanges: whether or not externally created changes should be logged by the local logger
In case of success, the body of the response is a JSON hash with the updated configuration.
",
+ "notes": "Sets the configuration of the replication logger.
The body of the request must be JSON hash with the configuration. The following attributes are allowed for the configuration:
- logRemoteChanges: whether or not externally created changes should be logged by the local logger
- maxEvents: the maximum number of log events kept by the replication logger before deleting oldest events
- maxEventsSize: the maximum cumulated size of log event data kept by the replication logger before deleting oldest events
In case of success, the body of the response is a JSON hash with the updated configuration.
",
"summary": "adjusts the configuration of the replication logger",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/replication/logger-config\n{\"logRemoteChanges\":true}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"logRemoteChanges\" : true \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/replication/logger-config\n{\"logRemoteChanges\":true,\"maxEvents\":1048576}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"logRemoteChanges\" : true, \n \"maxEvents\" : 1048576, \n \"maxEventsSize\" : 0 \n}\n\n
",
"nickname": "adjustsTheConfigurationOfTheReplicationLogger"
}
],
@@ -198,7 +198,7 @@
"notes": "Returns data from the server's replication log. This method can be called by replication clients after an initial synchronisation of data. The method will return all \"recent\" log entries from the logger server, and the clients can replay and apply these entries locally so they get to the same data state as the logger server.
Clients can call this method repeatedly to incrementally fetch all changes from the logger server. In this case, they should provide the from value so they will only get returned the log events since their last fetch.
When the from URL parameter is not used, the logger server will return log entries starting at the beginning of its replication log. When the from parameter is used, the logger server will only return log entries which have higher tick values than the specified from value (note: the log entry with a tick value equal to from will be excluded). Use the from value when incrementally fetching log data.
The to URL parameter can be used to optionally restrict the upper bound of the result to a certain tick value. If used, the result will contain only log events with tick values up to (including) to. In incremental fetching, there is no need to use the to parameter. It only makes sense in special situations, when only parts of the change log are required.
The chunkSize URL parameter can be used to control the size of the result. It must be specified in bytes. The chunkSize value will only be honored approximately. Otherwise a too low chunkSize value could cause the server to not be able to put just one log entry into the result and return it. Therefore, the chunkSize value will only be consulted after a log entry has been written into the result. If the result size is then bigger than chunkSize, the server will respond with as many log entries as there are in the response already. If the result size is still smaller than chunkSize, the server will try to return more data if there's more data left to return.
If chunkSize is not specified, some server-side default value will be used.
The Content-Type of the result is application/x-arango-dump. This is an easy-to-process format, with all log events going onto separate lines in the response body. Each log event itself is a JSON hash, with at least the following attributes:
- tick: the log event tick value
- type: the log event type
Individual log events will also have additional attributes, depending on the event type. A few common attributes which are used for multiple events types are:
- cid: id of the collection the event was for
- tid: id of the transaction the event was contained in
- key: document key
- rev: document revision id
- data: the original document data
A more detailed description of the individual replication event types and their data structures can be found in the manual.
The response will also contain the following HTTP headers:
- x-arango-replication-active: whether or not the logger is active. Clients can use this flag as an indication for their polling frequency. If the logger is not active and there are no more replication events available, it might be sensible for a client to abort, or to go to sleep for a long time and try again later to check whether the logger has been activated.
- x-arango-replication-lastincluded: the tick value of the last included value in the result. In incremental log fetching, this value can be used as the from value for the following request. Note that if the result is empty, the value will be 0. This value should not be used as from value by clients in the next request (otherwise the server would return the log events from the start of the log again).
- x-arango-replication-lasttick: the last tick value the logger server has logged (not necessarily included in the result). By comparing the the last tick and last included tick values, clients have an approximate indication of how many events there are still left to fetch.
- x-arango-replication-checkmore: whether or not there already exists more log data which the client could fetch immediately. If there is more log data available, the client could call logger-follow again with an adjusted from value to fetch remaining log entries until there are no more.
If there isn't any more log data to fetch, the client might decide to go to sleep for a while before calling the logger again.
",
"summary": "returns recent log entries from the replication log",
"httpMethod": "GET",
- "examples": "No log events available:
unix> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=329964374\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-active: true\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\nx-arango-replication-lasttick: 329964374\n\n
A few log events:
unix> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=330292054\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-active: true\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 332847958\nx-arango-replication-lasttick: 332847958\n\n{\"tick\":\"331078486\",\"type\":2000,\"cid\":\"330357590\",\"collection\":{\"version\":4,\"type\":2,\"cid\":\"330357590\",\"deleted\":false,\"doCompact\":true,\"maximalSize\":1048576,\"name\":\"products\",\"isVolatile\":false,\"waitForSync\":false}}\n{\"tick\":\"331602774\",\"type\":2300,\"cid\":\"330357590\",\"key\":\"p1\",\"rev\":\"331340630\",\"data\":{\"_key\":\"p1\",\"_rev\":\"331340630\",\"name\":\"flux compensator\"}}\n{\"tick\":\"332061526\",\"type\":2300,\"cid\":\"330357590\",\"key\":\"p2\",\"rev\":\"331864918\",\"data\":{\"_key\":\"p2\",\"_rev\":\"331864918\",\"hp\":5100,\"name\":\"hybrid hovercraft\"}}\n{\"tick\":\"332389206\",\"type\":2302,\"cid\":\"330357590\",\"key\":\"p1\",\"rev\":\"332192598\",\"oldRev\":\"331340630\"}\n{\"tick\":\"332716886\",\"type\":2300,\"cid\":\"330357590\",\"key\":\"p2\",\"rev\":\"332520278\",\"oldRev\":\"331864918\",\"data\":{\"_key\":\"p2\",\"_rev\":\"332520278\",\"hp\":5100,\"name\":\"broken hovercraft\"}}\n{\"tick\":\"332847958\",\"type\":2001,\"cid\":\"330357590\"}\n\n\n
More events than would fit into the response:
unix> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=333175638&chunkSize=400\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-active: true\nx-arango-replication-checkmore: true\nx-arango-replication-lastincluded: 334945110\nx-arango-replication-lasttick: 335731542\n\n{\"tick\":\"333962070\",\"type\":2000,\"cid\":\"333241174\",\"collection\":{\"version\":4,\"type\":2,\"cid\":\"333241174\",\"deleted\":false,\"doCompact\":true,\"maximalSize\":1048576,\"name\":\"products\",\"isVolatile\":false,\"waitForSync\":false}}\n{\"tick\":\"334486358\",\"type\":2300,\"cid\":\"333241174\",\"key\":\"p1\",\"rev\":\"334224214\",\"data\":{\"_key\":\"p1\",\"_rev\":\"334224214\",\"name\":\"flux compensator\"}}\n{\"tick\":\"334945110\",\"type\":2300,\"cid\":\"333241174\",\"key\":\"p2\",\"rev\":\"334748502\",\"data\":{\"_key\":\"p2\",\"_rev\":\"334748502\",\"hp\":5100,\"name\":\"hybrid hovercraft\"}}\n\n\n
",
+ "examples": "No log events available:
unix> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=329990701\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-active: true\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\nx-arango-replication-lasttick: 329990701\n\n
A few log events:
unix> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=330383917\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-active: true\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 332939821\nx-arango-replication-lasttick: 332939821\n\n{\"tick\":\"331170349\",\"type\":2000,\"cid\":\"330449453\",\"collection\":{\"version\":4,\"type\":2,\"cid\":\"330449453\",\"deleted\":false,\"doCompact\":true,\"maximalSize\":1048576,\"name\":\"products\",\"isVolatile\":false,\"waitForSync\":false}}\n{\"tick\":\"331694637\",\"type\":2300,\"cid\":\"330449453\",\"key\":\"p1\",\"rev\":\"331432493\",\"data\":{\"_key\":\"p1\",\"_rev\":\"331432493\",\"name\":\"flux compensator\"}}\n{\"tick\":\"332153389\",\"type\":2300,\"cid\":\"330449453\",\"key\":\"p2\",\"rev\":\"331956781\",\"data\":{\"_key\":\"p2\",\"_rev\":\"331956781\",\"hp\":5100,\"name\":\"hybrid hovercraft\"}}\n{\"tick\":\"332481069\",\"type\":2302,\"cid\":\"330449453\",\"key\":\"p1\",\"rev\":\"332284461\",\"oldRev\":\"331432493\"}\n{\"tick\":\"332808749\",\"type\":2300,\"cid\":\"330449453\",\"key\":\"p2\",\"rev\":\"332612141\",\"oldRev\":\"331956781\",\"data\":{\"_key\":\"p2\",\"_rev\":\"332612141\",\"hp\":5100,\"name\":\"broken hovercraft\"}}\n{\"tick\":\"332939821\",\"type\":2001,\"cid\":\"330449453\"}\n\n\n
More events than would fit into the response:
unix> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=333333037&chunkSize=400\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-active: true\nx-arango-replication-checkmore: true\nx-arango-replication-lastincluded: 335102509\nx-arango-replication-lasttick: 335888941\n\n{\"tick\":\"334119469\",\"type\":2000,\"cid\":\"333398573\",\"collection\":{\"version\":4,\"type\":2,\"cid\":\"333398573\",\"deleted\":false,\"doCompact\":true,\"maximalSize\":1048576,\"name\":\"products\",\"isVolatile\":false,\"waitForSync\":false}}\n{\"tick\":\"334643757\",\"type\":2300,\"cid\":\"333398573\",\"key\":\"p1\",\"rev\":\"334381613\",\"data\":{\"_key\":\"p1\",\"_rev\":\"334381613\",\"name\":\"flux compensator\"}}\n{\"tick\":\"335102509\",\"type\":2300,\"cid\":\"333398573\",\"key\":\"p2\",\"rev\":\"334905901\",\"data\":{\"_key\":\"p2\",\"_rev\":\"334905901\",\"hp\":5100,\"name\":\"hybrid hovercraft\"}}\n\n\n
",
"nickname": "returnsRecentLogEntriesFromTheReplicationLog"
}
],
@@ -225,7 +225,7 @@
"notes": "Returns the list of collections and indexes available on the server. This list can be used by replication clients to initiate an initial sync with the server.
The response will contain a JSON hash array with the collection and state attributes.
collections is a list of collections with the following sub-attributes:
- parameters: the collection properties
- indexes: a list of the indexes of a the collection. Primary indexes and edges indexes are not included in this list.
The state attribute contains the current state of the replication logger. It contains the following sub-attributes:
- running: whether or not the replication logger is currently active
- lastLogTick: the value of the last tick the replication logger has written
- time: the current time on the server
Replication clients should note the lastLogTick value returned. They can then fetch collections' data using the dump method up to the value of lastLogTick, and query the continuous replication log for log events after this tick value.
To create a full copy of the collections on the logger server, a replication client can execute these steps:
- call the /inventory API method. This returns the lastLogTick value and the list of collections and indexes from the logger server.
- for each collection returned by /inventory, create the collection locally and call /dump to stream the collection data to the client, up to the value of lastLogTick. After that, the client can create the indexes on the collections as they were reported by /inventory.
If the clients wants to continuously stream replication log events from the logger server, the following additional steps need to be carried out:
- the client should call /logger-follow initially to fetch the first batch of replication events that were logged after the client's call to /inventory.
The call to /logger-follow should use a from parameter with the value of the lastLogTick as reported by /inventory. The call to /logger-follow will return the x-arango-replication-lastincluded which will contain the last tick value included in the response.
- the client can then continuously call /logger-follow to incrementally fetch new replication events that occurred after the last transfer.
Calls should use a from parameter with the value of the x-arango-replication-lastincluded header of the previous response. If there are no more replication events, the response will be empty and clients can go to sleep for a while and try again later.
",
"summary": "returns an inventory of collections and indexes",
"httpMethod": "GET",
- "examples": "
unix> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"collections\" : [ \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"17095510\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"demo\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"18602838\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"animals\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"87022422\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"vertices1\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 3, \n \"cid\" : \"89906006\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"edges2\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n } \n ], \n \"state\" : { \n \"running\" : false, \n \"lastLogTick\" : \"335862614\", \n \"time\" : \"2013-07-31T08:10:24Z\" \n } \n}\n\n
With some additional indexes:
unix> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"collections\" : [ \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"17095510\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"demo\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"18602838\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"animals\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"87022422\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"vertices1\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 3, \n \"cid\" : \"89906006\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"edges2\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"335928150\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"IndexedCollection1\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ \n { \n \"id\" : \"336714582\", \n \"type\" : \"hash\", \n \"unique\" : false, \n \"fields\" : [ \n \"name\" \n ] \n }, \n { \n \"id\" : \"336976726\", \n \"type\" : \"skiplist\", \n \"unique\" : true, \n \"fields\" : [ \n \"a\", \n \"b\" \n ] \n }, \n { \n \"id\" : \"337042262\", \n \"type\" : \"cap\", \n \"unique\" : false, \n \"size\" : 500, \n \"byteSize\" : 0 \n } \n ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"337107798\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"IndexedCollection2\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ \n { \n \"id\" : \"337959766\", \n \"type\" : \"fulltext\", \n \"unique\" : false, \n \"minLength\" : 10, \n \"fields\" : [ \n \"text\" \n ] \n }, \n { \n \"id\" : \"338156374\", \n \"type\" : \"skiplist\", \n \"unique\" : false, \n \"fields\" : [ \n \"a\" \n ] \n }, \n { \n \"id\" : \"338221910\", \n \"type\" : \"cap\", \n \"unique\" : false, \n \"size\" : 0, \n \"byteSize\" : 1048576 \n } \n ] \n } \n ], \n \"state\" : { \n \"running\" : false, \n \"lastLogTick\" : \"335862614\", \n \"time\" : \"2013-07-31T08:10:24Z\" \n } \n}\n\n
",
+ "examples": "
unix> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"collections\" : [ \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"16925229\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"demo\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"18432557\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"animals\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"86852141\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"vertices1\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 3, \n \"cid\" : \"89735725\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"edges2\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n } \n ], \n \"state\" : { \n \"running\" : false, \n \"lastLogTick\" : \"336020013\", \n \"time\" : \"2013-08-01T12:54:43Z\" \n } \n}\n\n
With some additional indexes:
unix> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"collections\" : [ \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"16925229\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"demo\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"18432557\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"animals\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"86852141\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"vertices1\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 3, \n \"cid\" : \"89735725\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"edges2\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"336085549\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"IndexedCollection1\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ \n { \n \"id\" : \"336937517\", \n \"type\" : \"hash\", \n \"unique\" : false, \n \"fields\" : [ \n \"name\" \n ] \n }, \n { \n \"id\" : \"337199661\", \n \"type\" : \"skiplist\", \n \"unique\" : true, \n \"fields\" : [ \n \"a\", \n \"b\" \n ] \n }, \n { \n \"id\" : \"337265197\", \n \"type\" : \"cap\", \n \"unique\" : false, \n \"size\" : 500, \n \"byteSize\" : 0 \n } \n ] \n }, \n { \n \"parameters\" : { \n \"version\" : 4, \n \"type\" : 2, \n \"cid\" : \"337330733\", \n \"deleted\" : false, \n \"doCompact\" : true, \n \"maximalSize\" : 1048576, \n \"name\" : \"IndexedCollection2\", \n \"isVolatile\" : false, \n \"waitForSync\" : false \n }, \n \"indexes\" : [ \n { \n \"id\" : \"338182701\", \n \"type\" : \"fulltext\", \n \"unique\" : false, \n \"minLength\" : 10, \n \"fields\" : [ \n \"text\" \n ] \n }, \n { \n \"id\" : \"338379309\", \n \"type\" : \"skiplist\", \n \"unique\" : false, \n \"fields\" : [ \n \"a\" \n ] \n }, \n { \n \"id\" : \"338444845\", \n \"type\" : \"cap\", \n \"unique\" : false, \n \"size\" : 0, \n \"byteSize\" : 1048576 \n } \n ] \n } \n ], \n \"state\" : { \n \"running\" : false, \n \"lastLogTick\" : \"336020013\", \n \"time\" : \"2013-08-01T12:54:43Z\" \n } \n}\n\n
",
"nickname": "returnsAnInventoryOfCollectionsAndIndexes"
}
],
@@ -286,7 +286,7 @@
"notes": "Returns the data from the collection for the requested range.
When the from URL parameter is not used, collection events are returned from the beginning. When the from parameter is used, the result will only contain collection entries which have higher tick values than the specified from value (note: the log entry with a tick value equal to from will be excluded).
The to URL parameter can be used to optionally restrict the upper bound of the result to a certain tick value. If used, the result will only contain collection entries with tick values up to (including) to.
The chunkSize URL parameter can be used to control the size of the result. It must be specified in bytes. The chunkSize value will only be honored approximately. Otherwise a too low chunkSize value could cause the server to not be able to put just one entry into the result and return it. Therefore, the chunkSize value will only be consulted after an entry has been written into the result. If the result size is then bigger than chunkSize, the server will respond with as many entries as there are in the response already. If the result size is still smaller than chunkSize, the server will try to return more data if there's more data left to return.
If chunkSize is not specified, some server-side default value will be used.
The Content-Type of the result is application/x-arango-dump. This is an easy-to-process format, with all entries going onto separate lines in the response body.
Each line itself is a JSON hash, with at least the following attributes:
- type: the type of entry. Possible values for type are:
- 2300: document insertion/update
- 2301: edge insertion/update
- 2302: document/edge deletion
- key: the key of the document/edge or the key used in the deletion operation
- rev: the revision id of the document/edge or the deletion operation
- data: the actual document/edge data for types 2300 and 2301. The full document/edge data will be returned even for updates.
A more detailed description of the different entry types and their data structures can be found in the manual.
Note: there will be no distinction between inserts and updates when calling this method.
",
"summary": "returns the data of a collection",
"httpMethod": "GET",
- "examples": "Empty collection:
unix> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\n\n
Non-empty collection:
unix> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 341433174\n\n{\"tick\":\"340056918\",\"type\":2300,\"key\":\"abcdef\",\"rev\":\"339991382\",\"data\":{\"_key\":\"abcdef\",\"_rev\":\"339991382\",\"test\":true,\"a\":\"abc\"}}\n{\"tick\":\"340450134\",\"type\":2300,\"key\":\"123456\",\"rev\":\"340384598\",\"data\":{\"_key\":\"123456\",\"_rev\":\"340384598\",\"c\":false,\"b\":1}}\n{\"tick\":\"340777814\",\"type\":2300,\"key\":\"123456\",\"rev\":\"340712278\",\"data\":{\"_key\":\"123456\",\"_rev\":\"340712278\",\"c\":false,\"b\":1,\"d\":\"additional value\"}}\n{\"tick\":\"341039958\",\"type\":2300,\"key\":\"foobar\",\"rev\":\"340974422\",\"data\":{\"_key\":\"foobar\",\"_rev\":\"340974422\"}}\n{\"tick\":\"341236566\",\"type\":2302,\"key\":\"foobar\",\"rev\":\"341171030\"}\n{\"tick\":\"341433174\",\"type\":2302,\"key\":\"abcdef\",\"rev\":\"341367638\"}\n\n\n
",
+ "examples": "Empty collection:
unix> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\n\n
Non-empty collection:
unix> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 341656109\n\n{\"tick\":\"340279853\",\"type\":2300,\"key\":\"abcdef\",\"rev\":\"340214317\",\"data\":{\"_key\":\"abcdef\",\"_rev\":\"340214317\",\"test\":true,\"a\":\"abc\"}}\n{\"tick\":\"340673069\",\"type\":2300,\"key\":\"123456\",\"rev\":\"340607533\",\"data\":{\"_key\":\"123456\",\"_rev\":\"340607533\",\"c\":false,\"b\":1}}\n{\"tick\":\"341000749\",\"type\":2300,\"key\":\"123456\",\"rev\":\"340935213\",\"data\":{\"_key\":\"123456\",\"_rev\":\"340935213\",\"c\":false,\"b\":1,\"d\":\"additional value\"}}\n{\"tick\":\"341262893\",\"type\":2300,\"key\":\"foobar\",\"rev\":\"341197357\",\"data\":{\"_key\":\"foobar\",\"_rev\":\"341197357\"}}\n{\"tick\":\"341459501\",\"type\":2302,\"key\":\"foobar\",\"rev\":\"341393965\"}\n{\"tick\":\"341656109\",\"type\":2302,\"key\":\"abcdef\",\"rev\":\"341590573\"}\n\n\n
",
"nickname": "returnsTheDataOfACollection"
}
],
@@ -425,7 +425,7 @@
"notes": "Starts the replication applier. This will return immediately if the replication applier is already running.
If the replication applier is not already running, the applier configuration will be checked, and if it is complete, the applier will be started in a background thread. This means that even if the applier will encounter any errors while running, they will not be reported in the response to this method.
To detect replication applier errors after the applier was started, use the /_api/replication/applier-state API instead.
",
"summary": "starts the replication applier",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-start\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : true, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-07-31T08:09:50Z\", \n \"message\" : \"applier created\", \n \"failedConnects\" : 0 \n }, \n \"totalFailedConnects\" : 0, \n \"totalRequests\" : 0, \n \"lastError\" : { \n }, \n \"time\" : \"2013-07-31T08:10:24Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"91240505282090\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
",
+ "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-start\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : true, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-08-01T12:54:10Z\", \n \"message\" : \"applier created\", \n \"failedConnects\" : 0 \n }, \n \"totalRequests\" : 0, \n \"totalFailedConnects\" : 0, \n \"totalEvents\" : 0, \n \"lastError\" : { \n }, \n \"time\" : \"2013-08-01T12:54:44Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"214732365112692\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
",
"nickname": "startsTheReplicationApplier"
}
],
@@ -452,7 +452,7 @@
"notes": "Stops the replication applier. This will return immediately if the replication applier is not running.
",
"summary": "stops the replication applier",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-stop\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : false, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-07-31T08:10:24Z\", \n \"message\" : \"applier stopped\", \n \"failedConnects\" : 1 \n }, \n \"totalFailedConnects\" : 2, \n \"totalRequests\" : 2, \n \"lastError\" : { \n \"time\" : \"2013-07-31T08:10:24Z\", \n \"errorNum\" : 1411, \n \"errorMessage\" : \"could not connect to master at tcp://127.0.0.1:8529: Could not connect to 'tcp:/...\" \n }, \n \"time\" : \"2013-07-31T08:10:24Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"91240505282090\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
",
+ "examples": "
unix> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-stop\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : false, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-08-01T12:54:44Z\", \n \"message\" : \"applier stopped\", \n \"failedConnects\" : 1 \n }, \n \"totalRequests\" : 2, \n \"totalFailedConnects\" : 2, \n \"totalEvents\" : 0, \n \"lastError\" : { \n \"time\" : \"2013-08-01T12:54:44Z\", \n \"errorNum\" : 1412, \n \"errorMessage\" : \"could not connect to master at tcp://127.0.0.1:8529: Could not connect to 'tcp:/...\" \n }, \n \"time\" : \"2013-08-01T12:54:44Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"214732365112692\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
",
"nickname": "stopsTheReplicationApplier"
}
],
@@ -476,10 +476,10 @@
}
],
"parameters": [],
- "notes": "Returns the state of the replication applier, regardless of whether the applier is currently running or not.
The response is a JSON hash with the following attributes:
- state: a JSON hash with the following sub-attributes:
- running: whether or not the applier is active and running
- lastAppliedContinuousTick: the last tick value from the continuous replication log the applier has applied.
- lastProcessedContinuousTick: the last tick value from the continuous replication log the applier has processed.
Regularly, the last applied and last processed tick values should be identical. For transactional operations, the replication applier will first process incoming log events before applying them, so the processed tick value might be higher than the applied tick value. This will be the case until the applier encounters the transaction commit log event for the transaction.
- lastAvailableContinuousTick: the last tick value the logger server can provide.
- time: the time on the applier server.
- totalRequests: the total number of requests the applier has made to the endpoint.
- totalFailedConnects: the total number of failed connection attempts the applier has made.
- progress: a JSON hash with details about the replication applier progress. It contains the following sub-attributes if there is progress to report:
- message: a textual description of the progress
- time: the date and time the progress was logged
- failedConnects: the current number of failed connection attempts
- lastError: a JSON hash with details about the last error that happened on the applier. It contains the following sub-attributes if there was an error:
- errorNum: a numerical error code
- errorMessage: a textual error description
- time: the date and time the error occurred
In case no error has occurred, lastError will be empty.
- server: a JSON hash with the following sub-attributes:
- version: the applier server's version
- serverId: the applier server's id
- endpoint: the endpoint the applier is connected to (if applier is active) or will connect to (if applier is currently inactive)
",
+ "notes": "Returns the state of the replication applier, regardless of whether the applier is currently running or not.
The response is a JSON hash with the following attributes:
- state: a JSON hash with the following sub-attributes:
- running: whether or not the applier is active and running
- lastAppliedContinuousTick: the last tick value from the continuous replication log the applier has applied.
- lastProcessedContinuousTick: the last tick value from the continuous replication log the applier has processed.
Regularly, the last applied and last processed tick values should be identical. For transactional operations, the replication applier will first process incoming log events before applying them, so the processed tick value might be higher than the applied tick value. This will be the case until the applier encounters the transaction commit log event for the transaction.
- lastAvailableContinuousTick: the last tick value the logger server can provide.
- time: the time on the applier server.
- totalRequests: the total number of requests the applier has made to the endpoint.
- totalFailedConnects: the total number of failed connection attempts the applier has made.
- totalEvents: the total number of log events the applier has processed.
- progress: a JSON hash with details about the replication applier progress. It contains the following sub-attributes if there is progress to report:
- message: a textual description of the progress
- time: the date and time the progress was logged
- failedConnects: the current number of failed connection attempts
- lastError: a JSON hash with details about the last error that happened on the applier. It contains the following sub-attributes if there was an error:
- errorNum: a numerical error code
- errorMessage: a textual error description
- time: the date and time the error occurred
In case no error has occurred, lastError will be empty.
- server: a JSON hash with the following sub-attributes:
- version: the applier server's version
- serverId: the applier server's id
- endpoint: the endpoint the applier is connected to (if applier is active) or will connect to (if applier is currently inactive)
",
"summary": "returns the state of the replication applier",
"httpMethod": "GET",
- "examples": "Fetching the state of an inactive applier:
unix> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : false, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-07-31T08:10:24Z\", \n \"message\" : \"applier stopped\", \n \"failedConnects\" : 1 \n }, \n \"totalFailedConnects\" : 2, \n \"totalRequests\" : 2, \n \"lastError\" : { \n \"time\" : \"2013-07-31T08:10:24Z\", \n \"errorNum\" : 1411, \n \"errorMessage\" : \"could not connect to master at tcp://127.0.0.1:8529: Could not connect to 'tcp:/...\" \n }, \n \"time\" : \"2013-07-31T08:10:24Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"91240505282090\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
Fetching the state of an active applier:
unix> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : true, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-07-31T08:10:24Z\", \n \"message\" : \"fetching master state information\", \n \"failedConnects\" : 1 \n }, \n \"totalFailedConnects\" : 3, \n \"totalRequests\" : 3, \n \"lastError\" : { \n \"time\" : \"2013-07-31T08:10:24Z\", \n \"errorNum\" : 1411, \n \"errorMessage\" : \"could not connect to master at tcp://127.0.0.1:8529: Could not connect to 'tcp:/...\" \n }, \n \"time\" : \"2013-07-31T08:10:24Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"91240505282090\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
",
+ "examples": "Fetching the state of an inactive applier:
unix> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : false, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-08-01T12:54:44Z\", \n \"message\" : \"applier stopped\", \n \"failedConnects\" : 1 \n }, \n \"totalRequests\" : 2, \n \"totalFailedConnects\" : 2, \n \"totalEvents\" : 0, \n \"lastError\" : { \n \"time\" : \"2013-08-01T12:54:44Z\", \n \"errorNum\" : 1412, \n \"errorMessage\" : \"could not connect to master at tcp://127.0.0.1:8529: Could not connect to 'tcp:/...\" \n }, \n \"time\" : \"2013-08-01T12:54:44Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"214732365112692\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
Fetching the state of an active applier:
unix> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"state\" : { \n \"running\" : true, \n \"lastAppliedContinuousTick\" : null, \n \"lastProcessedContinuousTick\" : null, \n \"lastAvailableContinuousTick\" : null, \n \"progress\" : { \n \"time\" : \"2013-08-01T12:54:44Z\", \n \"message\" : \"fetching master state information\", \n \"failedConnects\" : 1 \n }, \n \"totalRequests\" : 3, \n \"totalFailedConnects\" : 3, \n \"totalEvents\" : 0, \n \"lastError\" : { \n \"time\" : \"2013-08-01T12:54:44Z\", \n \"errorNum\" : 1412, \n \"errorMessage\" : \"could not connect to master at tcp://127.0.0.1:8529: Could not connect to 'tcp:/...\" \n }, \n \"time\" : \"2013-08-01T12:54:44Z\" \n }, \n \"server\" : { \n \"version\" : \"1.4.devel\", \n \"serverId\" : \"214732365112692\" \n }, \n \"endpoint\" : \"tcp://127.0.0.1:8529\" \n}\n\n
",
"nickname": "returnsTheStateOfTheReplicationApplier"
}
],
diff --git a/html/admin/api-docs/simple.json b/html/admin/api-docs/simple.json
index 4cdc084c51..29e9ba1a61 100644
--- a/html/admin/api-docs/simple.json
+++ b/html/admin/api-docs/simple.json
@@ -32,7 +32,7 @@
"notes": "
Returns all documents of a collections. The call expects a JSON object as body with the following attributes:
- collection: The name of the collection to query.
- skip: The number of documents to skip in the query (optional).
- limit: The maximal amount of documents to return. The skip is applied before the limit restriction. (optional)
Returns a cursor containing the result, see the manual for details.
",
"summary": "executes simple query ALL",
"httpMethod": "PUT",
- "examples": "Limit the amount of documents using limit
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/all\n{ \"collection\": \"products\", \"skip\": 2, \"limit\" : 2 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/175758166\", \n \"_rev\" : \"175758166\", \n \"_key\" : \"175758166\", \n \"Hello2\" : \"World2\" \n }, \n { \n \"_id\" : \"products/176085846\", \n \"_rev\" : \"176085846\", \n \"_key\" : \"176085846\", \n \"Hello3\" : \"World3\" \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Using a batchSize value
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/all\n{ \"collection\": \"products\", \"batchSize\" : 3 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/178903894\", \n \"_rev\" : \"178903894\", \n \"_key\" : \"178903894\", \n \"Hello4\" : \"World4\" \n }, \n { \n \"_id\" : \"products/178248534\", \n \"_rev\" : \"178248534\", \n \"_key\" : \"178248534\", \n \"Hello2\" : \"World2\" \n }, \n { \n \"_id\" : \"products/177920854\", \n \"_rev\" : \"177920854\", \n \"_key\" : \"177920854\", \n \"Hello1\" : \"World1\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"179428182\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Limit the amount of documents using limit
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/all\n{ \"collection\": \"products\", \"skip\": 2, \"limit\" : 2 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/176243245\", \n \"_rev\" : \"176243245\", \n \"_key\" : \"176243245\", \n \"Hello4\" : \"World4\" \n }, \n { \n \"_id\" : \"products/176570925\", \n \"_rev\" : \"176570925\", \n \"_key\" : \"176570925\", \n \"Hello5\" : \"World5\" \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Using a batchSize value
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/all\n{ \"collection\": \"products\", \"batchSize\" : 3 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/178405933\", \n \"_rev\" : \"178405933\", \n \"_key\" : \"178405933\", \n \"Hello3\" : \"World3\" \n }, \n { \n \"_id\" : \"products/178078253\", \n \"_rev\" : \"178078253\", \n \"_key\" : \"178078253\", \n \"Hello2\" : \"World2\" \n }, \n { \n \"_id\" : \"products/179061293\", \n \"_rev\" : \"179061293\", \n \"_key\" : \"179061293\", \n \"Hello5\" : \"World5\" \n } \n ], \n \"hasMore\" : true, \n \"id\" : \"179257901\", \n \"count\" : 5, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "executesSimpleQueryAll"
}
],
@@ -67,7 +67,7 @@
"notes": "
Returns a random document of a collection. The call expects a JSON object as body with the following attributes:
- collection: The identifier or name of the collection to query.
Returns a JSON object with the document stored in the attribute document if the collection contains at least one document. If the collection is empty, the attrbute contains null.
",
"summary": "executes simple query ANY",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/any\n{ \"collection\": \"products\" }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"document\" : { \n \"_id\" : \"products/180345686\", \n \"_rev\" : \"180345686\", \n \"_key\" : \"180345686\", \n \"Hello1\" : \"World1\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/any\n{ \"collection\": \"products\" }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"document\" : { \n \"_id\" : \"products/181551661\", \n \"_rev\" : \"181551661\", \n \"_key\" : \"181551661\", \n \"Hello5\" : \"World5\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "executesSimpleQueryAny"
}
],
@@ -102,7 +102,7 @@
"notes": "
The default will find at most 100 documents near a given coordinate. The returned list is sorted according to the distance, with the nearest document coming first. If there are near documents of equal distance, documents are chosen randomly from this set until the limit is reached.
In order to use the near operator, a geo index must be defined for the collection. This index also defines which attribute holds the coordinates for the document. If you have more then one geo-spatial index, you can use the geo field to select a particular index.
The call expects a JSON hash array as body with the following attributes:
- collection: The name of the collection to query.
- latitude: The latitude of the coordinate.
- longitude: The longitude of the coordinate.
- distance: If given, the attribute key used to store the distance. (optional)
- skip: The number of documents to skip in the query. (optional)
- limit: The maximal amount of documents to return. The skip is applied before the limit restriction. The default is 100. (optional)
- geo: If given, the identifier of the geo-index to use. (optional)
Returns a cursor containing the result, see the manual for details.
",
"summary": "executes simple query NEAR",
"httpMethod": "PUT",
- "examples": "Without distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 2 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/184212310\", \n \"_rev\" : \"184212310\", \n \"_key\" : \"184212310\", \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/183819094\", \n \"_rev\" : \"183819094\", \n \"_key\" : \"183819094\", \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
With distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 3, \"distance\" : \"distance\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/187226966\", \n \"_rev\" : \"187226966\", \n \"_key\" : \"187226966\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/187620182\", \n \"_rev\" : \"187620182\", \n \"_key\" : \"187620182\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/187030358\", \n \"_rev\" : \"187030358\", \n \"_key\" : \"187030358\", \n \"distance\" : 444.779706578235, \n \"name\" : \"Name/-0.004/\", \n \"loc\" : [ \n -0.004, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 3, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Without distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 2 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/184042029\", \n \"_rev\" : \"184042029\", \n \"_key\" : \"184042029\", \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/183648813\", \n \"_rev\" : \"183648813\", \n \"_key\" : \"183648813\", \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
With distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 3, \"distance\" : \"distance\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/187056685\", \n \"_rev\" : \"187056685\", \n \"_key\" : \"187056685\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/187449901\", \n \"_rev\" : \"187449901\", \n \"_key\" : \"187449901\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/186860077\", \n \"_rev\" : \"186860077\", \n \"_key\" : \"186860077\", \n \"distance\" : 444.779706578235, \n \"name\" : \"Name/-0.004/\", \n \"loc\" : [ \n -0.004, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 3, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "executesSimpleQueryNear"
}
],
@@ -137,7 +137,7 @@
"notes": "
This will find all documents with in a given radius around the coordinate (latitude, longitude). The returned list is sorted by distance.
In order to use the within operator, a geo index must be defined for the collection. This index also defines which attribute holds the coordinates for the document. If you have more then one geo-spatial index, you can use the geo field to select a particular index.
The call expects a JSON hash array as body with the following attributes:
- collection: The name of the collection to query.
- latitude: The latitude of the coordinate.
- longitude: The longitude of the coordinate.
- radius: The maximal radius (in meters).
- distance: If given, the result attribute key used to store the distance values (optional). If specified, distances are returned in meters.
- skip: The documents to skip in the query. (optional)
- limit: The maximal amount of documents to return. (optional)
- geo: If given, the identifier of the geo-index to use. (optional)
Returns a cursor containing the result, see the manual for details.
",
"summary": "executes simple query WITHIN",
"httpMethod": "PUT",
- "examples": "Without distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 2, \"radius\" : 500 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/191028054\", \n \"_rev\" : \"191028054\", \n \"_key\" : \"191028054\", \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/190634838\", \n \"_rev\" : \"190634838\", \n \"_key\" : \"190634838\", \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
With distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 3, \"distance\" : \"distance\", \"radius\" : 300 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/194042710\", \n \"_rev\" : \"194042710\", \n \"_key\" : \"194042710\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/194435926\", \n \"_rev\" : \"194435926\", \n \"_key\" : \"194435926\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/193846102\", \n \"_rev\" : \"193846102\", \n \"_key\" : \"193846102\", \n \"distance\" : 444.779706578235, \n \"name\" : \"Name/-0.004/\", \n \"loc\" : [ \n -0.004, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 3, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Without distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 2, \"radius\" : 500 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/190857773\", \n \"_rev\" : \"190857773\", \n \"_key\" : \"190857773\", \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/190464557\", \n \"_rev\" : \"190464557\", \n \"_key\" : \"190464557\", \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
With distance:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/near\n{ \"collection\": \"products\", \"latitude\" : 0, \"longitude\" : 0, \"skip\" : 1, \"limit\" : 3, \"distance\" : \"distance\", \"radius\" : 300 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/193872429\", \n \"_rev\" : \"193872429\", \n \"_key\" : \"193872429\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/-0.002/\", \n \"loc\" : [ \n -0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/194265645\", \n \"_rev\" : \"194265645\", \n \"_key\" : \"194265645\", \n \"distance\" : 222.38985328911744, \n \"name\" : \"Name/0.002/\", \n \"loc\" : [ \n 0.002, \n 0 \n ] \n }, \n { \n \"_id\" : \"products/193675821\", \n \"_rev\" : \"193675821\", \n \"_key\" : \"193675821\", \n \"distance\" : 444.779706578235, \n \"name\" : \"Name/-0.004/\", \n \"loc\" : [ \n -0.004, \n 0 \n ] \n } \n ], \n \"hasMore\" : false, \n \"count\" : 3, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "executesSimpleQueryWithin"
}
],
@@ -172,7 +172,7 @@
"notes": "
This will find all documents from the collection that match the fulltext query specified in query.
In order to use the fulltext operator, a fulltext index must be defined for the collection and the specified attribute.
The call expects a JSON hash array as body with the following attributes:
- collection: The name of the collection to query.
- attribute: The attribute that contains the texts.
- query: The fulltext query.
- skip: The documents to skip in the query. (optional)
- limit: The maximal amount of documents to return. (optional)
- index: If given, the identifier of the fulltext-index to use. (optional)
Returns a cursor containing the result, see the manual for details.
",
"summary": "executes simple query FULLTEXT",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/fulltext\n{ \"collection\": \"products\", \"attribute\" : \"text\", \"query\" : \"word\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/196467542\", \n \"_rev\" : \"196467542\", \n \"_key\" : \"196467542\", \n \"text\" : \"this text contains word\" \n }, \n { \n \"_id\" : \"products/196664150\", \n \"_rev\" : \"196664150\", \n \"_key\" : \"196664150\", \n \"text\" : \"this text also has a word\" \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/fulltext\n{ \"collection\": \"products\", \"attribute\" : \"text\", \"query\" : \"word\" }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/196297261\", \n \"_rev\" : \"196297261\", \n \"_key\" : \"196297261\", \n \"text\" : \"this text contains word\" \n }, \n { \n \"_id\" : \"products/196493869\", \n \"_rev\" : \"196493869\", \n \"_key\" : \"196493869\", \n \"text\" : \"this text also has a word\" \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "executesSimpleQueryFulltext"
}
],
@@ -207,7 +207,7 @@
"notes": "
This will find all documents matching a given example.
The call expects a JSON hash array as body with the following attributes:
- collection: The name of the collection to query.
- example: The example.
- skip: The documents to skip in the query. (optional)
- limit: The maximal amount of documents to return. (optional)
Returns a cursor containing the result, see the manual for details.
",
"summary": "executes simple query by-example",
"httpMethod": "PUT",
- "examples": "Matching an attribute:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/by-example\n{ \"collection\": \"products\", \"example\" : { \"i\" : 1 } }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/198826838\", \n \"_rev\" : \"198826838\", \n \"_key\" : \"198826838\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/198499158\", \n \"_rev\" : \"198499158\", \n \"_key\" : \"198499158\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/199088982\", \n \"_rev\" : \"199088982\", \n \"_key\" : \"199088982\", \n \"i\" : 1 \n }, \n { \n \"_id\" : \"products/199285590\", \n \"_rev\" : \"199285590\", \n \"_key\" : \"199285590\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 2, \n \"j\" : 2 \n } \n } \n ], \n \"hasMore\" : false, \n \"count\" : 4, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Matching an attribute which is a sub-document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/by-example\n{ \"collection\": \"products\", \"example\" : { \"a.j\" : 1 } }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/200858454\", \n \"_rev\" : \"200858454\", \n \"_key\" : \"200858454\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/201186134\", \n \"_rev\" : \"201186134\", \n \"_key\" : \"201186134\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Matching an attribute within a sub-document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/by-example\n{ \"collection\": \"products\", \"example\" : { \"a\" : { \"j\" : 1 } } }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/203545430\", \n \"_rev\" : \"203545430\", \n \"_key\" : \"203545430\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n } \n ], \n \"hasMore\" : false, \n \"count\" : 1, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "Matching an attribute:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/by-example\n{ \"collection\": \"products\", \"example\" : { \"i\" : 1 } }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/199115309\", \n \"_rev\" : \"199115309\", \n \"_key\" : \"199115309\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 2, \n \"j\" : 2 \n } \n }, \n { \n \"_id\" : \"products/198328877\", \n \"_rev\" : \"198328877\", \n \"_key\" : \"198328877\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/198656557\", \n \"_rev\" : \"198656557\", \n \"_key\" : \"198656557\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/198918701\", \n \"_rev\" : \"198918701\", \n \"_key\" : \"198918701\", \n \"i\" : 1 \n } \n ], \n \"hasMore\" : false, \n \"count\" : 4, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Matching an attribute which is a sub-document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/by-example\n{ \"collection\": \"products\", \"example\" : { \"a.j\" : 1 } }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/200688173\", \n \"_rev\" : \"200688173\", \n \"_key\" : \"200688173\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/201015853\", \n \"_rev\" : \"201015853\", \n \"_key\" : \"201015853\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
Matching an attribute within a sub-document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/by-example\n{ \"collection\": \"products\", \"example\" : { \"a\" : { \"j\" : 1 } } }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/203375149\", \n \"_rev\" : \"203375149\", \n \"_key\" : \"203375149\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n } \n ], \n \"hasMore\" : false, \n \"count\" : 1, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "executesSimpleQueryBy-example"
}
],
@@ -234,7 +234,7 @@
"notes": "
This will return the first document matching a given example.
The call expects a JSON hash array as body with the following attributes:
- collection: The name of the collection to query.
- example: The example.
Returns a result containing the document or HTTP 404 if no document matched the example.
",
"summary": "executes simple query first-example",
"httpMethod": "PUT",
- "examples": "If a matching document was found:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first-example\n{ \"collection\": \"products\", \"example\" : { \"i\" : 1 } }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"document\" : { \n \"_id\" : \"products/205904726\", \n \"_rev\" : \"205904726\", \n \"_key\" : \"205904726\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
If no document was found:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first-example\n{ \"collection\": \"products\", \"example\" : { \"l\" : 1 } }\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 404, \n \"errorNum\" : 404, \n \"errorMessage\" : \"no match\" \n}\n\n
",
+ "examples": "If a matching document was found:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first-example\n{ \"collection\": \"products\", \"example\" : { \"i\" : 1 } }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"document\" : { \n \"_id\" : \"products/206193197\", \n \"_rev\" : \"206193197\", \n \"_key\" : \"206193197\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 2, \n \"j\" : 2 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
If no document was found:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first-example\n{ \"collection\": \"products\", \"example\" : { \"l\" : 1 } }\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 404, \n \"errorNum\" : 404, \n \"errorMessage\" : \"no match\" \n}\n\n
",
"nickname": "executesSimpleQueryFirst-example"
}
],
@@ -269,7 +269,7 @@
"notes": "
This will return the first documents from the collection, in the order of insertion/update time. When the count argument is supplied, the result will be a list of documents, with the \"oldest\" document being first in the result list. If the count argument is not supplied, the result is the \"oldest\" document of the collection, or null if the collection is empty.
",
"summary": "executes simple query first",
"httpMethod": "PUT",
- "examples": "Retrieving the first n documents:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first\n{ \"collection\": \"products\", \"count\" : 2 }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/210164566\", \n \"_rev\" : \"210164566\", \n \"_key\" : \"210164566\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/210557782\", \n \"_rev\" : \"210557782\", \n \"_key\" : \"210557782\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Retrieving the first document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first\n{ \"collection\": \"products\" }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"_id\" : \"products/212327254\", \n \"_rev\" : \"212327254\", \n \"_key\" : \"212327254\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Retrieving the first n documents:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first\n{ \"collection\": \"products\", \"count\" : 2 }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/209994285\", \n \"_rev\" : \"209994285\", \n \"_key\" : \"209994285\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n { \n \"_id\" : \"products/210387501\", \n \"_rev\" : \"210387501\", \n \"_key\" : \"210387501\", \n \"i\" : 1, \n \"a\" : { \n \"j\" : 1 \n } \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Retrieving the first document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/first\n{ \"collection\": \"products\" }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"_id\" : \"products/212156973\", \n \"_rev\" : \"212156973\", \n \"_key\" : \"212156973\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 1, \n \"j\" : 1 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "executesSimpleQueryFirst"
}
],
@@ -304,7 +304,7 @@
"notes": "
This will return the last documents from the collection, in the order of insertion/update time. When the count argument is supplied, the result will be a list of documents, with the \"latest\" document being first in the result list. If the count argument is not supplied, the result is the \"latest\" document of the collection, or null if the collection is empty.
",
"summary": "executes simple query last",
"httpMethod": "PUT",
- "examples": "Retrieving the last n documents:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/last\n{ \"collection\": \"products\", \"count\" : 2 }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/215341910\", \n \"_rev\" : \"215341910\", \n \"_key\" : \"215341910\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 2, \n \"j\" : 2 \n } \n }, \n { \n \"_id\" : \"products/215145302\", \n \"_rev\" : \"215145302\", \n \"_key\" : \"215145302\", \n \"i\" : 1 \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Retrieving the first document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/last\n{ \"collection\": \"products\" }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"_id\" : \"products/217504598\", \n \"_rev\" : \"217504598\", \n \"_key\" : \"217504598\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 2, \n \"j\" : 2 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "Retrieving the last n documents:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/last\n{ \"collection\": \"products\", \"count\" : 2 }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/215171629\", \n \"_rev\" : \"215171629\", \n \"_key\" : \"215171629\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 2, \n \"j\" : 2 \n } \n }, \n { \n \"_id\" : \"products/214975021\", \n \"_rev\" : \"214975021\", \n \"_key\" : \"214975021\", \n \"i\" : 1 \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Retrieving the first document:
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/last\n{ \"collection\": \"products\" }\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"_id\" : \"products/217334317\", \n \"_rev\" : \"217334317\", \n \"_key\" : \"217334317\", \n \"i\" : 1, \n \"a\" : { \n \"k\" : 2, \n \"j\" : 2 \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "executesSimpleQueryLast"
}
],
@@ -331,7 +331,7 @@
"notes": "
This will find all documents within a given range. You must declare a skip-list index on the attribute in order to be able to use a range query.
The call expects a JSON hash array as body with the following attributes:
- collection: The name of the collection to query.
- attribute: The attribute path to check.
- left: The lower bound.
- right: The upper bound.
- closed: If true, use interval including left and right, otherwise exclude right, but include left.
- skip: The documents to skip in the query. (optional)
- limit: The maximal amount of documents to return. (optional)
Returns a cursor containing the result, see the manual for details.
",
"summary": "executes simple range query",
"httpMethod": "PUT",
- "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/range\n{ \"collection\": \"products\", \"attribute\" : \"i\", \"left\" : 2, \"right\" : 4 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/218946390\", \n \"_rev\" : \"218946390\", \n \"_key\" : \"218946390\", \n \"i\" : 2 \n }, \n { \n \"_id\" : \"products/219142998\", \n \"_rev\" : \"219142998\", \n \"_key\" : \"219142998\", \n \"i\" : 3 \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
+ "examples": "
unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/simple/range\n{ \"collection\": \"products\", \"attribute\" : \"i\", \"left\" : 2, \"right\" : 4 }\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"products/218776109\", \n \"_rev\" : \"218776109\", \n \"_key\" : \"218776109\", \n \"i\" : 2 \n }, \n { \n \"_id\" : \"products/218972717\", \n \"_rev\" : \"218972717\", \n \"_key\" : \"218972717\", \n \"i\" : 3 \n } \n ], \n \"hasMore\" : false, \n \"count\" : 2, \n \"error\" : false, \n \"code\" : 201 \n}\n\n
",
"nickname": "executesSimpleRangeQuery"
}
],
diff --git a/html/admin/api-docs/system.json b/html/admin/api-docs/system.json
index 178c682d20..0f25579bcf 100644
--- a/html/admin/api-docs/system.json
+++ b/html/admin/api-docs/system.json
@@ -92,7 +92,7 @@
"notes": "
Returns the statistics information. The returned object contains the statistics figures grouped together according to the description returned by _admin/statistics-description. For instance, to access a figure userTime from the group system, you first select the sub-object describing the group stored in system and in that sub-object the value for userTime is stored in the attribute of the same name.
In case of a distribution, the returned object contains the total count in count and the distribution list in counts. The sum (or total) of the individual values is returned in sum.
",
"summary": "reads the statistics",
"httpMethod": "GET",
- "examples": "
unix> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"system\" : { \n \"minorPageFaults\" : 334642, \n \"majorPageFaults\" : 217, \n \"userTime\" : 7.44, \n \"systemTime\" : 0.64, \n \"numberOfThreads\" : 16, \n \"residentSize\" : 37761024, \n \"virtualSize\" : 3522576384 \n }, \n \"client\" : { \n \"httpConnections\" : 1, \n \"connectionTime\" : { \n \"sum\" : 0.00021910667419433594, \n \"count\" : 1, \n \"counts\" : [ \n 1, \n 0, \n 0, \n 0 \n ] \n }, \n \"totalTime\" : { \n \"sum\" : 20.5527925491333, \n \"count\" : 753, \n \"counts\" : [ \n 312, \n 319, \n 91, \n 28, \n 3, \n 0, \n 0 \n ] \n }, \n \"requestTime\" : { \n \"sum\" : 20.43436312675476, \n \"count\" : 753, \n \"counts\" : [ \n 314, \n 318, \n 90, \n 28, \n 3, \n 0, \n 0 \n ] \n }, \n \"queueTime\" : { \n \"sum\" : 0.03156471252441406, \n \"count\" : 751, \n \"counts\" : [ \n 751, \n 0, \n 0, \n 0, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesSent\" : { \n \"sum\" : 356198, \n \"count\" : 753, \n \"counts\" : [ \n 214, \n 443, \n 79, \n 17, \n 0, \n 0 \n ] \n }, \n \"bytesReceived\" : { \n \"sum\" : 134857, \n \"count\" : 753, \n \"counts\" : [ \n 741, \n 12, \n 0, \n 0, \n 0, \n 0 \n ] \n } \n }, \n \"server\" : { \n \"uptime\" : 26.913095951080322 \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
+ "examples": "
unix> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"system\" : { \n \"minorPageFaults\" : 363901, \n \"majorPageFaults\" : 217, \n \"userTime\" : 8.24, \n \"systemTime\" : 0.8, \n \"numberOfThreads\" : 15, \n \"residentSize\" : 34541568, \n \"virtualSize\" : 3444953088 \n }, \n \"client\" : { \n \"httpConnections\" : 1, \n \"connectionTime\" : { \n \"sum\" : 0.00032901763916015625, \n \"count\" : 1, \n \"counts\" : [ \n 1, \n 0, \n 0, \n 0 \n ] \n }, \n \"totalTime\" : { \n \"sum\" : 19.763854265213013, \n \"count\" : 753, \n \"counts\" : [ \n 310, \n 325, \n 90, \n 24, \n 4, \n 0, \n 0 \n ] \n }, \n \"requestTime\" : { \n \"sum\" : 19.641836881637573, \n \"count\" : 753, \n \"counts\" : [ \n 311, \n 324, \n 90, \n 24, \n 4, \n 0, \n 0 \n ] \n }, \n \"queueTime\" : { \n \"sum\" : 0.029068946838378906, \n \"count\" : 751, \n \"counts\" : [ \n 751, \n 0, \n 0, \n 0, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesSent\" : { \n \"sum\" : 356013, \n \"count\" : 753, \n \"counts\" : [ \n 214, \n 443, \n 79, \n 17, \n 0, \n 0 \n ] \n }, \n \"bytesReceived\" : { \n \"sum\" : 134857, \n \"count\" : 753, \n \"counts\" : [ \n 741, \n 12, \n 0, \n 0, \n 0, \n 0 \n ] \n } \n }, \n \"server\" : { \n \"uptime\" : 26.189085960388184 \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
",
"nickname": "readsTheStatistics"
}
],
diff --git a/html/admin/api-docs/traversal.json b/html/admin/api-docs/traversal.json
index da7f5e1552..2d271f85af 100644
--- a/html/admin/api-docs/traversal.json
+++ b/html/admin/api-docs/traversal.json
@@ -36,7 +36,7 @@
"notes": "Starts a traversal starting from a given vertex and following. edges contained in a given edgeCollection. The request must contain the following attributes.
- startVertex: id of the startVertex, e.g. \"users/foo\".
- edgeCollection: name of the collection that contains the edges.
- filter (optional, default is to include all nodes): body (JavaScript code) of custom filter function function signature: (config, vertex, path) -> mixed can return four different string values: - \"exclude\" -> this vertex will not be visited. - \"prune\" -> the edges of this vertex will not be followed. - \"\" or undefined -> visit the vertex and follow it's edges. - Array -> containing any combination of the above. If there is at least one \"exclude\" or \"prune\" respectivly is contained, it's effect will occur. - minDepth (optional, ANDed with any existing filters): visits only nodes in at least the given depth - maxDepth (optional, ANDed with any existing filters): visits only nodes in at most the given depth - visitor (optional): body (JavaScript) code of custom visitor function function signature: (config, result, vertex, path) -> void visitor function can do anything, but its return value is ignored. To populate a result, use the result variable by reference - direction (optional): direction for traversal - *if set*, must be either \"outbound\", \"inbound\", or \"any\" - *if not set*, the expander attribute must be specified - init (optional): body (JavaScript) code of custom result initialisation function function signature: (config, result) -> void initialise any values in result with what is required - expander (optional): body (JavaScript) code of custom expander function *must* be set if direction attribute is *not* set function signature: (config, vertex, path) -> array expander must return an array of the connections for vertex each connection is an object with the attributes edge and vertex - strategy (optional): traversal strategy can be \"depthfirst\" or \"breadthfirst\" - order (optional): traversal order can be \"preorder\" or \"postorder\" - itemOrder (optional): item iteration order can be \"forward\" or \"backward\" - uniqueness (optional): specifies uniqueness for vertices and edges visited if set, must be an object like this: \"uniqueness\": {\"vertices\": \"none\"|\"global\"|path\", \"edges\": \"none\"|\"global\"|\"path\"} - maxIterations (optional): Maximum number of iterations in each traversal. This number can be set to prevent endless loops in traversal of cyclic graphs. When a traversal performs as many iterations as the maxIterations value, the traversal will abort with an error. If maxIterations is not set, a server-defined value may be used.
If the Traversal is successfully executed HTTP 200 will be returned. Additionally the result object will be returned by the traversal.
For successful traversals, the returned JSON object has the following properties:
- error: boolean flag to indicate if an error occurred (false in this case)
- code: the HTTP status code
- result: the return value of the traversal
If the traversal specification is either missing or malformed, the server will respond with HTTP 400.
The body of the response will then contain a JSON object with additional error details. The object has the following attributes:
- error: boolean flag to indicate that an error occurred (true in this case)
- code: the HTTP status code
- errorNum: the server error number
- errorMessage: a descriptive error message
",
"summary": "executes a traversal",
"httpMethod": "POST",
- "examples": "In the following examples the underlying graph will contain five persons Alice, Bob, Charlie, Dave and Eve. We will have the following directed relations: - Alice knows Bob - Bob knows Charlie - Bob knows Dave - Eve knows Alice - Eve knows Bob The starting vertex will always be Alice. Follow only outbound edges:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/235592534\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235592534\", \n \"_rev\" : \"235592534\", \n \"_key\" : \"235592534\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235789142\", \n \"_rev\" : \"235789142\", \n \"_key\" : \"235789142\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/236051286\", \n \"_rev\" : \"236051286\", \n \"_key\" : \"236051286\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/236247894\", \n \"_rev\" : \"236247894\", \n \"_key\" : \"236247894\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235592534\", \n \"_rev\" : \"235592534\", \n \"_key\" : \"235592534\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/236706646\", \n \"_rev\" : \"236706646\", \n \"_key\" : \"236706646\", \n \"_from\" : \"persons/235592534\", \n \"_to\" : \"persons/235789142\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235592534\", \n \"_rev\" : \"235592534\", \n \"_key\" : \"235592534\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235789142\", \n \"_rev\" : \"235789142\", \n \"_key\" : \"235789142\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/236706646\", \n \"_rev\" : \"236706646\", \n \"_key\" : \"236706646\", \n \"_from\" : \"persons/235592534\", \n \"_to\" : \"persons/235789142\" \n }, \n { \n \"_id\" : \"knows/236903254\", \n \"_rev\" : \"236903254\", \n \"_key\" : \"236903254\", \n \"_from\" : \"persons/235789142\", \n \"_to\" : \"persons/236051286\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235592534\", \n \"_rev\" : \"235592534\", \n \"_key\" : \"235592534\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235789142\", \n \"_rev\" : \"235789142\", \n \"_key\" : \"235789142\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/236051286\", \n \"_rev\" : \"236051286\", \n \"_key\" : \"236051286\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/236706646\", \n \"_rev\" : \"236706646\", \n \"_key\" : \"236706646\", \n \"_from\" : \"persons/235592534\", \n \"_to\" : \"persons/235789142\" \n }, \n { \n \"_id\" : \"knows/237099862\", \n \"_rev\" : \"237099862\", \n \"_key\" : \"237099862\", \n \"_from\" : \"persons/235789142\", \n \"_to\" : \"persons/236247894\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235592534\", \n \"_rev\" : \"235592534\", \n \"_key\" : \"235592534\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235789142\", \n \"_rev\" : \"235789142\", \n \"_key\" : \"235789142\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/236247894\", \n \"_rev\" : \"236247894\", \n \"_key\" : \"236247894\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Follow only inbound edges:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/240048982\", \"edgeCollection\" : \"knows\", \"direction\" : \"inbound\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/240048982\", \n \"_rev\" : \"240048982\", \n \"_key\" : \"240048982\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/240966486\", \n \"_rev\" : \"240966486\", \n \"_key\" : \"240966486\", \n \"name\" : \"Eve\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/240048982\", \n \"_rev\" : \"240048982\", \n \"_key\" : \"240048982\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/241818454\", \n \"_rev\" : \"241818454\", \n \"_key\" : \"241818454\", \n \"_from\" : \"persons/240966486\", \n \"_to\" : \"persons/240048982\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/240048982\", \n \"_rev\" : \"240048982\", \n \"_key\" : \"240048982\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/240966486\", \n \"_rev\" : \"240966486\", \n \"_key\" : \"240966486\", \n \"name\" : \"Eve\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Follow any direction of edges:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/244308822\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"uniqueness\":{\"vertices\":\"none\",\"edges\":\"global\"}}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245226326\", \n \"_rev\" : \"245226326\", \n \"_key\" : \"245226326\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244570966\", \n \"_rev\" : \"244570966\", \n \"_key\" : \"244570966\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/244833110\", \n \"_rev\" : \"244833110\", \n \"_key\" : \"244833110\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/245029718\", \n \"_rev\" : \"245029718\", \n \"_key\" : \"245029718\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/246078294\", \n \"_rev\" : \"246078294\", \n \"_key\" : \"246078294\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244308822\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245226326\", \n \"_rev\" : \"245226326\", \n \"_key\" : \"245226326\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/246078294\", \n \"_rev\" : \"246078294\", \n \"_key\" : \"246078294\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244308822\" \n }, \n { \n \"_id\" : \"knows/246274902\", \n \"_rev\" : \"246274902\", \n \"_key\" : \"246274902\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244570966\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245226326\", \n \"_rev\" : \"245226326\", \n \"_key\" : \"245226326\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244570966\", \n \"_rev\" : \"244570966\", \n \"_key\" : \"244570966\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/246078294\", \n \"_rev\" : \"246078294\", \n \"_key\" : \"246078294\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244308822\" \n }, \n { \n \"_id\" : \"knows/246274902\", \n \"_rev\" : \"246274902\", \n \"_key\" : \"246274902\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244570966\" \n }, \n { \n \"_id\" : \"knows/245488470\", \n \"_rev\" : \"245488470\", \n \"_key\" : \"245488470\", \n \"_from\" : \"persons/244308822\", \n \"_to\" : \"persons/244570966\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245226326\", \n \"_rev\" : \"245226326\", \n \"_key\" : \"245226326\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244570966\", \n \"_rev\" : \"244570966\", \n \"_key\" : \"244570966\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/246078294\", \n \"_rev\" : \"246078294\", \n \"_key\" : \"246078294\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244308822\" \n }, \n { \n \"_id\" : \"knows/246274902\", \n \"_rev\" : \"246274902\", \n \"_key\" : \"246274902\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244570966\" \n }, \n { \n \"_id\" : \"knows/245685078\", \n \"_rev\" : \"245685078\", \n \"_key\" : \"245685078\", \n \"_from\" : \"persons/244570966\", \n \"_to\" : \"persons/244833110\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245226326\", \n \"_rev\" : \"245226326\", \n \"_key\" : \"245226326\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244570966\", \n \"_rev\" : \"244570966\", \n \"_key\" : \"244570966\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/244833110\", \n \"_rev\" : \"244833110\", \n \"_key\" : \"244833110\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/246078294\", \n \"_rev\" : \"246078294\", \n \"_key\" : \"246078294\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244308822\" \n }, \n { \n \"_id\" : \"knows/246274902\", \n \"_rev\" : \"246274902\", \n \"_key\" : \"246274902\", \n \"_from\" : \"persons/245226326\", \n \"_to\" : \"persons/244570966\" \n }, \n { \n \"_id\" : \"knows/245881686\", \n \"_rev\" : \"245881686\", \n \"_key\" : \"245881686\", \n \"_from\" : \"persons/244570966\", \n \"_to\" : \"persons/245029718\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244308822\", \n \"_rev\" : \"244308822\", \n \"_key\" : \"244308822\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245226326\", \n \"_rev\" : \"245226326\", \n \"_key\" : \"245226326\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244570966\", \n \"_rev\" : \"244570966\", \n \"_key\" : \"244570966\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/245029718\", \n \"_rev\" : \"245029718\", \n \"_key\" : \"245029718\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Excluding Charlie and Bob:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/249551702\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"filter\" : \"if (vertex.name === \\\"Bob\\\" || vertex.name === \\\"Charlie\\\") {return \\\"exclude\\\";}return;\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/249551702\", \n \"_rev\" : \"249551702\", \n \"_key\" : \"249551702\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/250272598\", \n \"_rev\" : \"250272598\", \n \"_key\" : \"250272598\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/249551702\", \n \"_rev\" : \"249551702\", \n \"_key\" : \"249551702\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/250731350\", \n \"_rev\" : \"250731350\", \n \"_key\" : \"250731350\", \n \"_from\" : \"persons/249551702\", \n \"_to\" : \"persons/249813846\" \n }, \n { \n \"_id\" : \"knows/251124566\", \n \"_rev\" : \"251124566\", \n \"_key\" : \"251124566\", \n \"_from\" : \"persons/249813846\", \n \"_to\" : \"persons/250272598\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/249551702\", \n \"_rev\" : \"249551702\", \n \"_key\" : \"249551702\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/249813846\", \n \"_rev\" : \"249813846\", \n \"_key\" : \"249813846\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/250272598\", \n \"_rev\" : \"250272598\", \n \"_key\" : \"250272598\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Do not follow edges from Bob:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/254073686\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"filter\" : \"if (vertex.name === \\\"Bob\\\") {return \\\"prune\\\";}return;\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/254073686\", \n \"_rev\" : \"254073686\", \n \"_key\" : \"254073686\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/254335830\", \n \"_rev\" : \"254335830\", \n \"_key\" : \"254335830\", \n \"name\" : \"Bob\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/254073686\", \n \"_rev\" : \"254073686\", \n \"_key\" : \"254073686\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/255253334\", \n \"_rev\" : \"255253334\", \n \"_key\" : \"255253334\", \n \"_from\" : \"persons/254073686\", \n \"_to\" : \"persons/254335830\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/254073686\", \n \"_rev\" : \"254073686\", \n \"_key\" : \"254073686\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/254335830\", \n \"_rev\" : \"254335830\", \n \"_key\" : \"254335830\", \n \"name\" : \"Bob\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Visit only nodes in a depth of at least 2:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/258267990\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"minDepth\" : 2}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/258792278\", \n \"_rev\" : \"258792278\", \n \"_key\" : \"258792278\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/258988886\", \n \"_rev\" : \"258988886\", \n \"_key\" : \"258988886\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/259447638\", \n \"_rev\" : \"259447638\", \n \"_key\" : \"259447638\", \n \"_from\" : \"persons/258267990\", \n \"_to\" : \"persons/258530134\" \n }, \n { \n \"_id\" : \"knows/259644246\", \n \"_rev\" : \"259644246\", \n \"_key\" : \"259644246\", \n \"_from\" : \"persons/258530134\", \n \"_to\" : \"persons/258792278\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/258267990\", \n \"_rev\" : \"258267990\", \n \"_key\" : \"258267990\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/258530134\", \n \"_rev\" : \"258530134\", \n \"_key\" : \"258530134\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/258792278\", \n \"_rev\" : \"258792278\", \n \"_key\" : \"258792278\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/259447638\", \n \"_rev\" : \"259447638\", \n \"_key\" : \"259447638\", \n \"_from\" : \"persons/258267990\", \n \"_to\" : \"persons/258530134\" \n }, \n { \n \"_id\" : \"knows/259840854\", \n \"_rev\" : \"259840854\", \n \"_key\" : \"259840854\", \n \"_from\" : \"persons/258530134\", \n \"_to\" : \"persons/258988886\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/258267990\", \n \"_rev\" : \"258267990\", \n \"_key\" : \"258267990\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/258530134\", \n \"_rev\" : \"258530134\", \n \"_key\" : \"258530134\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/258988886\", \n \"_rev\" : \"258988886\", \n \"_key\" : \"258988886\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Visit only nodes in a depth of at most 1:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/262789974\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"maxDepth\" : 1}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/262789974\", \n \"_rev\" : \"262789974\", \n \"_key\" : \"262789974\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/263052118\", \n \"_rev\" : \"263052118\", \n \"_key\" : \"263052118\", \n \"name\" : \"Bob\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/262789974\", \n \"_rev\" : \"262789974\", \n \"_key\" : \"262789974\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/263969622\", \n \"_rev\" : \"263969622\", \n \"_key\" : \"263969622\", \n \"_from\" : \"persons/262789974\", \n \"_to\" : \"persons/263052118\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/262789974\", \n \"_rev\" : \"262789974\", \n \"_key\" : \"262789974\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/263052118\", \n \"_rev\" : \"263052118\", \n \"_key\" : \"263052118\", \n \"name\" : \"Bob\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Count all visited nodes and return a list of nodes only:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/266984278\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"init\" : \"result.visited = 0; result.myVertices = [ ];\", \"visitor\" : \"result.visited++; result.myVertices.push(vertex);\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : 4, \n \"myVertices\" : [ \n { \n \"_id\" : \"persons/266984278\", \n \"_rev\" : \"266984278\", \n \"_key\" : \"266984278\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/267246422\", \n \"_rev\" : \"267246422\", \n \"_key\" : \"267246422\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/267508566\", \n \"_rev\" : \"267508566\", \n \"_key\" : \"267508566\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/267705174\", \n \"_rev\" : \"267705174\", \n \"_key\" : \"267705174\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Expand only inbound edges of Alice and outbound edges of Eve:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/271178582\",\"edgeCollection\":\"knows\",\"expander\":\"var connections = [ ];if (vertex.name === \\\"Alice\\\") {config.edgeCollection.inEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\\\"internal\\\").db._document(e._from), edge: e});});}if (vertex.name === \\\"Eve\\\") {config.edgeCollection.outEdges(vertex).forEach(function (e) {connections.push({vertex: require(\\\"internal\\\").db._document(e._to), edge: e});});}return connections;\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271178582\", \n \"_rev\" : \"271178582\", \n \"_key\" : \"271178582\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/272161622\", \n \"_rev\" : \"272161622\", \n \"_key\" : \"272161622\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/271506262\", \n \"_rev\" : \"271506262\", \n \"_key\" : \"271506262\", \n \"name\" : \"Bob\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271178582\", \n \"_rev\" : \"271178582\", \n \"_key\" : \"271178582\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/273013590\", \n \"_rev\" : \"273013590\", \n \"_key\" : \"273013590\", \n \"_from\" : \"persons/272161622\", \n \"_to\" : \"persons/271178582\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271178582\", \n \"_rev\" : \"271178582\", \n \"_key\" : \"271178582\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/272161622\", \n \"_rev\" : \"272161622\", \n \"_key\" : \"272161622\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/273013590\", \n \"_rev\" : \"273013590\", \n \"_key\" : \"273013590\", \n \"_from\" : \"persons/272161622\", \n \"_to\" : \"persons/271178582\" \n }, \n { \n \"_id\" : \"knows/273210198\", \n \"_rev\" : \"273210198\", \n \"_key\" : \"273210198\", \n \"_from\" : \"persons/272161622\", \n \"_to\" : \"persons/271506262\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271178582\", \n \"_rev\" : \"271178582\", \n \"_key\" : \"271178582\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/272161622\", \n \"_rev\" : \"272161622\", \n \"_key\" : \"272161622\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/271506262\", \n \"_rev\" : \"271506262\", \n \"_key\" : \"271506262\", \n \"name\" : \"Bob\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Follow the depthfirst strategy:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/275635030\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"strategy\":\"depthfirst\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276159318\", \n \"_rev\" : \"276159318\", \n \"_key\" : \"276159318\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/276355926\", \n \"_rev\" : \"276355926\", \n \"_key\" : \"276355926\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276159318\", \n \"_rev\" : \"276159318\", \n \"_key\" : \"276159318\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/276355926\", \n \"_rev\" : \"276355926\", \n \"_key\" : \"276355926\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277404502\", \n \"_rev\" : \"277404502\", \n \"_key\" : \"277404502\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275635030\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277404502\", \n \"_rev\" : \"277404502\", \n \"_key\" : \"277404502\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275635030\" \n }, \n { \n \"_id\" : \"knows/277601110\", \n \"_rev\" : \"277601110\", \n \"_key\" : \"277601110\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275897174\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277404502\", \n \"_rev\" : \"277404502\", \n \"_key\" : \"277404502\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275635030\" \n }, \n { \n \"_id\" : \"knows/277601110\", \n \"_rev\" : \"277601110\", \n \"_key\" : \"277601110\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/276814678\", \n \"_rev\" : \"276814678\", \n \"_key\" : \"276814678\", \n \"_from\" : \"persons/275635030\", \n \"_to\" : \"persons/275897174\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277404502\", \n \"_rev\" : \"277404502\", \n \"_key\" : \"277404502\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275635030\" \n }, \n { \n \"_id\" : \"knows/277601110\", \n \"_rev\" : \"277601110\", \n \"_key\" : \"277601110\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/277011286\", \n \"_rev\" : \"277011286\", \n \"_key\" : \"277011286\", \n \"_from\" : \"persons/275897174\", \n \"_to\" : \"persons/276159318\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276159318\", \n \"_rev\" : \"276159318\", \n \"_key\" : \"276159318\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277404502\", \n \"_rev\" : \"277404502\", \n \"_key\" : \"277404502\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275635030\" \n }, \n { \n \"_id\" : \"knows/277601110\", \n \"_rev\" : \"277601110\", \n \"_key\" : \"277601110\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/277207894\", \n \"_rev\" : \"277207894\", \n \"_key\" : \"277207894\", \n \"_from\" : \"persons/275897174\", \n \"_to\" : \"persons/276355926\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276355926\", \n \"_rev\" : \"276355926\", \n \"_key\" : \"276355926\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276814678\", \n \"_rev\" : \"276814678\", \n \"_key\" : \"276814678\", \n \"_from\" : \"persons/275635030\", \n \"_to\" : \"persons/275897174\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276814678\", \n \"_rev\" : \"276814678\", \n \"_key\" : \"276814678\", \n \"_from\" : \"persons/275635030\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/277601110\", \n \"_rev\" : \"277601110\", \n \"_key\" : \"277601110\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275897174\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276814678\", \n \"_rev\" : \"276814678\", \n \"_key\" : \"276814678\", \n \"_from\" : \"persons/275635030\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/277601110\", \n \"_rev\" : \"277601110\", \n \"_key\" : \"277601110\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/277404502\", \n \"_rev\" : \"277404502\", \n \"_key\" : \"277404502\", \n \"_from\" : \"persons/276552534\", \n \"_to\" : \"persons/275635030\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276552534\", \n \"_rev\" : \"276552534\", \n \"_key\" : \"276552534\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276814678\", \n \"_rev\" : \"276814678\", \n \"_key\" : \"276814678\", \n \"_from\" : \"persons/275635030\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/277011286\", \n \"_rev\" : \"277011286\", \n \"_key\" : \"277011286\", \n \"_from\" : \"persons/275897174\", \n \"_to\" : \"persons/276159318\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276159318\", \n \"_rev\" : \"276159318\", \n \"_key\" : \"276159318\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276814678\", \n \"_rev\" : \"276814678\", \n \"_key\" : \"276814678\", \n \"_from\" : \"persons/275635030\", \n \"_to\" : \"persons/275897174\" \n }, \n { \n \"_id\" : \"knows/277207894\", \n \"_rev\" : \"277207894\", \n \"_key\" : \"277207894\", \n \"_from\" : \"persons/275897174\", \n \"_to\" : \"persons/276355926\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275635030\", \n \"_rev\" : \"275635030\", \n \"_key\" : \"275635030\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275897174\", \n \"_rev\" : \"275897174\", \n \"_key\" : \"275897174\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276355926\", \n \"_rev\" : \"276355926\", \n \"_key\" : \"276355926\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using postorder ordering:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/281860950\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"order\":\"postorder\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282385238\", \n \"_rev\" : \"282385238\", \n \"_key\" : \"282385238\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/282581846\", \n \"_rev\" : \"282581846\", \n \"_key\" : \"282581846\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/282385238\", \n \"_rev\" : \"282385238\", \n \"_key\" : \"282385238\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/282581846\", \n \"_rev\" : \"282581846\", \n \"_key\" : \"282581846\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283630422\", \n \"_rev\" : \"283630422\", \n \"_key\" : \"283630422\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/281860950\" \n }, \n { \n \"_id\" : \"knows/283827030\", \n \"_rev\" : \"283827030\", \n \"_key\" : \"283827030\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283040598\", \n \"_rev\" : \"283040598\", \n \"_key\" : \"283040598\", \n \"_from\" : \"persons/281860950\", \n \"_to\" : \"persons/282123094\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283630422\", \n \"_rev\" : \"283630422\", \n \"_key\" : \"283630422\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/281860950\" \n }, \n { \n \"_id\" : \"knows/283827030\", \n \"_rev\" : \"283827030\", \n \"_key\" : \"283827030\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283237206\", \n \"_rev\" : \"283237206\", \n \"_key\" : \"283237206\", \n \"_from\" : \"persons/282123094\", \n \"_to\" : \"persons/282385238\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282385238\", \n \"_rev\" : \"282385238\", \n \"_key\" : \"282385238\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283630422\", \n \"_rev\" : \"283630422\", \n \"_key\" : \"283630422\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/281860950\" \n }, \n { \n \"_id\" : \"knows/283827030\", \n \"_rev\" : \"283827030\", \n \"_key\" : \"283827030\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283433814\", \n \"_rev\" : \"283433814\", \n \"_key\" : \"283433814\", \n \"_from\" : \"persons/282123094\", \n \"_to\" : \"persons/282581846\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282581846\", \n \"_rev\" : \"282581846\", \n \"_key\" : \"282581846\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283630422\", \n \"_rev\" : \"283630422\", \n \"_key\" : \"283630422\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/281860950\" \n }, \n { \n \"_id\" : \"knows/283827030\", \n \"_rev\" : \"283827030\", \n \"_key\" : \"283827030\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/282123094\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283630422\", \n \"_rev\" : \"283630422\", \n \"_key\" : \"283630422\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/281860950\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283040598\", \n \"_rev\" : \"283040598\", \n \"_key\" : \"283040598\", \n \"_from\" : \"persons/281860950\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283827030\", \n \"_rev\" : \"283827030\", \n \"_key\" : \"283827030\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283630422\", \n \"_rev\" : \"283630422\", \n \"_key\" : \"283630422\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/281860950\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283040598\", \n \"_rev\" : \"283040598\", \n \"_key\" : \"283040598\", \n \"_from\" : \"persons/281860950\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283827030\", \n \"_rev\" : \"283827030\", \n \"_key\" : \"283827030\", \n \"_from\" : \"persons/282778454\", \n \"_to\" : \"persons/282123094\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282778454\", \n \"_rev\" : \"282778454\", \n \"_key\" : \"282778454\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283040598\", \n \"_rev\" : \"283040598\", \n \"_key\" : \"283040598\", \n \"_from\" : \"persons/281860950\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283237206\", \n \"_rev\" : \"283237206\", \n \"_key\" : \"283237206\", \n \"_from\" : \"persons/282123094\", \n \"_to\" : \"persons/282385238\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282385238\", \n \"_rev\" : \"282385238\", \n \"_key\" : \"282385238\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283040598\", \n \"_rev\" : \"283040598\", \n \"_key\" : \"283040598\", \n \"_from\" : \"persons/281860950\", \n \"_to\" : \"persons/282123094\" \n }, \n { \n \"_id\" : \"knows/283433814\", \n \"_rev\" : \"283433814\", \n \"_key\" : \"283433814\", \n \"_from\" : \"persons/282123094\", \n \"_to\" : \"persons/282581846\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282581846\", \n \"_rev\" : \"282581846\", \n \"_key\" : \"282581846\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283040598\", \n \"_rev\" : \"283040598\", \n \"_key\" : \"283040598\", \n \"_from\" : \"persons/281860950\", \n \"_to\" : \"persons/282123094\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282123094\", \n \"_rev\" : \"282123094\", \n \"_key\" : \"282123094\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281860950\", \n \"_rev\" : \"281860950\", \n \"_key\" : \"281860950\", \n \"name\" : \"Alice\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using backward item-ordering:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/288086870\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"itemOrder\":\"backward\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288807766\", \n \"_rev\" : \"288807766\", \n \"_key\" : \"288807766\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/288611158\", \n \"_rev\" : \"288611158\", \n \"_key\" : \"288611158\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288807766\", \n \"_rev\" : \"288807766\", \n \"_key\" : \"288807766\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/288611158\", \n \"_rev\" : \"288611158\", \n \"_key\" : \"288611158\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289266518\", \n \"_rev\" : \"289266518\", \n \"_key\" : \"289266518\", \n \"_from\" : \"persons/288086870\", \n \"_to\" : \"persons/288349014\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289266518\", \n \"_rev\" : \"289266518\", \n \"_key\" : \"289266518\", \n \"_from\" : \"persons/288086870\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/289659734\", \n \"_rev\" : \"289659734\", \n \"_key\" : \"289659734\", \n \"_from\" : \"persons/288349014\", \n \"_to\" : \"persons/288807766\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288807766\", \n \"_rev\" : \"288807766\", \n \"_key\" : \"288807766\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289266518\", \n \"_rev\" : \"289266518\", \n \"_key\" : \"289266518\", \n \"_from\" : \"persons/288086870\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/289463126\", \n \"_rev\" : \"289463126\", \n \"_key\" : \"289463126\", \n \"_from\" : \"persons/288349014\", \n \"_to\" : \"persons/288611158\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288611158\", \n \"_rev\" : \"288611158\", \n \"_key\" : \"288611158\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289266518\", \n \"_rev\" : \"289266518\", \n \"_key\" : \"289266518\", \n \"_from\" : \"persons/288086870\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/290052950\", \n \"_rev\" : \"290052950\", \n \"_key\" : \"290052950\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288349014\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289266518\", \n \"_rev\" : \"289266518\", \n \"_key\" : \"289266518\", \n \"_from\" : \"persons/288086870\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/290052950\", \n \"_rev\" : \"290052950\", \n \"_key\" : \"290052950\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/289856342\", \n \"_rev\" : \"289856342\", \n \"_key\" : \"289856342\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288086870\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289856342\", \n \"_rev\" : \"289856342\", \n \"_key\" : \"289856342\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288086870\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289856342\", \n \"_rev\" : \"289856342\", \n \"_key\" : \"289856342\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288086870\" \n }, \n { \n \"_id\" : \"knows/290052950\", \n \"_rev\" : \"290052950\", \n \"_key\" : \"290052950\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288349014\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289856342\", \n \"_rev\" : \"289856342\", \n \"_key\" : \"289856342\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288086870\" \n }, \n { \n \"_id\" : \"knows/290052950\", \n \"_rev\" : \"290052950\", \n \"_key\" : \"290052950\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/289659734\", \n \"_rev\" : \"289659734\", \n \"_key\" : \"289659734\", \n \"_from\" : \"persons/288349014\", \n \"_to\" : \"persons/288807766\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288807766\", \n \"_rev\" : \"288807766\", \n \"_key\" : \"288807766\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289856342\", \n \"_rev\" : \"289856342\", \n \"_key\" : \"289856342\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288086870\" \n }, \n { \n \"_id\" : \"knows/290052950\", \n \"_rev\" : \"290052950\", \n \"_key\" : \"290052950\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/289463126\", \n \"_rev\" : \"289463126\", \n \"_key\" : \"289463126\", \n \"_from\" : \"persons/288349014\", \n \"_to\" : \"persons/288611158\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288611158\", \n \"_rev\" : \"288611158\", \n \"_key\" : \"288611158\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289856342\", \n \"_rev\" : \"289856342\", \n \"_key\" : \"289856342\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288086870\" \n }, \n { \n \"_id\" : \"knows/290052950\", \n \"_rev\" : \"290052950\", \n \"_key\" : \"290052950\", \n \"_from\" : \"persons/289004374\", \n \"_to\" : \"persons/288349014\" \n }, \n { \n \"_id\" : \"knows/289266518\", \n \"_rev\" : \"289266518\", \n \"_key\" : \"289266518\", \n \"_from\" : \"persons/288086870\", \n \"_to\" : \"persons/288349014\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/289004374\", \n \"_rev\" : \"289004374\", \n \"_key\" : \"289004374\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288349014\", \n \"_rev\" : \"288349014\", \n \"_key\" : \"288349014\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288086870\", \n \"_rev\" : \"288086870\", \n \"_key\" : \"288086870\", \n \"name\" : \"Alice\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Edges should only be included once globally, but nodes are included every time they are visited:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/294312790\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"uniqueness\":{\"vertices\":\"none\",\"edges\":\"global\"}}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295230294\", \n \"_rev\" : \"295230294\", \n \"_key\" : \"295230294\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294574934\", \n \"_rev\" : \"294574934\", \n \"_key\" : \"294574934\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/294837078\", \n \"_rev\" : \"294837078\", \n \"_key\" : \"294837078\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/295033686\", \n \"_rev\" : \"295033686\", \n \"_key\" : \"295033686\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/296082262\", \n \"_rev\" : \"296082262\", \n \"_key\" : \"296082262\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294312790\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295230294\", \n \"_rev\" : \"295230294\", \n \"_key\" : \"295230294\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/296082262\", \n \"_rev\" : \"296082262\", \n \"_key\" : \"296082262\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294312790\" \n }, \n { \n \"_id\" : \"knows/296278870\", \n \"_rev\" : \"296278870\", \n \"_key\" : \"296278870\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294574934\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295230294\", \n \"_rev\" : \"295230294\", \n \"_key\" : \"295230294\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294574934\", \n \"_rev\" : \"294574934\", \n \"_key\" : \"294574934\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/296082262\", \n \"_rev\" : \"296082262\", \n \"_key\" : \"296082262\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294312790\" \n }, \n { \n \"_id\" : \"knows/296278870\", \n \"_rev\" : \"296278870\", \n \"_key\" : \"296278870\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294574934\" \n }, \n { \n \"_id\" : \"knows/295492438\", \n \"_rev\" : \"295492438\", \n \"_key\" : \"295492438\", \n \"_from\" : \"persons/294312790\", \n \"_to\" : \"persons/294574934\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295230294\", \n \"_rev\" : \"295230294\", \n \"_key\" : \"295230294\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294574934\", \n \"_rev\" : \"294574934\", \n \"_key\" : \"294574934\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/296082262\", \n \"_rev\" : \"296082262\", \n \"_key\" : \"296082262\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294312790\" \n }, \n { \n \"_id\" : \"knows/296278870\", \n \"_rev\" : \"296278870\", \n \"_key\" : \"296278870\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294574934\" \n }, \n { \n \"_id\" : \"knows/295689046\", \n \"_rev\" : \"295689046\", \n \"_key\" : \"295689046\", \n \"_from\" : \"persons/294574934\", \n \"_to\" : \"persons/294837078\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295230294\", \n \"_rev\" : \"295230294\", \n \"_key\" : \"295230294\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294574934\", \n \"_rev\" : \"294574934\", \n \"_key\" : \"294574934\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/294837078\", \n \"_rev\" : \"294837078\", \n \"_key\" : \"294837078\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/296082262\", \n \"_rev\" : \"296082262\", \n \"_key\" : \"296082262\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294312790\" \n }, \n { \n \"_id\" : \"knows/296278870\", \n \"_rev\" : \"296278870\", \n \"_key\" : \"296278870\", \n \"_from\" : \"persons/295230294\", \n \"_to\" : \"persons/294574934\" \n }, \n { \n \"_id\" : \"knows/295885654\", \n \"_rev\" : \"295885654\", \n \"_key\" : \"295885654\", \n \"_from\" : \"persons/294574934\", \n \"_to\" : \"persons/295033686\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294312790\", \n \"_rev\" : \"294312790\", \n \"_key\" : \"294312790\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295230294\", \n \"_rev\" : \"295230294\", \n \"_key\" : \"295230294\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294574934\", \n \"_rev\" : \"294574934\", \n \"_key\" : \"294574934\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/295033686\", \n \"_rev\" : \"295033686\", \n \"_key\" : \"295033686\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
If the underlying graph is cyclic, maxIterations should be set: The underlying graph has two vertices Alice and Bob. With the directed edges: - Alice knows Bob _ Bob knows Alice
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/299555670\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"uniqueness\":{\"vertices\":\"none\",\"edges\":\"none\"},\"maxIterations\":5}\n\nHTTP/1.1 500 Internal Error\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 500, \n \"errorNum\" : 1909, \n \"errorMessage\" : \"too many iterations\" \n}\n\n
",
+ "examples": "In the following examples the underlying graph will contain five persons Alice, Bob, Charlie, Dave and Eve. We will have the following directed relations: - Alice knows Bob - Bob knows Charlie - Bob knows Dave - Eve knows Alice - Eve knows Bob The starting vertex will always be Alice. Follow only outbound edges:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/235422253\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235422253\", \n \"_rev\" : \"235422253\", \n \"_key\" : \"235422253\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235618861\", \n \"_rev\" : \"235618861\", \n \"_key\" : \"235618861\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/235881005\", \n \"_rev\" : \"235881005\", \n \"_key\" : \"235881005\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/236077613\", \n \"_rev\" : \"236077613\", \n \"_key\" : \"236077613\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235422253\", \n \"_rev\" : \"235422253\", \n \"_key\" : \"235422253\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/236536365\", \n \"_rev\" : \"236536365\", \n \"_key\" : \"236536365\", \n \"_from\" : \"persons/235422253\", \n \"_to\" : \"persons/235618861\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235422253\", \n \"_rev\" : \"235422253\", \n \"_key\" : \"235422253\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235618861\", \n \"_rev\" : \"235618861\", \n \"_key\" : \"235618861\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/236536365\", \n \"_rev\" : \"236536365\", \n \"_key\" : \"236536365\", \n \"_from\" : \"persons/235422253\", \n \"_to\" : \"persons/235618861\" \n }, \n { \n \"_id\" : \"knows/236732973\", \n \"_rev\" : \"236732973\", \n \"_key\" : \"236732973\", \n \"_from\" : \"persons/235618861\", \n \"_to\" : \"persons/235881005\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235422253\", \n \"_rev\" : \"235422253\", \n \"_key\" : \"235422253\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235618861\", \n \"_rev\" : \"235618861\", \n \"_key\" : \"235618861\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/235881005\", \n \"_rev\" : \"235881005\", \n \"_key\" : \"235881005\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/236536365\", \n \"_rev\" : \"236536365\", \n \"_key\" : \"236536365\", \n \"_from\" : \"persons/235422253\", \n \"_to\" : \"persons/235618861\" \n }, \n { \n \"_id\" : \"knows/236929581\", \n \"_rev\" : \"236929581\", \n \"_key\" : \"236929581\", \n \"_from\" : \"persons/235618861\", \n \"_to\" : \"persons/236077613\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/235422253\", \n \"_rev\" : \"235422253\", \n \"_key\" : \"235422253\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/235618861\", \n \"_rev\" : \"235618861\", \n \"_key\" : \"235618861\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/236077613\", \n \"_rev\" : \"236077613\", \n \"_key\" : \"236077613\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Follow only inbound edges:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/239944237\", \"edgeCollection\" : \"knows\", \"direction\" : \"inbound\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/239944237\", \n \"_rev\" : \"239944237\", \n \"_key\" : \"239944237\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/240796205\", \n \"_rev\" : \"240796205\", \n \"_key\" : \"240796205\", \n \"name\" : \"Eve\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/239944237\", \n \"_rev\" : \"239944237\", \n \"_key\" : \"239944237\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/241648173\", \n \"_rev\" : \"241648173\", \n \"_key\" : \"241648173\", \n \"_from\" : \"persons/240796205\", \n \"_to\" : \"persons/239944237\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/239944237\", \n \"_rev\" : \"239944237\", \n \"_key\" : \"239944237\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/240796205\", \n \"_rev\" : \"240796205\", \n \"_key\" : \"240796205\", \n \"name\" : \"Eve\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Follow any direction of edges:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/244138541\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"uniqueness\":{\"vertices\":\"none\",\"edges\":\"global\"}}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245056045\", \n \"_rev\" : \"245056045\", \n \"_key\" : \"245056045\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244400685\", \n \"_rev\" : \"244400685\", \n \"_key\" : \"244400685\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/244662829\", \n \"_rev\" : \"244662829\", \n \"_key\" : \"244662829\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/244859437\", \n \"_rev\" : \"244859437\", \n \"_key\" : \"244859437\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/245908013\", \n \"_rev\" : \"245908013\", \n \"_key\" : \"245908013\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244138541\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245056045\", \n \"_rev\" : \"245056045\", \n \"_key\" : \"245056045\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/245908013\", \n \"_rev\" : \"245908013\", \n \"_key\" : \"245908013\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244138541\" \n }, \n { \n \"_id\" : \"knows/246104621\", \n \"_rev\" : \"246104621\", \n \"_key\" : \"246104621\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244400685\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245056045\", \n \"_rev\" : \"245056045\", \n \"_key\" : \"245056045\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244400685\", \n \"_rev\" : \"244400685\", \n \"_key\" : \"244400685\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/245908013\", \n \"_rev\" : \"245908013\", \n \"_key\" : \"245908013\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244138541\" \n }, \n { \n \"_id\" : \"knows/246104621\", \n \"_rev\" : \"246104621\", \n \"_key\" : \"246104621\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244400685\" \n }, \n { \n \"_id\" : \"knows/245318189\", \n \"_rev\" : \"245318189\", \n \"_key\" : \"245318189\", \n \"_from\" : \"persons/244138541\", \n \"_to\" : \"persons/244400685\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245056045\", \n \"_rev\" : \"245056045\", \n \"_key\" : \"245056045\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244400685\", \n \"_rev\" : \"244400685\", \n \"_key\" : \"244400685\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/245908013\", \n \"_rev\" : \"245908013\", \n \"_key\" : \"245908013\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244138541\" \n }, \n { \n \"_id\" : \"knows/246104621\", \n \"_rev\" : \"246104621\", \n \"_key\" : \"246104621\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244400685\" \n }, \n { \n \"_id\" : \"knows/245514797\", \n \"_rev\" : \"245514797\", \n \"_key\" : \"245514797\", \n \"_from\" : \"persons/244400685\", \n \"_to\" : \"persons/244662829\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245056045\", \n \"_rev\" : \"245056045\", \n \"_key\" : \"245056045\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244400685\", \n \"_rev\" : \"244400685\", \n \"_key\" : \"244400685\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/244662829\", \n \"_rev\" : \"244662829\", \n \"_key\" : \"244662829\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/245908013\", \n \"_rev\" : \"245908013\", \n \"_key\" : \"245908013\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244138541\" \n }, \n { \n \"_id\" : \"knows/246104621\", \n \"_rev\" : \"246104621\", \n \"_key\" : \"246104621\", \n \"_from\" : \"persons/245056045\", \n \"_to\" : \"persons/244400685\" \n }, \n { \n \"_id\" : \"knows/245711405\", \n \"_rev\" : \"245711405\", \n \"_key\" : \"245711405\", \n \"_from\" : \"persons/244400685\", \n \"_to\" : \"persons/244859437\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/244138541\", \n \"_rev\" : \"244138541\", \n \"_key\" : \"244138541\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/245056045\", \n \"_rev\" : \"245056045\", \n \"_key\" : \"245056045\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/244400685\", \n \"_rev\" : \"244400685\", \n \"_key\" : \"244400685\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/244859437\", \n \"_rev\" : \"244859437\", \n \"_key\" : \"244859437\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Excluding Charlie and Bob:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/249315885\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"filter\" : \"if (vertex.name === \\\"Bob\\\" || vertex.name === \\\"Charlie\\\") {return \\\"exclude\\\";}return;\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/249315885\", \n \"_rev\" : \"249315885\", \n \"_key\" : \"249315885\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/250102317\", \n \"_rev\" : \"250102317\", \n \"_key\" : \"250102317\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/249315885\", \n \"_rev\" : \"249315885\", \n \"_key\" : \"249315885\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/250561069\", \n \"_rev\" : \"250561069\", \n \"_key\" : \"250561069\", \n \"_from\" : \"persons/249315885\", \n \"_to\" : \"persons/249643565\" \n }, \n { \n \"_id\" : \"knows/250954285\", \n \"_rev\" : \"250954285\", \n \"_key\" : \"250954285\", \n \"_from\" : \"persons/249643565\", \n \"_to\" : \"persons/250102317\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/249315885\", \n \"_rev\" : \"249315885\", \n \"_key\" : \"249315885\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/249643565\", \n \"_rev\" : \"249643565\", \n \"_key\" : \"249643565\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/250102317\", \n \"_rev\" : \"250102317\", \n \"_key\" : \"250102317\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Do not follow edges from Bob:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/253903405\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"filter\" : \"if (vertex.name === \\\"Bob\\\") {return \\\"prune\\\";}return;\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/253903405\", \n \"_rev\" : \"253903405\", \n \"_key\" : \"253903405\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/254165549\", \n \"_rev\" : \"254165549\", \n \"_key\" : \"254165549\", \n \"name\" : \"Bob\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/253903405\", \n \"_rev\" : \"253903405\", \n \"_key\" : \"253903405\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/255083053\", \n \"_rev\" : \"255083053\", \n \"_key\" : \"255083053\", \n \"_from\" : \"persons/253903405\", \n \"_to\" : \"persons/254165549\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/253903405\", \n \"_rev\" : \"253903405\", \n \"_key\" : \"253903405\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/254165549\", \n \"_rev\" : \"254165549\", \n \"_key\" : \"254165549\", \n \"name\" : \"Bob\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Visit only nodes in a depth of at least 2:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/258097709\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"minDepth\" : 2}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/258621997\", \n \"_rev\" : \"258621997\", \n \"_key\" : \"258621997\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/258818605\", \n \"_rev\" : \"258818605\", \n \"_key\" : \"258818605\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/259277357\", \n \"_rev\" : \"259277357\", \n \"_key\" : \"259277357\", \n \"_from\" : \"persons/258097709\", \n \"_to\" : \"persons/258359853\" \n }, \n { \n \"_id\" : \"knows/259473965\", \n \"_rev\" : \"259473965\", \n \"_key\" : \"259473965\", \n \"_from\" : \"persons/258359853\", \n \"_to\" : \"persons/258621997\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/258097709\", \n \"_rev\" : \"258097709\", \n \"_key\" : \"258097709\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/258359853\", \n \"_rev\" : \"258359853\", \n \"_key\" : \"258359853\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/258621997\", \n \"_rev\" : \"258621997\", \n \"_key\" : \"258621997\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/259277357\", \n \"_rev\" : \"259277357\", \n \"_key\" : \"259277357\", \n \"_from\" : \"persons/258097709\", \n \"_to\" : \"persons/258359853\" \n }, \n { \n \"_id\" : \"knows/259670573\", \n \"_rev\" : \"259670573\", \n \"_key\" : \"259670573\", \n \"_from\" : \"persons/258359853\", \n \"_to\" : \"persons/258818605\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/258097709\", \n \"_rev\" : \"258097709\", \n \"_key\" : \"258097709\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/258359853\", \n \"_rev\" : \"258359853\", \n \"_key\" : \"258359853\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/258818605\", \n \"_rev\" : \"258818605\", \n \"_key\" : \"258818605\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Visit only nodes in a depth of at most 1:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/262619693\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"maxDepth\" : 1}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/262619693\", \n \"_rev\" : \"262619693\", \n \"_key\" : \"262619693\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/262881837\", \n \"_rev\" : \"262881837\", \n \"_key\" : \"262881837\", \n \"name\" : \"Bob\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/262619693\", \n \"_rev\" : \"262619693\", \n \"_key\" : \"262619693\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/263799341\", \n \"_rev\" : \"263799341\", \n \"_key\" : \"263799341\", \n \"_from\" : \"persons/262619693\", \n \"_to\" : \"persons/262881837\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/262619693\", \n \"_rev\" : \"262619693\", \n \"_key\" : \"262619693\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/262881837\", \n \"_rev\" : \"262881837\", \n \"_key\" : \"262881837\", \n \"name\" : \"Bob\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Count all visited nodes and return a list of nodes only:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{ \"startVertex\": \"persons/266813997\", \"edgeCollection\" : \"knows\", \"direction\" : \"outbound\", \"init\" : \"result.visited = 0; result.myVertices = [ ];\", \"visitor\" : \"result.visited++; result.myVertices.push(vertex);\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : 4, \n \"myVertices\" : [ \n { \n \"_id\" : \"persons/266813997\", \n \"_rev\" : \"266813997\", \n \"_key\" : \"266813997\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/267076141\", \n \"_rev\" : \"267076141\", \n \"_key\" : \"267076141\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/267338285\", \n \"_rev\" : \"267338285\", \n \"_key\" : \"267338285\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/267534893\", \n \"_rev\" : \"267534893\", \n \"_key\" : \"267534893\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Expand only inbound edges of Alice and outbound edges of Eve:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/271073837\",\"edgeCollection\":\"knows\",\"expander\":\"var connections = [ ];if (vertex.name === \\\"Alice\\\") {config.edgeCollection.inEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\\\"internal\\\").db._document(e._from), edge: e});});}if (vertex.name === \\\"Eve\\\") {config.edgeCollection.outEdges(vertex).forEach(function (e) {connections.push({vertex: require(\\\"internal\\\").db._document(e._to), edge: e});});}return connections;\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271073837\", \n \"_rev\" : \"271073837\", \n \"_key\" : \"271073837\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/271991341\", \n \"_rev\" : \"271991341\", \n \"_key\" : \"271991341\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/271335981\", \n \"_rev\" : \"271335981\", \n \"_key\" : \"271335981\", \n \"name\" : \"Bob\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271073837\", \n \"_rev\" : \"271073837\", \n \"_key\" : \"271073837\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/272843309\", \n \"_rev\" : \"272843309\", \n \"_key\" : \"272843309\", \n \"_from\" : \"persons/271991341\", \n \"_to\" : \"persons/271073837\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271073837\", \n \"_rev\" : \"271073837\", \n \"_key\" : \"271073837\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/271991341\", \n \"_rev\" : \"271991341\", \n \"_key\" : \"271991341\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/272843309\", \n \"_rev\" : \"272843309\", \n \"_key\" : \"272843309\", \n \"_from\" : \"persons/271991341\", \n \"_to\" : \"persons/271073837\" \n }, \n { \n \"_id\" : \"knows/273039917\", \n \"_rev\" : \"273039917\", \n \"_key\" : \"273039917\", \n \"_from\" : \"persons/271991341\", \n \"_to\" : \"persons/271335981\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/271073837\", \n \"_rev\" : \"271073837\", \n \"_key\" : \"271073837\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/271991341\", \n \"_rev\" : \"271991341\", \n \"_key\" : \"271991341\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/271335981\", \n \"_rev\" : \"271335981\", \n \"_key\" : \"271335981\", \n \"name\" : \"Bob\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Follow the depthfirst strategy:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/275464749\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"strategy\":\"depthfirst\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275989037\", \n \"_rev\" : \"275989037\", \n \"_key\" : \"275989037\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/276185645\", \n \"_rev\" : \"276185645\", \n \"_key\" : \"276185645\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275989037\", \n \"_rev\" : \"275989037\", \n \"_key\" : \"275989037\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/276185645\", \n \"_rev\" : \"276185645\", \n \"_key\" : \"276185645\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277234221\", \n \"_rev\" : \"277234221\", \n \"_key\" : \"277234221\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275464749\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277234221\", \n \"_rev\" : \"277234221\", \n \"_key\" : \"277234221\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275464749\" \n }, \n { \n \"_id\" : \"knows/277430829\", \n \"_rev\" : \"277430829\", \n \"_key\" : \"277430829\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275726893\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277234221\", \n \"_rev\" : \"277234221\", \n \"_key\" : \"277234221\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275464749\" \n }, \n { \n \"_id\" : \"knows/277430829\", \n \"_rev\" : \"277430829\", \n \"_key\" : \"277430829\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/276644397\", \n \"_rev\" : \"276644397\", \n \"_key\" : \"276644397\", \n \"_from\" : \"persons/275464749\", \n \"_to\" : \"persons/275726893\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277234221\", \n \"_rev\" : \"277234221\", \n \"_key\" : \"277234221\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275464749\" \n }, \n { \n \"_id\" : \"knows/277430829\", \n \"_rev\" : \"277430829\", \n \"_key\" : \"277430829\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/276841005\", \n \"_rev\" : \"276841005\", \n \"_key\" : \"276841005\", \n \"_from\" : \"persons/275726893\", \n \"_to\" : \"persons/275989037\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/275989037\", \n \"_rev\" : \"275989037\", \n \"_key\" : \"275989037\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/277234221\", \n \"_rev\" : \"277234221\", \n \"_key\" : \"277234221\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275464749\" \n }, \n { \n \"_id\" : \"knows/277430829\", \n \"_rev\" : \"277430829\", \n \"_key\" : \"277430829\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/277037613\", \n \"_rev\" : \"277037613\", \n \"_key\" : \"277037613\", \n \"_from\" : \"persons/275726893\", \n \"_to\" : \"persons/276185645\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276185645\", \n \"_rev\" : \"276185645\", \n \"_key\" : \"276185645\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276644397\", \n \"_rev\" : \"276644397\", \n \"_key\" : \"276644397\", \n \"_from\" : \"persons/275464749\", \n \"_to\" : \"persons/275726893\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276644397\", \n \"_rev\" : \"276644397\", \n \"_key\" : \"276644397\", \n \"_from\" : \"persons/275464749\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/277430829\", \n \"_rev\" : \"277430829\", \n \"_key\" : \"277430829\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275726893\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276644397\", \n \"_rev\" : \"276644397\", \n \"_key\" : \"276644397\", \n \"_from\" : \"persons/275464749\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/277430829\", \n \"_rev\" : \"277430829\", \n \"_key\" : \"277430829\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/277234221\", \n \"_rev\" : \"277234221\", \n \"_key\" : \"277234221\", \n \"_from\" : \"persons/276382253\", \n \"_to\" : \"persons/275464749\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276382253\", \n \"_rev\" : \"276382253\", \n \"_key\" : \"276382253\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276644397\", \n \"_rev\" : \"276644397\", \n \"_key\" : \"276644397\", \n \"_from\" : \"persons/275464749\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/276841005\", \n \"_rev\" : \"276841005\", \n \"_key\" : \"276841005\", \n \"_from\" : \"persons/275726893\", \n \"_to\" : \"persons/275989037\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/275989037\", \n \"_rev\" : \"275989037\", \n \"_key\" : \"275989037\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/276644397\", \n \"_rev\" : \"276644397\", \n \"_key\" : \"276644397\", \n \"_from\" : \"persons/275464749\", \n \"_to\" : \"persons/275726893\" \n }, \n { \n \"_id\" : \"knows/277037613\", \n \"_rev\" : \"277037613\", \n \"_key\" : \"277037613\", \n \"_from\" : \"persons/275726893\", \n \"_to\" : \"persons/276185645\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/275464749\", \n \"_rev\" : \"275464749\", \n \"_key\" : \"275464749\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/275726893\", \n \"_rev\" : \"275726893\", \n \"_key\" : \"275726893\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/276185645\", \n \"_rev\" : \"276185645\", \n \"_key\" : \"276185645\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using postorder ordering:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/281625133\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"order\":\"postorder\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282214957\", \n \"_rev\" : \"282214957\", \n \"_key\" : \"282214957\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/282411565\", \n \"_rev\" : \"282411565\", \n \"_key\" : \"282411565\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/282214957\", \n \"_rev\" : \"282214957\", \n \"_key\" : \"282214957\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/282411565\", \n \"_rev\" : \"282411565\", \n \"_key\" : \"282411565\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283460141\", \n \"_rev\" : \"283460141\", \n \"_key\" : \"283460141\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281625133\" \n }, \n { \n \"_id\" : \"knows/283656749\", \n \"_rev\" : \"283656749\", \n \"_key\" : \"283656749\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/282870317\", \n \"_rev\" : \"282870317\", \n \"_key\" : \"282870317\", \n \"_from\" : \"persons/281625133\", \n \"_to\" : \"persons/281952813\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283460141\", \n \"_rev\" : \"283460141\", \n \"_key\" : \"283460141\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281625133\" \n }, \n { \n \"_id\" : \"knows/283656749\", \n \"_rev\" : \"283656749\", \n \"_key\" : \"283656749\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/283066925\", \n \"_rev\" : \"283066925\", \n \"_key\" : \"283066925\", \n \"_from\" : \"persons/281952813\", \n \"_to\" : \"persons/282214957\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282214957\", \n \"_rev\" : \"282214957\", \n \"_key\" : \"282214957\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283460141\", \n \"_rev\" : \"283460141\", \n \"_key\" : \"283460141\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281625133\" \n }, \n { \n \"_id\" : \"knows/283656749\", \n \"_rev\" : \"283656749\", \n \"_key\" : \"283656749\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/283263533\", \n \"_rev\" : \"283263533\", \n \"_key\" : \"283263533\", \n \"_from\" : \"persons/281952813\", \n \"_to\" : \"persons/282411565\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282411565\", \n \"_rev\" : \"282411565\", \n \"_key\" : \"282411565\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283460141\", \n \"_rev\" : \"283460141\", \n \"_key\" : \"283460141\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281625133\" \n }, \n { \n \"_id\" : \"knows/283656749\", \n \"_rev\" : \"283656749\", \n \"_key\" : \"283656749\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281952813\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/283460141\", \n \"_rev\" : \"283460141\", \n \"_key\" : \"283460141\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281625133\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/282870317\", \n \"_rev\" : \"282870317\", \n \"_key\" : \"282870317\", \n \"_from\" : \"persons/281625133\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/283656749\", \n \"_rev\" : \"283656749\", \n \"_key\" : \"283656749\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/283460141\", \n \"_rev\" : \"283460141\", \n \"_key\" : \"283460141\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281625133\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/282870317\", \n \"_rev\" : \"282870317\", \n \"_key\" : \"282870317\", \n \"_from\" : \"persons/281625133\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/283656749\", \n \"_rev\" : \"283656749\", \n \"_key\" : \"283656749\", \n \"_from\" : \"persons/282608173\", \n \"_to\" : \"persons/281952813\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282608173\", \n \"_rev\" : \"282608173\", \n \"_key\" : \"282608173\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/282870317\", \n \"_rev\" : \"282870317\", \n \"_key\" : \"282870317\", \n \"_from\" : \"persons/281625133\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/283066925\", \n \"_rev\" : \"283066925\", \n \"_key\" : \"283066925\", \n \"_from\" : \"persons/281952813\", \n \"_to\" : \"persons/282214957\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282214957\", \n \"_rev\" : \"282214957\", \n \"_key\" : \"282214957\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/282870317\", \n \"_rev\" : \"282870317\", \n \"_key\" : \"282870317\", \n \"_from\" : \"persons/281625133\", \n \"_to\" : \"persons/281952813\" \n }, \n { \n \"_id\" : \"knows/283263533\", \n \"_rev\" : \"283263533\", \n \"_key\" : \"283263533\", \n \"_from\" : \"persons/281952813\", \n \"_to\" : \"persons/282411565\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/282411565\", \n \"_rev\" : \"282411565\", \n \"_key\" : \"282411565\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/282870317\", \n \"_rev\" : \"282870317\", \n \"_key\" : \"282870317\", \n \"_from\" : \"persons/281625133\", \n \"_to\" : \"persons/281952813\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/281952813\", \n \"_rev\" : \"281952813\", \n \"_key\" : \"281952813\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/281625133\", \n \"_rev\" : \"281625133\", \n \"_key\" : \"281625133\", \n \"name\" : \"Alice\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Using backward item-ordering:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/287916589\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"itemOrder\":\"backward\"}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288637485\", \n \"_rev\" : \"288637485\", \n \"_key\" : \"288637485\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/288440877\", \n \"_rev\" : \"288440877\", \n \"_key\" : \"288440877\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288637485\", \n \"_rev\" : \"288637485\", \n \"_key\" : \"288637485\", \n \"name\" : \"Dave\" \n }, \n { \n \"_id\" : \"persons/288440877\", \n \"_rev\" : \"288440877\", \n \"_key\" : \"288440877\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289096237\", \n \"_rev\" : \"289096237\", \n \"_key\" : \"289096237\", \n \"_from\" : \"persons/287916589\", \n \"_to\" : \"persons/288178733\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289096237\", \n \"_rev\" : \"289096237\", \n \"_key\" : \"289096237\", \n \"_from\" : \"persons/287916589\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289489453\", \n \"_rev\" : \"289489453\", \n \"_key\" : \"289489453\", \n \"_from\" : \"persons/288178733\", \n \"_to\" : \"persons/288637485\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288637485\", \n \"_rev\" : \"288637485\", \n \"_key\" : \"288637485\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289096237\", \n \"_rev\" : \"289096237\", \n \"_key\" : \"289096237\", \n \"_from\" : \"persons/287916589\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289292845\", \n \"_rev\" : \"289292845\", \n \"_key\" : \"289292845\", \n \"_from\" : \"persons/288178733\", \n \"_to\" : \"persons/288440877\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288440877\", \n \"_rev\" : \"288440877\", \n \"_key\" : \"288440877\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289096237\", \n \"_rev\" : \"289096237\", \n \"_key\" : \"289096237\", \n \"_from\" : \"persons/287916589\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289882669\", \n \"_rev\" : \"289882669\", \n \"_key\" : \"289882669\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/288178733\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289096237\", \n \"_rev\" : \"289096237\", \n \"_key\" : \"289096237\", \n \"_from\" : \"persons/287916589\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289882669\", \n \"_rev\" : \"289882669\", \n \"_key\" : \"289882669\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289686061\", \n \"_rev\" : \"289686061\", \n \"_key\" : \"289686061\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/287916589\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289686061\", \n \"_rev\" : \"289686061\", \n \"_key\" : \"289686061\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/287916589\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289686061\", \n \"_rev\" : \"289686061\", \n \"_key\" : \"289686061\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/287916589\" \n }, \n { \n \"_id\" : \"knows/289882669\", \n \"_rev\" : \"289882669\", \n \"_key\" : \"289882669\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/288178733\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289686061\", \n \"_rev\" : \"289686061\", \n \"_key\" : \"289686061\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/287916589\" \n }, \n { \n \"_id\" : \"knows/289882669\", \n \"_rev\" : \"289882669\", \n \"_key\" : \"289882669\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289489453\", \n \"_rev\" : \"289489453\", \n \"_key\" : \"289489453\", \n \"_from\" : \"persons/288178733\", \n \"_to\" : \"persons/288637485\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288637485\", \n \"_rev\" : \"288637485\", \n \"_key\" : \"288637485\", \n \"name\" : \"Dave\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289686061\", \n \"_rev\" : \"289686061\", \n \"_key\" : \"289686061\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/287916589\" \n }, \n { \n \"_id\" : \"knows/289882669\", \n \"_rev\" : \"289882669\", \n \"_key\" : \"289882669\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289292845\", \n \"_rev\" : \"289292845\", \n \"_key\" : \"289292845\", \n \"_from\" : \"persons/288178733\", \n \"_to\" : \"persons/288440877\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/288440877\", \n \"_rev\" : \"288440877\", \n \"_key\" : \"288440877\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/289686061\", \n \"_rev\" : \"289686061\", \n \"_key\" : \"289686061\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/287916589\" \n }, \n { \n \"_id\" : \"knows/289882669\", \n \"_rev\" : \"289882669\", \n \"_key\" : \"289882669\", \n \"_from\" : \"persons/288834093\", \n \"_to\" : \"persons/288178733\" \n }, \n { \n \"_id\" : \"knows/289096237\", \n \"_rev\" : \"289096237\", \n \"_key\" : \"289096237\", \n \"_from\" : \"persons/287916589\", \n \"_to\" : \"persons/288178733\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/288834093\", \n \"_rev\" : \"288834093\", \n \"_key\" : \"288834093\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/288178733\", \n \"_rev\" : \"288178733\", \n \"_key\" : \"288178733\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/287916589\", \n \"_rev\" : \"287916589\", \n \"_key\" : \"287916589\", \n \"name\" : \"Alice\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
Edges should only be included once globally, but nodes are included every time they are visited:
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/294076973\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"uniqueness\":{\"vertices\":\"none\",\"edges\":\"global\"}}\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"visited\" : { \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295060013\", \n \"_rev\" : \"295060013\", \n \"_key\" : \"295060013\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294404653\", \n \"_rev\" : \"294404653\", \n \"_key\" : \"294404653\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/294666797\", \n \"_rev\" : \"294666797\", \n \"_key\" : \"294666797\", \n \"name\" : \"Charlie\" \n }, \n { \n \"_id\" : \"persons/294863405\", \n \"_rev\" : \"294863405\", \n \"_key\" : \"294863405\", \n \"name\" : \"Dave\" \n } \n ], \n \"paths\" : [ \n { \n \"edges\" : [ ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/295911981\", \n \"_rev\" : \"295911981\", \n \"_key\" : \"295911981\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294076973\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295060013\", \n \"_rev\" : \"295060013\", \n \"_key\" : \"295060013\", \n \"name\" : \"Eve\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/295911981\", \n \"_rev\" : \"295911981\", \n \"_key\" : \"295911981\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294076973\" \n }, \n { \n \"_id\" : \"knows/296108589\", \n \"_rev\" : \"296108589\", \n \"_key\" : \"296108589\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294404653\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295060013\", \n \"_rev\" : \"295060013\", \n \"_key\" : \"295060013\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294404653\", \n \"_rev\" : \"294404653\", \n \"_key\" : \"294404653\", \n \"name\" : \"Bob\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/295911981\", \n \"_rev\" : \"295911981\", \n \"_key\" : \"295911981\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294076973\" \n }, \n { \n \"_id\" : \"knows/296108589\", \n \"_rev\" : \"296108589\", \n \"_key\" : \"296108589\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294404653\" \n }, \n { \n \"_id\" : \"knows/295322157\", \n \"_rev\" : \"295322157\", \n \"_key\" : \"295322157\", \n \"_from\" : \"persons/294076973\", \n \"_to\" : \"persons/294404653\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295060013\", \n \"_rev\" : \"295060013\", \n \"_key\" : \"295060013\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294404653\", \n \"_rev\" : \"294404653\", \n \"_key\" : \"294404653\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/295911981\", \n \"_rev\" : \"295911981\", \n \"_key\" : \"295911981\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294076973\" \n }, \n { \n \"_id\" : \"knows/296108589\", \n \"_rev\" : \"296108589\", \n \"_key\" : \"296108589\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294404653\" \n }, \n { \n \"_id\" : \"knows/295518765\", \n \"_rev\" : \"295518765\", \n \"_key\" : \"295518765\", \n \"_from\" : \"persons/294404653\", \n \"_to\" : \"persons/294666797\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295060013\", \n \"_rev\" : \"295060013\", \n \"_key\" : \"295060013\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294404653\", \n \"_rev\" : \"294404653\", \n \"_key\" : \"294404653\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/294666797\", \n \"_rev\" : \"294666797\", \n \"_key\" : \"294666797\", \n \"name\" : \"Charlie\" \n } \n ] \n }, \n { \n \"edges\" : [ \n { \n \"_id\" : \"knows/295911981\", \n \"_rev\" : \"295911981\", \n \"_key\" : \"295911981\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294076973\" \n }, \n { \n \"_id\" : \"knows/296108589\", \n \"_rev\" : \"296108589\", \n \"_key\" : \"296108589\", \n \"_from\" : \"persons/295060013\", \n \"_to\" : \"persons/294404653\" \n }, \n { \n \"_id\" : \"knows/295715373\", \n \"_rev\" : \"295715373\", \n \"_key\" : \"295715373\", \n \"_from\" : \"persons/294404653\", \n \"_to\" : \"persons/294863405\" \n } \n ], \n \"vertices\" : [ \n { \n \"_id\" : \"persons/294076973\", \n \"_rev\" : \"294076973\", \n \"_key\" : \"294076973\", \n \"name\" : \"Alice\" \n }, \n { \n \"_id\" : \"persons/295060013\", \n \"_rev\" : \"295060013\", \n \"_key\" : \"295060013\", \n \"name\" : \"Eve\" \n }, \n { \n \"_id\" : \"persons/294404653\", \n \"_rev\" : \"294404653\", \n \"_key\" : \"294404653\", \n \"name\" : \"Bob\" \n }, \n { \n \"_id\" : \"persons/294863405\", \n \"_rev\" : \"294863405\", \n \"_key\" : \"294863405\", \n \"name\" : \"Dave\" \n } \n ] \n } \n ] \n } \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n
If the underlying graph is cyclic, maxIterations should be set: The underlying graph has two vertices Alice and Bob. With the directed edges: - Alice knows Bob _ Bob knows Alice
unix> curl -X POST --data @- --dump - http://localhost:8529/_api/traversal\n{\"startVertex\":\"persons/299385389\",\"edgeCollection\":\"knows\",\"direction\":\"any\",\"uniqueness\":{\"vertices\":\"none\",\"edges\":\"none\"},\"maxIterations\":5}\n\nHTTP/1.1 500 Internal Error\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 500, \n \"errorNum\" : 1909, \n \"errorMessage\" : \"too many iterations\" \n}\n\n
",
"nickname": "executesATraversal"
}
],