mirror of https://gitee.com/bigwinds/arangodb
Merge branch '2.3' of https://github.com/triAGENS/ArangoDB into 2.3
This commit is contained in:
commit
cd6dc2a13d
|
@ -192,7 +192,7 @@ is a list of warnings that occurred during optimization or execution plan creati
|
|||
|
||||
Each plan in the result is an object with the following attributes:
|
||||
- *nodes*: the list of execution nodes of the plan. The list of available node types
|
||||
can be found [here](.../Aql/Optimizer.html)
|
||||
can be found [here](../Aql/Optimizer.html)
|
||||
- *estimatedCost*: the total estimated cost for the plan. If there are multiple
|
||||
plans, the optimizer will choose the plan with the lowest total cost.
|
||||
- *collections*: a list of collections used in the query
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
!CHAPTER Edge Methods
|
||||
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
`edge.getId()`
|
||||
|
||||
Returns the identifier of the edge.
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
!CHAPTER Graph Constructors and Methods
|
||||
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
The graph module provides basic functions dealing with graph structures. The
|
||||
examples assume
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER Graphs
|
||||
|
||||
**Warning: Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
This module is deprecated and will be removed soon.
|
||||
Please use [General Graphs](../General-Graphs/README.md) instead.
|
||||
|
|
|
@ -1,5 +1,7 @@
|
|||
!CHAPTER Vertex Methods
|
||||
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
`vertex.addInEdge( peer, id)`
|
||||
|
||||
Creates a new edge from peer to vertex and returns the edge object. The identifier id must be a unique identifier or null.
|
||||
|
|
|
@ -4,9 +4,8 @@
|
|||
|
||||
A collection consists of documents. It is uniquely identified by its collection identifier.
|
||||
It also has a unique name that clients should use to identify and access it.
|
||||
Collections can be renamed. is will change the collection name, but not the collection identifier.
|
||||
Collections have a type that is specified by the user when the collection is created.
|
||||
There are currently two types: document and edge. The default type is document.
|
||||
Collections can be renamed. It will change the collection name, but not the collection identifier.
|
||||
Collections contain documents of a specific type. There are currently two types: document (default) and edge. The type is specified by the user when the collection is created, and cannot be changed later.
|
||||
|
||||
!SUBSECTION Collection Identifier
|
||||
|
||||
|
@ -15,7 +14,6 @@ A collection identifier identifies a collection in a database. It is a string va
|
|||
ArangoDB currently uses 64bit unsigned integer values to maintain collection ids internally. When returning collection ids to clients, ArangoDB will put them into a string to ensure the collection id is not clipped by clients that do not support big integers. Clients should treat the collection ids returned by ArangoDB as
|
||||
opaque strings when they store or use it locally.
|
||||
|
||||
|
||||
!SUBSECTION Collection Name
|
||||
|
||||
A collection name identifies a collection in a database. It is a string and is unique within the database. Unlike the collection identifier it is supplied by the creator of the collection. The collection name must consist of letters, digits, and the _ (underscore) and - (dash) characters only. Please refer to [NamingConventions](../NamingConventions/CollectionNames.html) for more information on valid collection names.
|
||||
|
@ -28,7 +26,7 @@ A database contains its own collections (which cannot be accessed from other dat
|
|||
|
||||
There will always be at least one database in ArangoDB. This is the default database, named _system. This database cannot be dropped, and provides special operations for creating, dropping, and enumerating databases. Users can create additional databases and give them unique names to access them later. Database management operations cannot be initiated from out of user-defined databases.
|
||||
|
||||
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. /_db/_system/...). If the request URI does not contain a database name, the database name is automatically.
|
||||
When ArangoDB is accessed via its HTTP REST API, the database name is read from the first part of the request URI path (e.g. /_db/_system/...). If the request URI does not contain a database name, the database name is automatically derived from the endpoint. Please refer to [DatabaseEndpoint](../HttpDatabase/DatabaseEndpoint.html) for more information.
|
||||
|
||||
!SUBSECTION Database Name
|
||||
|
||||
|
@ -101,17 +99,17 @@ ArangoDB currently uses 64bit unsigned integer values to maintain document revis
|
|||
|
||||
!SUBSECTION Edge
|
||||
|
||||
Edges in ArangoDB are special documents. In addition to the internal attributes _key, _id and _rev, they have two attributes _from and _to, which contain document handles, namely the start-point and the end-point of the edge.
|
||||
Edges are special documents used for connecting other documents into a graph. An edge describe the connection between two documents using the internal attributes: _from and _to. These contain document handles, namely the start-point and the end-point of the edge.
|
||||
|
||||
The values of _from and _to are immutable once saved.
|
||||
|
||||
!SUBSECTION Edge Collection
|
||||
|
||||
Edge collections are special collection that store edge documents. Edge documents are connection documents that reference other documents. The type of a collection must be specified when a collection is created and cannot be changed afterwards.
|
||||
Edge collections are collections that store edges.
|
||||
|
||||
!SUBSECTION Index
|
||||
|
||||
Indexes are used to allow fast access to documents. For each collection there is always the primary index which is a hash index for the document key (_key attribute). This index cannot be dropped or changed.
|
||||
Indexes are used to allow fast access to documents in a collection. All collections have a primary index, which is the document's _key attribute. This index cannot be dropped or changed.
|
||||
|
||||
Edge collections will also have an automatically created edges index, which cannot be modified. This index provides quick access to documents via the _from and _to attributes.
|
||||
|
||||
|
@ -145,4 +143,4 @@ If the index is declared unique, then access to the indexed attributes should be
|
|||
|
||||
!SUBSECTION Skiplist Index
|
||||
|
||||
A skiplist is used to find ranges of documents.
|
||||
A skiplist is used to find ranges of documents.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER Edge
|
||||
|
||||
**Warning Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
`POST /_api/graph/graph-name/edge-name`*(create edge)*
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER HTTP Interface for Graphs
|
||||
|
||||
**Warning Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
This api is deprecated and will be removed soon.
|
||||
Please use [General Graphs](../HttpGharial/README.md) instead.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER Vertex
|
||||
|
||||
**Warning Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
`POST /_api/graph/graph-name/vertex-name`*(create vertex)*
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER Edge Methods
|
||||
|
||||
**Warning Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
`edge.getId()`
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER Graph Constructors and Methods
|
||||
|
||||
**Warning Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
The graph module provides basic functions dealing with graph structures. The
|
||||
examples assume
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER Module "graph"
|
||||
|
||||
**Warning: Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
!SUBSECTION First Steps with Graphs
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
!CHAPTER Vertex Methods
|
||||
|
||||
**Warning Deprecated**
|
||||
**Warning: This Chapter is Deprecated**
|
||||
|
||||
`vertex.addInEdge( peer, id)`
|
||||
|
||||
|
|
|
@ -137,7 +137,6 @@
|
|||
* [Example Setup](Replication/ExampleSetup.md)
|
||||
* [Replication Limitations](Replication/Limitations.md)
|
||||
* [Replication Overhead](Replication/Overhead.md)
|
||||
* [Replication Events](Replication/Events.md)
|
||||
<!-- 19 -->
|
||||
* [Sharding](Sharding/README.md)
|
||||
* [How to try it out](Sharding/HowTo.md)
|
||||
|
|
|
@ -1643,7 +1643,7 @@ static v8::Handle<v8::Value> CreateVocBase (v8::Arguments const& argv,
|
|||
/// a document will only return after the data was synced to disk.
|
||||
///
|
||||
/// * *journalSize* (optional, default is a
|
||||
/// [configuration parameter](../CommandLineOptions/Arangod.md): The maximal
|
||||
/// 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.
|
||||
///
|
||||
|
|
|
@ -86,7 +86,7 @@ var ERRORS = require("internal").errors;
|
|||
///
|
||||
/// Each plan in the result is a JSON object with the following attributes:
|
||||
/// - *nodes*: the list of execution nodes of the plan. The list of available node types
|
||||
/// can be found [here](.../Aql/Optimizer.html)
|
||||
/// can be found [here](../Aql/Optimizer.html)
|
||||
///
|
||||
/// - *estimatedCost*: the total estimated cost for the plan. If there are multiple
|
||||
/// plans, the optimizer will choose the plan with the lowest total cost.
|
||||
|
|
|
@ -5645,7 +5645,7 @@ function AQL_GRAPH_DISTANCE_TO (graphName,
|
|||
/// * *connectName* : The result attribute which
|
||||
/// contains the connection.
|
||||
/// * *options* (optional) : An object containing options, see
|
||||
/// [Graph Traversals](../AQL/GraphOperations.html#graph_traversal):
|
||||
/// [Graph Traversals](../Aql/GraphOperations.html#graph_traversal):
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
|
|
|
@ -919,13 +919,13 @@ function Kickstarter (clusterPlan, myname) {
|
|||
/// itself. We do not go into details here about the data structure,
|
||||
/// but the most important information are the process IDs of the
|
||||
/// started processes. The corresponding
|
||||
/// [shutdown method](see ../ModulePlanner/README.html#shutdown) needs this information to
|
||||
/// shut down all processes.
|
||||
/// [see shutdown method](../ModulePlanner/README.html#shutdown) needs this
|
||||
/// information to shut down all processes.
|
||||
///
|
||||
/// Note that all data in the DBservers and all log files and all agency
|
||||
/// information in the cluster is deleted by this call. This is because
|
||||
/// it is intended to set up a cluster for the first time. See
|
||||
/// the [relaunch method](see ../ModulePlanner/README.html#relaunch)
|
||||
/// the [relaunch method](../ModulePlanner/README.html#relaunch)
|
||||
/// for restarting a cluster without data loss.
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
@ -1014,12 +1014,12 @@ Kickstarter.prototype.launch = function () {
|
|||
/// itself. We do not go into details here about the data structure,
|
||||
/// but the most important information are the process IDs of the
|
||||
/// started processes. The corresponding
|
||||
/// [shutdown method ](see ../ModulePlanner/README.html#shutdown) needs this information to
|
||||
/// [shutdown method ](../ModulePlanner/README.html#shutdown) needs this information to
|
||||
/// shut down all processes.
|
||||
///
|
||||
/// Note that this methods needs that all data in the DBservers and the
|
||||
/// agency information in the cluster are already set up properly. See
|
||||
/// the [launch method](see ../ModulePlanner/README.html#launch) for
|
||||
/// the [launch method](../ModulePlanner/README.html#launch) for
|
||||
/// starting a cluster for the first time.
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
@ -1188,7 +1188,7 @@ Kickstarter.prototype.shutdown = function() {
|
|||
///
|
||||
/// This cleans up all the data and logs of a previously shut down cluster.
|
||||
/// To this end, other dispatchers are contacted as necessary.
|
||||
/// [Use shutdown](see ../ModulePlanner/README.html#shutdown) first and
|
||||
/// [Use shutdown](../ModulePlanner/README.html#shutdown) first and
|
||||
/// use with caution, since potentially a lot of data is being erased with
|
||||
/// this call!
|
||||
/// @endDocuBlock
|
||||
|
@ -1361,12 +1361,12 @@ Kickstarter.prototype.isHealthy = function() {
|
|||
/// itself. We do not go into details here about the data structure,
|
||||
/// but the most important information are the process IDs of the
|
||||
/// started processes. The corresponding
|
||||
/// [shutdown method](see ../ModulePlanner/README.html#shutdown) needs
|
||||
/// [shutdown method](../ModulePlanner/README.html#shutdown) needs
|
||||
/// this information to shut down all processes.
|
||||
///
|
||||
/// Note that this methods needs that all data in the DBservers and the
|
||||
/// agency information in the cluster are already set up properly. See
|
||||
/// the [launch method](see ../ModulePlanner/README.html#launch) for
|
||||
/// the [launch method](../ModulePlanner/README.html#launch) for
|
||||
/// starting a cluster for the first time.
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
|
|
@ -435,7 +435,7 @@ extend(RequestContext.prototype, {
|
|||
/// return an array of models.
|
||||
///
|
||||
/// The behavior of *bodyParam* changes depending on the *rootElement* option
|
||||
/// set in the [manifest](../FoxxManifest.md). If it is set to true, it is
|
||||
/// set in the [manifest](../Foxx/FoxxManifest.md). If it is set to true, it is
|
||||
/// expected that the body is an
|
||||
/// object with a key of the same name as the *paramName* argument.
|
||||
/// The value of this object is either a single object or in the case of a multi
|
||||
|
|
Loading…
Reference in New Issue