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

Review of General Graph

This commit is contained in:
Lucas Dohmen 2014-06-24 21:21:45 +08:00
parent 4c00cc38fd
commit 9b37812da6
3 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/Books/Users/General-Graphs/Management.mdpp
View File

@ -1,7 +1,7 @@
!CHAPTER Graph Management
In order to create a graph the philosophy of handling the graph content has to be introduced.
A graph contains a set of edge definitions each referring to one edge collection and
Before we create our first graph, the philosophy of handling the graph content has to be introduced.
A graph contains of a set of edge definitions each referring to one edge collection and
defining constraints on the vertex collections used as start and end points of the edges.
Furthermore a graph can contain an arbitrary amount of vertex collections, called orphan collections, that are not used in any edge definition but should be managed by the graph.
In order to create a non empty graph the functionality to create edge definitions has to be introduced first:

2
Documentation/Books/Users/General-Graphs/README.mdpp
View File

@ -2,7 +2,7 @@
This chapter describes the general-graph module.
It allows you to define a graph that is spread across several edge and document collections.
This allows you to structure your models in line with your domain and group them logically in collections and giving you the power to query them in the same graph queries.
This allows you to structure your models in line with your domain and group them logically in collections giving you the power to query them in the same graph queries.
There is no need to include the referenced collections within the query, this module will handle it for you.
!SECTION First Steps with Graphs

22
js/common/modules/org/arangodb/general-graph.js
View File

@ -1505,7 +1505,7 @@ var _edgeDefinitions = function () {
///
/// *Parameter*
///
/// * *edgeDefinitions*: An list of relation definition objects.
/// * *edgeDefinitions*: A list of relation definition objects.
/// * *relationX*: An object representing a definition of one relation in the graph
///
/// *Examples*
@ -1941,7 +1941,7 @@ var sortEdgeDefinition = function(edgeDefinition) {
///
/// *Parameter*
///
/// * *data*: Json data of vertex.
/// * *data*: JSON data of vertex.
///
/// *Examples*
///
@ -1962,7 +1962,7 @@ var sortEdgeDefinition = function(edgeDefinition) {
/// *Parameter*
///
/// * *vertexId*: *_id* attribute of the vertex
/// * *data*: Json data of vertex.
/// * *data*: JSON data of vertex.
/// * *options* (optional): See [collection documentation](../Documents/DocumentMethods.md)
///
/// *Examples*
@ -1985,7 +1985,7 @@ var sortEdgeDefinition = function(edgeDefinition) {
/// *Parameter*
///
/// * *vertexId*: *_id* attribute of the vertex
/// * *data*: Json data of vertex.
/// * *data*: JSON data of vertex.
/// * *options* (optional): See [collection documentation](../Documents/DocumentMethods.md)
///
/// *Examples*
@ -2037,7 +2037,7 @@ var sortEdgeDefinition = function(edgeDefinition) {
///
/// * *from*: *_id* attribute of the source vertex
/// * *to*: *_id* attribute of the target vertex
/// * *data*: Json data of the edge
/// * *data*: JSON data of the edge
/// * *options* (optional): See [collection documentation](../Edges/EdgeMethods.md)
///
/// *Examples*
@ -2068,7 +2068,7 @@ var sortEdgeDefinition = function(edgeDefinition) {
/// *Parameter*
///
/// * *edgeId*: *_id* attribute of the edge
/// * *data*: Json data of the edge
/// * *data*: JSON data of the edge
/// * *options* (optional): See [collection documentation](../Documents/DocumentMethods.md)
///
/// *Examples*
@ -2091,7 +2091,7 @@ var sortEdgeDefinition = function(edgeDefinition) {
/// *Parameter*
///
/// * *edgeId*: *_id* attribute of the edge
/// * *data*: Json data of the edge
/// * *data*: JSON data of the edge
/// * *options* (optional): See [collection documentation](../Documents/DocumentMethods.md)
///
/// *Examples*
@ -2936,7 +2936,7 @@ Graph.prototype._commonProperties = function(vertex1Example, vertex2Example, opt
/// graph._countCommonProperties({}, {});
/// @END_EXAMPLE_ARANGOSH_OUTPUT
///
/// A route planner example, all german cities which share same properties except for population.
/// A route planner example, all German cities which share same properties except for population.
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphModuleAmountProperties2}
/// ~ var db = require("internal").db;
@ -3366,7 +3366,7 @@ Graph.prototype._eccentricity = function(options) {
/// graph._absoluteCloseness({}, {weight : 'distance'});
/// @END_EXAMPLE_ARANGOSH_OUTPUT
///
/// A route planner example, the absolute closeness of all german Cities regarding only
/// A route planner example, the absolute closeness of all German Cities regarding only
/// outbound paths.
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphModuleAbsCloseness3}
@ -3877,7 +3877,7 @@ var changeEdgeDefinitionsForGraph = function(graph, edgeDefinition, newCollectio
///
/// Edits one relation definition of a graph. The edge definition used as argument will
/// replace the existing edge definition of the graph which has the same collection.
/// Vertex Collections of the replaced edge definition, that are not used in the new
/// Vertex Collections of the replaced edge definition that are not used in the new
/// definition will transform to an orphan. Orphans that are used in this new edge
/// definition will be deleted from the list of orphans. Other graphs with the same edge
/// definition will be modified, too.
@ -4082,7 +4082,7 @@ Graph.prototype._addVertexCollection = function(vertexCollectionName, createColl
/// `graph._orphanCollections()`
/// *Get all orphan collections*
///
/// Returns all vertex collections of the graph, that are not used in any edge definition.
/// Returns all vertex collections of the graph that are not used in any edge definition.
///
/// *Examples*
///