Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge branch 'devel' of https://github.com/arangodb/arangodb into devel

This commit is contained in:
Jan Steemann 2016-02-08 16:14:30 +01:00
parent e6ff2a5100 273e7933fd
commit b74575b247
2 changed files with 31 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
Documentation/Books/Users/Aql/GraphOperations.mdpp
View File

@ -54,18 +54,13 @@ vertices (see [example](#short-explanation-of-the-example-parameter)).
* *options* (optional) : An object containing the following options:
* *direction* : The direction of the edges as a string. Possible values are *outbound*, *inbound* and *any* (default).
* *edgeCollectionRestriction* : One or multiple edge collection names. Only edges from these collections will be considered for the path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as
start vertex of a path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as start vertex of a path.
* *endVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as end vertex of a path.
* *edgeExamples* : A filter example for the edges (see [example](#short-explanation-of-the-example-parameter)).
* *minDepth* : Defines the minimal length of a path from an edge to a vertex
(default is 1, which means only the edges directly connected to a vertex would be returned).
* *maxDepth* : Defines the maximal length of a path from an edge
to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).
* *minDepth* : Defines the minimal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).
* *maxDepth* : Defines the maximal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).
* *maxIterations*: the maximum number of iterations that the traversal is allowed to perform. It is sensible to set this number so unbounded traversals will terminate.
* *includeData*: Defines if the result should contain only ids (false) or if all documents
should be fully extracted (true). By default this parameter is set to false, so only ids
will be returned.
* *includeData*: Defines if the result should contain only ids (false) or if all documents should be fully extracted (true). By default this parameter is set to false, so only ids will be returned.
**Examples**
@ -187,15 +182,11 @@ Hence the default call would have a complexity of **O(n\*m)**;
* *edgeExamples* : A filter example for the edges to the neighbors (see [example](#short-explanation-of-the-example-parameter)).
* *neighborExamples* : An example for the desired neighbors (see [example](#short-explanation-of-the-example-parameter)).
* *edgeCollectionRestriction* : One or multiple edge collection names. Only edges from these collections will be considered for the path.
* *vertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be contained in the
result. This does not effect vertices on the path.
* *vertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be contained in the result. This does not effect vertices on the path.
* *minDepth* : Defines the minimal depth a path to a neighbor must have to be returned (default is 1).
* *maxDepth* : Defines the maximal depth a path to a neighbor must have to be returned (default is 1).
* *maxIterations*: the maximum number of iterations that the traversal is
allowed to perform. It is sensible to set this number so unbounded traversals
will terminate at some point.
* *includeData* is a boolean value to define if the returned documents should be extracted
instead of returning their ids only. The default is *false*.
* *maxIterations*: the maximum number of iterations that the traversal is allowed to perform. It is sensible to set this number so unbounded traversals will terminate at some point.
* *includeData* is a boolean value to define if the returned documents should be extracted instead of returning their ids only. The default is *false*.
Note: in ArangoDB versions prior to 2.6 *NEIGHBORS* returned the array of neighbor vertices with
all attributes and not just the vertex ids. To return to the same behavior, set the *includeData*
@ -435,27 +426,14 @@ The complexity of the function is described
* *options* (optional) : An object containing the following options:
* *direction* : The direction of the edges as a string. Possible values are *outbound*, *inbound* and *any* (default).
* *edgeCollectionRestriction* : One or multiple edge collection names. Only edges from these collections will be considered for the path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as
start vertex of a path.
* *endVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as
end vertex of a path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as start vertex of a path.
* *endVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as end vertex of a path.
* *edgeExamples* : A filter example for the edges in the shortest paths (see [example](#short-explanation-of-the-example-parameter)).
* *algorithm* : The algorithm to calculate
the shortest paths. If both start and end vertex examples are empty
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is
used, otherwise the default is [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *algorithm* : The algorithm to calculate the shortest paths. If both start and end vertex examples are empty [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is used, otherwise the default is [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *weight* : The name of the attribute of the edges containing the length as a string.
* *defaultWeight* : Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default is used as length.
If no default is supplied the default would be positive Infinity so the path could not be calculated.
* *stopAtFirstMatch* : Only useful if targetVertices is an example that matches
to more than one vertex. If so only the shortest path to
the closest of these target vertices is returned.
This flag is of special use if you have target pattern and
you want to know which vertex with this pattern is matched first.
* *includeData* : Triggers if only *_id*'s are returned (*false*, default)
or if data is included for all objects as well (*true*)
This will modify the content of *vertex*, *path.vertices* and *path.edges*.
* *defaultWeight* : Only used with the option *weight*. If an edge does not have the attribute named as defined in option *weight* this default is used as length. If no default is supplied the default would be positive Infinity so the path could not be calculated.
* *stopAtFirstMatch* : Only useful if targetVertices is an example that matches to more than one vertex. If so only the shortest path to the closest of these target vertices is returned. This flag is of special use if you have target pattern and you want to know which vertex with this pattern is matched first.
* *includeData* : Triggers if only *_id*'s are returned (*false*, default) or if data is included for all objects as well (*true*) This will modify the content of *vertex*, *path.vertices* and *path.edges*.
NOTE: Since version 2.6 we have included a new optional parameter *includeData*.
This parameter triggers if the result contains the real data object *true* or
@ -526,21 +504,12 @@ The complexity of this function strongly depends on the usage.
* *itemOrder*: determines the order in which connections returned by the expander will be processed. Possible values are *forward* and *backward*.
* *maxDepth*: if set to a value greater than *0*, this will limit the traversal to this maximum depth.
* *minDepth*: if set to a value greater than *0*, all vertices found on a level below the *minDepth* level will not be included in the result.
* *maxIterations*: the maximum number of iterations that the traversal is allowed to perform. It is sensible to set this number so unbounded traversals
will terminate at some point.
* *uniqueness*: an object that defines how repeated visitations of vertices should
be handled. The *uniqueness* object can have a sub-attribute *vertices*, and a
sub-attribute *edges*. Each sub-attribute can have one of the following values:
* *maxIterations*: the maximum number of iterations that the traversal is allowed to perform. It is sensible to set this number so unbounded traversals will terminate at some point.
* *uniqueness*: an object that defines how repeated visitations of vertices should be handled. The *uniqueness* object can have a sub-attribute *vertices*, and a sub-attribute *edges*. Each sub-attribute can have one of the following values:
* *"none"*: no uniqueness constraints
* *"path"*: element is excluded if it is already contained in the current path.
This setting may be sensible for graphs that contain cycles (e.g. A -> B -> C -> A).
* *"path"*: element is excluded if it is already contained in the current path. This setting may be sensible for graphs that contain cycles (e.g. A -> B -> C -> A).
* *"global"*: element is excluded if it was already found/visited at any point during the traversal.
* *filterVertices* An optional array of example vertex documents that the traversal will treat specially.
If no examples are given, the traversal will handle all encountered vertices equally.
If one or many vertex examples are given, the traversal will exclude any non-matching vertex from the
result and/or not descend into it. Optionally, filterVertices can contain a string containing the name
of a user-defined AQL function that should be responsible for filtering.
If so, the AQL function is expected to have the following signature:
* *filterVertices* An optional array of example vertex documents that the traversal will treat specially. If no examples are given, the traversal will handle all encountered vertices equally. If one or many vertex examples are given, the traversal will exclude any non-matching vertex from the result and/or not descend into it. Optionally, filterVertices can contain a string containing the name of a user-defined AQL function that should be responsible for filtering. If so, the AQL function is expected to have the following signature:
`function (config, vertex, path)`
@ -726,15 +695,10 @@ vertices (see [example](#short-explanation-of-the-example-parameter)).
* *options* (optional) : An object containing the following options:
* *direction* : The direction of the edges as a string. Possible values are *outbound*, *inbound* and *any* (default).
* *edgeCollectionRestriction* : One or multiple edge collection names. Only edges from these collections will be considered for the path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as
start vertex of a path.
* *endVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as
end vertex of a path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as start vertex of a path.
* *endVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as end vertex of a path.
* *edgeExamples* : A filter example for the edges in the shortest paths (see [example](#short-explanation-of-the-example-parameter)).
* *algorithm* : The algorithm to calculate the shortest paths as a string. If vertex example is empty
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is
used as default, otherwise the default is
[Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm)
* *algorithm* : The algorithm to calculate the shortest paths as a string. If vertex example is empty [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) is used as default, otherwise the default is [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm)
* *weight* : The name of the attribute of the edges containing the length as a string.
* *defaultWeight* : Only used with the option *weight*.
@ -805,9 +769,7 @@ The complexity of the function is described
* *graphName* : The name of the graph as a string.
* *options* (optional) : An object containing the following options:
* *direction* : The direction of the edges as a string. Possible values are *outbound*, *inbound* and *any* (default).
* *algorithm* : The algorithm to calculate the shortest paths as a string. Possible
values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm)
(default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *algorithm* : The algorithm to calculate the shortest paths as a string. Possible values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *weight* : The name of the attribute of the edges containing the length as a string.
* *defaultWeight* : Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default is used as length.
@ -867,14 +829,10 @@ vertices (see [example](#short-explanation-of-the-example-parameter)).
* *options* : An object containing the following options:
* *direction* : The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
* *edgeCollectionRestriction* : One or multiple edge collection names. Only edges from these collections will be considered for the path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as
start vertex of a path.
* *endVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as
end vertex of a path.
* *startVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as start vertex of a path.
* *endVertexCollectionRestriction* : One or multiple vertex collection names. Only vertices from these collections will be considered as end vertex of a path.
* *edgeExamples* : A filter example for the edges in the shortest paths (see [example](#short-explanation-of-the-example-parameter)).
* *algorithm* : The algorithm to calculate the shortest paths. Possible values are
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default)
and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *algorithm* : The algorithm to calculate the shortest paths. Possible values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *weight* : The name of the attribute of the edges containing the length.
* *defaultWeight* : Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default is used as length.
@ -945,9 +903,7 @@ The complexity of the function is described
* *graphName* : The name of the graph as a string.
* *options* : An object containing the following options:
* *direction* : The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
* *algorithm* : The algorithm to calculate the shortest paths. Possible values are
[Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default)
and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *algorithm* : The algorithm to calculate the shortest paths. Possible values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *weight* : The name of the attribute of the edges containing the length.
* *defaultWeight* : Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this defaultis used as length.
@ -1153,9 +1109,7 @@ The complexity of the function is described
* *graphName* : The name of the graph as a string.
* *options* : An object containing the following options:
* *direction* : The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
* *algorithm* : The algorithm to calculate the shortest paths as a string. Possible
values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm)
(default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *algorithm* : The algorithm to calculate the shortest paths as a string. Possible values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *weight* : The name of the attribute of the edges containing the length.
* *defaultWeight* : Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default is used as length.
@ -1225,9 +1179,7 @@ The complexity of the function is described
* *graphName* : The name of the graph as a string.
* *options* : An object containing the following options:
* *direction* : The direction of the edges. Possible values are *outbound*, *inbound* and *any* (default).
* *algorithm* : The algorithm to calculate the shortest paths as a string. Possible
values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm)
(default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *algorithm* : The algorithm to calculate the shortest paths as a string. Possible values are [Floyd-Warshall](http://en.wikipedia.org/wiki/Floyd%E2%80%93Warshall_algorithm) (default) and [Dijkstra](http://en.wikipedia.org/wiki/Dijkstra's_algorithm).
* *weight* : The name of the attribute of the edges containing the length.
* *defaultWeight* : Only used with the option *weight*.
If an edge does not have the attribute named as defined in option *weight* this default is used as length.

8
Documentation/Books/Users/Graphs/README.mdpp
View File

@ -27,11 +27,11 @@ They use the ful spectrum of ArangoDBs graph features. You may access them via s
- [AQL Graph traversals](../Aql/GraphTraversals.md) on both named and anonymous graphs
- [AQL operations on named Graphs](../Aql/GraphOperations.md)
- [AQL operations on raw vertex & edge collections](../Aql/GraphFunctions.md)
- [the RESTful General Graph interface](../HttpGharial/README.md)
- [The javascript General Graph implementation, as you may use it in FOXX Services](../GeneralGraphs/README.md)
* [Graph Management](../GeneralGraphs/Management.md)
* [Graph Functions](../GeneralGraphs/Functions.md)
* [Fluent Query Interface](../GeneralGraphs/FluentAQLInterface.md)
* [Graph Management](../GeneralGraphs/Management.md); creating & manipualating graph definitions; inserting, updating and deleting vertices and edges into graphs
* [Graph Functions](../GeneralGraphs/Functions.md) for working with edges and vertices, to analyze them and their relations
* [Fluent Query Interface](../GeneralGraphs/FluentAQLInterface.md); if you like to work with graphs via a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface)
- [the RESTful General Graph interface](../HttpGharial/README.md) used to implement graph management in client drivers
!SUBSUBSECTION Manipulating collections of named graphs with regular document functions