mirror of https://gitee.com/bigwinds/arangodb
Replace @PARAMS
This commit is contained in:
Wilfried Goesgens
parent
ba2614d0fb
commit
124eed9596
|
|
@ -40,7 +40,9 @@ It will return a mutable AQL statement which can be further refined, using the
|
|||
functions described below.
|
||||
The resulting set of edges can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -87,7 +89,9 @@ It will return a mutable AQL statement which can be further refined, using the
|
|||
functions described below.
|
||||
The resulting set of edges can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -314,7 +318,9 @@ The complexity of this method is **O(n\*m^x)** with *n* being the vertices defin
|
|||
parameter vertexExamplex, *m* the average amount of edges of a vertex and *x* the maximal depths.
|
||||
Hence the default call would have a complexity of **O(n\*m)**;
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -372,7 +378,9 @@ Creates an AQL statement to select all *outbound* edges for each of the vertices
|
|||
in the step before.
|
||||
The resulting set of edges can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -431,7 +439,9 @@ Creates an AQL statement to select all *inbound* edges for each of the vertices
|
|||
in the step before.
|
||||
The resulting set of edges can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -490,7 +500,9 @@ in the step before.
|
|||
This includes all vertices contained in *_from* as well as *_to* attribute of the edges.
|
||||
The resulting set of vertices can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -549,7 +561,9 @@ in the step before start at.
|
|||
This includes all vertices contained in *_from* attribute of the edges.
|
||||
The resulting set of vertices can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -608,7 +622,9 @@ in the step before end in.
|
|||
This includes all vertices contained in *_to* attribute of the edges.
|
||||
The resulting set of vertices can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -666,7 +682,9 @@ Creates an AQL statement to select all neighbors for each of the vertices select
|
|||
in the step before.
|
||||
The resulting set of vertices can be filtered by defining one or more *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -739,7 +757,9 @@ to a specific set of collections within the graph.
|
|||
Restriction is only applied to this one part of the query.
|
||||
It does not effect earlier or later statements.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{restrictions, array, optional}
|
||||
Define either one or a list of collections in the graph.
|
||||
|
|
@ -797,7 +817,9 @@ Filter the result of the query
|
|||
This can be used to further specfiy the expected result of the query.
|
||||
The result set is reduced to the set of elements that matches the given *examples*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{examples, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
|
|||
|
|
@ -25,7 +25,9 @@ Get the source vertex of an edge
|
|||
|
||||
Returns the vertex defined with the attribute *_from* of the edge with *edgeId* as its *_id*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeId, string, required}
|
||||
*_id* attribute of the edge
|
||||
|
|
@ -55,7 +57,9 @@ Get the target vertex of an edge
|
|||
|
||||
Returns the vertex defined with the attribute *_to* of the edge with *edgeId* as its *_id*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeId, string, required}
|
||||
*_id* attribute of the edge
|
||||
|
|
@ -89,7 +93,9 @@ The complexity of this method is **O(n\*m^x)** with *n* being the vertices defin
|
|||
parameter vertexExamplex, *m* the average amount of neighbors and *x* the maximal depths.
|
||||
Hence the default call would have a complexity of **O(n\*m)**;
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexExample, object, optional}
|
||||
See [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -239,7 +245,9 @@ example as parameter for vertex1Example and vertex2Example.
|
|||
The complexity of this method is **O(n)** with *n* being the maximal amount of vertices
|
||||
defined by the parameters vertexExamples.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertex1Examples, object, optional}
|
||||
Filter the set of source vertices, see [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -336,7 +344,9 @@ This function determines all available paths in a graph.
|
|||
The complexity of this method is **O(n\*n\*m)** with *n* being the amount of vertices in
|
||||
the graph and *m* the average amount of connected edges;
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{options, object, optional}
|
||||
An object containing options, see below:
|
||||
|
|
@ -402,7 +412,9 @@ representing the length.
|
|||
The complexity of the function is described
|
||||
[here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{startVertexExample, object, optional}
|
||||
An example for the desired start Vertices
|
||||
|
|
@ -526,7 +538,9 @@ example as parameter for vertexExample.
|
|||
The complexity of the function is described
|
||||
[here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexExample, object, optional}
|
||||
Filter the vertices, see [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -654,7 +668,9 @@ example as parameter for *vertexExample*.
|
|||
The complexity of the function is described
|
||||
[here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexExample, object, optional}
|
||||
Filter the vertices, see [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -790,7 +806,9 @@ of all vertices in the graph.
|
|||
The complexity of the function is described
|
||||
[here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexExample, object, optional}
|
||||
Filter the vertices, see [Definition of examples](#definition-of-examples)
|
||||
|
|
@ -912,7 +930,9 @@ of a graph.
|
|||
The complexity of the function is described
|
||||
[here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{options, object, optional}
|
||||
An object defining further options. Can have the following values:
|
||||
|
|
@ -981,7 +1001,9 @@ of a graph.
|
|||
The complexity of the function is described
|
||||
[here](../Aql/GraphOperations.md#the-complexity-of-the-shortest-path-algorithms).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{options, object, optional}
|
||||
An object defining further options. Can have the following values:
|
||||
|
|
|
|||
|
|
@ -18,7 +18,9 @@ Create a list of edge definitions to construct a graph.
|
|||
The list of edge definitions of a graph can be managed by the graph module itself.
|
||||
This function is the entry point for the management and will return the correct list.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{relationX, object, optional}
|
||||
An object representing a definition of one relation in the graph
|
||||
|
|
@ -49,7 +51,9 @@ Extend the list of edge definitions to construct a graph.
|
|||
In order to add more edge definitions to the graph before creating
|
||||
this function can be used to add more definitions to the initial list.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeDefinitions, array, required}
|
||||
A list of relation definition objects.
|
||||
|
|
@ -87,7 +91,9 @@ The *toVertexCollections* is an Array of document collections holding the target
|
|||
Relations are only allowed in the direction from any collection in *fromVertexCollections*
|
||||
to any collection in *toVertexCollections*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{relationName, string, required}
|
||||
The name of the edge collection where the edges should be stored.
|
||||
|
|
@ -140,7 +146,9 @@ list of *vertexCollections*. This relation allows the user to store
|
|||
edges in any direction between any pair of vertices within the
|
||||
*vertexCollections*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{relationName, string, required}
|
||||
The name of the edge collection where the edges should be stored.
|
||||
|
|
@ -192,7 +200,9 @@ The *toVertexCollections* is an Array of document collections holding the target
|
|||
Relations are only allowed in the direction from any collection in *fromVertexCollections*
|
||||
to any collection in *toVertexCollections*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{relationName, string, required}
|
||||
The name of the edge collection where the edges should be stored.
|
||||
|
|
@ -235,7 +245,9 @@ Optionally a list of vertex collections can be added, which are not used in any
|
|||
These collections are referred to as orphan collections within this chapter.
|
||||
All collections used within the creation process are created if they do not exist.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{graphName, string, required}
|
||||
Unique identifier of the graph
|
||||
|
|
@ -368,7 +380,9 @@ Get a graph
|
|||
|
||||
A graph can be retrieved by its name.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{graphName, string, required}
|
||||
Unique identifier of the graph
|
||||
|
|
@ -404,7 +418,9 @@ This will automatically drop all collections contained in the graph as
|
|||
long as they are not used within other graphs.
|
||||
To drop the collections, the optional parameter *drop-collections* can be set to *true*.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{graphName, string, required}
|
||||
Unique identifier of the graph
|
||||
|
|
@ -466,7 +482,9 @@ edge definition, it will be removed from the orphanage. If the edge collection o
|
|||
the edge definition to add is already used in the graph or used in a different
|
||||
graph with different *from* and/or *to* collections an error is thrown.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeDefinition, object, required}
|
||||
The relation definition to extend the graph
|
||||
|
|
@ -504,7 +522,9 @@ 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.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeDefinition, object, required}
|
||||
The edge definition to replace the existing edge
|
||||
|
|
@ -540,7 +560,9 @@ Deletes a relation definition defined by the edge collection of a graph. If the
|
|||
collections defined in the edge definition (collection, from, to) are not used
|
||||
in another edge definition of the graph, they will be moved to the orphanage.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeCollectionName, string, required}
|
||||
Name of edge collection in the relation definition.
|
||||
|
|
@ -604,7 +626,9 @@ Adds a vertex collection to the set of orphan collections of the graph. If the
|
|||
collection does not exist, it will be created. If it is already used by any edge
|
||||
definition of the graph, an error will be thrown.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexCollectionName, string, required}
|
||||
Name of vertex collection.
|
||||
|
|
@ -670,7 +694,9 @@ Removes a vertex collection from the graph.
|
|||
Only collections not used in any relation definition can be removed.
|
||||
Optionally the collection can be deleted, if it is not used in any other graph.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexCollectionName, string, required}
|
||||
Name of vertex collection.
|
||||
|
|
@ -712,7 +738,9 @@ Create a new vertex in vertexCollectionName
|
|||
|
||||
`graph.vertexCollectionName.save(data)`
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{data, object, required}
|
||||
JSON data of vertex.
|
||||
|
|
@ -740,7 +768,9 @@ Replaces the data of a vertex in collection vertexCollectionName
|
|||
|
||||
`graph.vertexCollectionName.replace(vertexId, data, options)`
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexId, string, required}
|
||||
*_id* attribute of the vertex
|
||||
|
|
@ -775,7 +805,9 @@ Updates the data of a vertex in collection vertexCollectionName
|
|||
|
||||
`graph.vertexCollectionName.update(vertexId, data, options)`
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexId, string, required}
|
||||
*_id* attribute of the vertex
|
||||
|
|
@ -813,7 +845,9 @@ Removes a vertex in collection *vertexCollectionName*
|
|||
Additionally removes all ingoing and outgoing edges of the vertex recursively
|
||||
(see [edge remove](#remove-an-edge)).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexId, string, required}
|
||||
*_id* attribute of the vertex
|
||||
|
|
@ -849,7 +883,9 @@ Creates an edge from vertex *from* to vertex *to* in collection edgeCollectionNa
|
|||
|
||||
`graph.edgeCollectionName.save(from, to, data, options)`
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{from, string, required}
|
||||
*_id* attribute of the source vertex
|
||||
|
|
@ -900,7 +936,9 @@ Replaces the data of an edge in collection edgeCollectionName
|
|||
|
||||
`graph.edgeCollectionName.replace(edgeId, data, options)`
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeId, string, required}
|
||||
*_id* attribute of the edge
|
||||
|
|
@ -935,7 +973,9 @@ Updates the data of an edge in collection edgeCollectionName
|
|||
|
||||
`graph.edgeCollectionName.update(edgeId, data, options)`
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeId, string, required}
|
||||
*_id* attribute of the edge
|
||||
|
|
@ -972,7 +1012,9 @@ Removes an edge in collection edgeCollectionName
|
|||
|
||||
If this edge is used as a vertex by another edge, the other edge will be removed (recursively).
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{edgeId, string, required}
|
||||
*_id* attribute of the edge
|
||||
|
|
@ -1009,7 +1051,9 @@ Get all connecting edges between 2 groups of vertices defined by the examples
|
|||
The function accepts an id, an example, a list of examples or even an empty
|
||||
example as parameter for vertexExample.
|
||||
|
||||
@PARAMS
|
||||
|
||||
**Parameters**
|
||||
|
||||
|
||||
@PARAM{vertexExample1, object, optional}
|
||||
See [Definition of examples](Functions.md#definition-of-examples)
|
||||
|
|
|
|||
Loading…
Reference in New Issue