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

Doc - Remove _getConnectingEdges() as it's not implemented (#7621)

This commit is contained in:
Simran 2018-12-03 11:13:44 -08:00 committed by sleto-it
parent bac3df40c3
commit 746443d511
2 changed files with 0 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Documentation/Books/Manual/Graphs/GeneralGraphs/Management.md
View File

@ -851,47 +851,3 @@ If this edge is used as a vertex by another edge, the other edge will be removed
~ examples.dropGraph("social");
@END_EXAMPLE_ARANGOSH_OUTPUT
@endDocuBlock generalGraphEdgeCollectionRemove
### Connect edges
Get all connecting edges between 2 groups of vertices defined by the examples
`graph._getConnectingEdges(vertexExample, vertexExample2, options)`
The function accepts an id, an example, a list of examples or even an empty
example as parameter for vertexExample.
**Parameters**
* vertexExample1 (optional) See [Definition of examples](Functions.md#definition-of-examples)
* vertexExample2 (optional) See [Definition of examples](Functions.md#definition-of-examples)
* options (optional) An object defining further options. Can have the following values:
* *edgeExamples*: Filter the edges, see [Definition of examples](Functions.md#definition-of-examples)
* *edgeCollectionRestriction* : One or a list of edge-collection names that should be
considered to be on the path.
* *vertex1CollectionRestriction* : One or a list of vertex-collection names that should be
considered on the intermediate vertex steps.
* *vertex2CollectionRestriction* : One or a list of vertex-collection names that should be
considered on the intermediate vertex steps.
**Examples**
A route planner example, all connecting edges between capitals.
@startDocuBlockInline generalGraphModuleConnectingEdges1
@EXAMPLE_ARANGOSH_OUTPUT{generalGraphModuleConnectingEdges1}
var examples = require("@arangodb/graph-examples/example-graph.js");
var graph = examples.loadGraph("routeplanner");
graph._getConnectingEdges({isCapital : true}, {isCapital : true});
~ examples.dropGraph("routeplanner");
@END_EXAMPLE_ARANGOSH_OUTPUT
@endDocuBlock generalGraphModuleConnectingEdges1

4
Documentation/Examples/generalGraphModuleConnectingEdges1.generated
View File

@ -1,4 +0,0 @@
arangosh&gt; <span class="hljs-keyword">var</span> examples = <span class="hljs-built_in">require</span>(<span class="hljs-string">"@arangodb/graph-examples/example-graph.js"</span>);
arangosh&gt; <span class="hljs-keyword">var</span> graph = examples.loadGraph(<span class="hljs-string">"routeplanner"</span>);
arangosh&gt; graph._getConnectingEdges({<span class="hljs-attr">isCapital</span> : <span class="hljs-literal">true</span>}, {<span class="hljs-attr">isCapital</span> : <span class="hljs-literal">true</span>});
[ ]