1
0
Fork 0

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

This commit is contained in:
jsteemann 2016-05-20 16:04:30 +02:00
commit 4e00a7a72f
25 changed files with 69 additions and 58 deletions

View File

@ -272,7 +272,7 @@ STDDEV_SAMPLE( [ 1, 3, 6, 5, 2 ] ) // 2.0736441353327724
Return the sum of the values in *array*.
- **numArray** (array): an array of numbers, *null* values are ignored
-returns **sum** (number): the total of all values in *numArray*
- returns **sum** (number): the total of all values in *numArray*
```js
SUM( [1, 2, 3, 4] ) // 10

View File

@ -4,5 +4,6 @@ Following you have ArangoDB's HTTP Interface for Documents, Databases, Edges and
There are also some examples provided for every API action.
You may also use the interactive [SWAGGER documentation](http://swagger.io) in the [ArangoDB webinterface](../WebInterface/README.md)
in *Links* -> *API Documentation* to explore the API calls below.
You may also use the interactive [Swagger documentation](http://swagger.io) in the
[ArangoDB webinterface](../../Users/GettingStarted/WebInterface.html)
to explore the API calls below.

View File

@ -7,7 +7,7 @@ user functions. AQL user functions are a means to extend the functionality
of ArangoDB's query language (AQL) with user-defined JavaScript code.
For an overview of how AQL user functions work, please refer to
[Extending Aql](../AqlExtending/README.md).
[Extending Aql](../../AQL/Extending/index.html).
The HTTP interface provides an API for adding, deleting, and listing
previously registered AQL user functions.

View File

@ -202,7 +202,8 @@ Content-length: 53
Please note that the database used for all part operations of a batch
request is determined by scanning the original URL (the URL that contains
*/_api/batch*). It is not possible to override the [database name](../Glossary/README.md#database-name) in
*/_api/batch*). It is not possible to override the
[database name](../../Users/Appendix/Glossary.html#database-name) in
part operations of a batch. When doing so, any other database name used
in a batch part will be ignored.

View File

@ -36,6 +36,7 @@ errors occurred.
!SECTION Importing into Edge Collections
Please note that when importing documents into an [edge collection](../Glossary/README.md#edge-collection),
Please note that when importing documents into an
[edge collection](../../Users/Appendix/Glossary.html#edge-collection),
it is mandatory that all imported documents contain the *_from* and *_to* attributes,
and that these contain references to existing collections.

View File

@ -7,7 +7,8 @@ This is an introduction to ArangoDB's HTTP interface for collections.
!SUBSUBSECTION Collection
A collection consists of documents. It is uniquely identified by its
[collection identifier](../Glossary/README.md#collection-identifier). It also has a unique name that clients should
[collection identifier](../../Users/Appendix/Glossary.html#collection-identifier).
It also has a unique name that clients should
use to identify and access it. Collections can be renamed. This will
change the collection name, but not the collection identifier.
Collections have a type that is specified by the user when the collection

View File

@ -1,8 +1,8 @@
!CHAPTER Database-to-Endpoint Mapping
If a [database name](../Glossary/README.md#database-name) is present in the URI as above, ArangoDB will consult the database-to-endpoint
mapping for the current endpoint, and validate if access to the database is allowed on the
endpoint.
If a [database name](../../Users/Appendix/Glossary.html#database-name) is present in the
URI as above, ArangoDB will consult the database-to-endpoint mapping for the current
endpoint, and validate if access to the database is allowed on the endpoint.
If the endpoint is not restricted to an array of databases, ArangoDB will continue with the
regular authentication procedure. If the endpoint is restricted to an array of specified databases,
ArangoDB will check if the requested database is in the array. If not, the request will be turned

View File

@ -15,7 +15,7 @@ applications until they are explicitly installed for the particular database.
ArangoDB can handle multiple databases in the same server instance. Databases can be used to logically group and separate data. An ArangoDB database consists of collections and dedicated database-specific worker processes.
A database contains its own collections (which cannot be accessed from other databases), Foxx applications and replication loggers and appliers. Each ArangoDB database contains its own system collections (e.g. _users, _graphs, ...).
There will always be at least one database in ArangoDB. This is the default [database name](../Glossary/README.md#database-name)d _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.
There will always be at least one database in ArangoDB. This is the default [database name](../../Users/Appendix/Glossary.html#database-name)d _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 determined by the algorithm described in Database-to-Endpoint Mapping .

View File

@ -4,7 +4,7 @@
Any operation triggered via ArangoDB's HTTP REST API is executed in the context of exactly
one database. To explicitly specify the database in a request, the request URI must contain
the [database name](../Glossary/README.md#database-name) in front of the actual path:
the [database name](../../Users/Appendix/Glossary.html#database-name) in front of the actual path:
http://localhost:8529/_db/mydb/...

View File

@ -1,6 +1,6 @@
!CHAPTER Address and ETag of an Edge
All documents in ArangoDB have a [document handle](../Glossary/README.md#document-handle). This handle uniquely identifies
All documents in ArangoDB have a [document handle](../../Users/Appendix/Glossary.html#document-handle). This handle uniquely identifies
a document. Any document can be retrieved using its unique URI:
http://server:port/_api/document/<document-handle>
@ -15,7 +15,7 @@ attribute of the edge, is *demo/362549736*, then the URL of that edge is:
http://localhost:8529/_api/document/demo/362549736
The above URL scheme does not specify a [database name](../Glossary/README.md#database-name) explicitly, so the
The above URL scheme does not specify a [database name](../../Users/Appendix/Glossary.html#database-name) explicitly, so the
default database will be used. To explicitly specify the database context, use
the following URL schema:

View File

@ -1,6 +1,6 @@
!CHAPTER HTTP Interface for Edges
This is an introduction to ArangoDB's [REST interface for edges](../Edges/README.md).
This is an introduction to ArangoDB's [REST interface for edges](../../Users/Graphs/Edges/index.html).
ArangoDB offers [graph functionality](../Graphs/README.md); Edges are one part of that.
ArangoDB offers [graph functionality](../../Users/Graphs/index.html); Edges are one part of that.

View File

@ -1,6 +1,6 @@
!CHAPTER Working with Edges using REST
This is documentation to ArangoDB's [REST interface for edges](../Edges/README.md).
This is documentation to ArangoDB's [REST interface for edges](../../Users/Graphs/Edges/index.html).
<!-- arangod/RestHandler/RestEdgeHandler.cpp -->
@startDocuBlock API_EDGE_READ

View File

@ -76,7 +76,7 @@ response to the client instantly and thus finish this HTTP-request.
The server will execute the tasks from the queue asynchronously as fast
as possible, while clients can continue to do other work.
If the server queue is full (i.e. contains as many tasks as specified by the
option ["--scheduler.maximal-queue-size"](../ConfigureArango/Communication.md),
option ["--scheduler.maximal-queue-size"](../../Users/Administration/Configuration/Communication.html),
then the request will be rejected instantly with an *HTTP 500* (internal
server error) response.
@ -108,7 +108,7 @@ Client authentication can be achieved by using the *Authorization* HTTP header i
client requests. ArangoDB supports HTTP Basic authentication.
Authentication is optional. To enforce authentication for incoming requested,
the server must be started with the option [--server.disable-authentication](../ConfigureArango/Arangod.md).
the server must be started with the option [--server.disable-authentication](../../Users/Administration/Configuration/Arangod.html).
Please note that requests using the HTTP OPTIONS method will be answered by
ArangoDB in any case, even if no authentication data is sent by the client or if
the authentication data is wrong. This is required for handling CORS preflight
@ -118,7 +118,7 @@ will be generic and not expose any private data.
Please note that when authentication is turned on in ArangoDB, it will by
default affect all incoming requests.
There is an additional option [-server.authenticate-system-only](../ConfigureArango/Arangod.md)
There is an additional option [-server.authenticate-system-only](../../Users/Administration/Configuration/Arangod.html)
"--server.authenticate-system-only" to restrict authentication to requests to the ArangoDB
internal APIs and the admin interface.
This option can be used to expose a public API built with ArangoDB to the outside

View File

@ -1,16 +1,17 @@
!CHAPTER Handling Edges
Examples will explain the REST API for [manipulating edges](../GeneralGraphs/Functions.md) of the [graph module](../Graphs/README.md) on the [knows graph](../Graphs/README.md#the-knowsgraph):
Examples will explain the REST API for [manipulating edges](../../Users/Graphs/GeneralGraphs/Functions.html)
of the [graph module](../../Users/Graphs/index.html) on the [knows graph](../../Users/Graphs/index.html#the-knowsgraph):
![Social Example Graph](../Graphs/knows_graph.png)
![Social Example Graph](../../Users/Graphs/knows_graph.png)
@startDocuBlock JSF_general_graph_edge_create_http_examples
@startDocuBlock JSF_general_graph_edge_get_http_examples
Examples will explain the API on the [social graph](../Graphs/README.md#the-social-graph):
Examples will explain the API on the [social graph](../../Users/Graphs/index.html#the-social-graph):
![Social Example Graph](../Graphs/social_graph.png)
![Social Example Graph](../../Users/Graphs/social_graph.png)
@startDocuBlock JSF_general_graph_edge_modify_http_examples

View File

@ -1,9 +1,9 @@
!CHAPTER Manage your graphs
The [graph module](../Graphs/README.md) provides functions dealing with graph structures.
Examples will explain the REST API on the [social graph](../Graphs/README.md#the-social-graph):
The [graph module](../../Users/Graphs/index.html) provides functions dealing with graph structures.
Examples will explain the REST API on the [social graph](../../Users/Graphs/index.html#the-social-graph):
![Social Example Graph](../Graphs/social_graph.png)
![Social Example Graph](../../Users/Graphs/social_graph.png)
@startDocuBlock JSF_general_graph_list_http_examples
@startDocuBlock JSF_general_graph_create_http_examples

View File

@ -1,5 +1,5 @@
!CHAPTER General Graphs
This chapter describes the REST interface for the [multi-collection graph module](../Graphs/README.md).
This chapter describes the REST interface for the [multi-collection graph module](../../Users/Graphs/index.html).
It allows you to define a graph that is spread across several edge and document collections.
There is no need to include the referenced collections within the query, this module will handle it for you.

View File

@ -1,8 +1,9 @@
!CHAPTER Handling Vertices
Examples will explain the REST API to the [graph module](../Graphs/README.md) on the [social graph](../Graphs/README.md#the-social-graph):
Examples will explain the REST API to the [graph module](../../Users/Graphs/index.html)
on the [social graph](../../Users/Graphs/index.html#the-social-graph):
![Social Example Graph](../Graphs/social_graph.png)
![Social Example Graph](../../Users/Graphs/social_graph.png)
@startDocuBlock JSF_general_graph_vertex_create_http_examples
@startDocuBlock JSF_general_graph_vertex_get_http_examples

View File

@ -1,6 +1,7 @@
!CHAPTER Fulltext
If a [fulltext index](../Glossary/README.md#fulltext-index) exists, then /_api/simple/fulltext will use this index to execute the specified fulltext query.
If a [fulltext index](../../Users/Glossary/index.html#fulltext-index) exists, then
/_api/simple/fulltext will use this index to execute the specified fulltext query.
<!-- js/actions/api-index.js -->
@startDocuBlock JSF_post_api_index_fulltext

View File

@ -7,8 +7,8 @@ general. There are special sections for various index types.
!SUBSUBSECTION 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](../Glossary/README.md#document-key) (_key attribute). This index cannot be dropped or changed.
[edge collections](../Glossary/README.md#edge-collection) 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.
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](../../Users/Glossary/index.html#document-key) (_key attribute). This index cannot be dropped or changed.
[edge collections](../../Users/Glossary/index.html#edge-collection) 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.
Most user-land indexes can be created by defining the names of the attributes which should be indexed. Some index types allow indexing just one attribute (e.g. fulltext index) whereas other index types allow indexing multiple attributes.

View File

@ -4,7 +4,7 @@
This is an introduction to ArangoDB's HTTP replication interface.
The replication architecture and components are described in more details in
[Replication](../Replication/README.md).
[Replication](../../Users/Administration/Replication/index.html).
The HTTP replication interface serves four main purposes:
- fetch initial data from a server (e.g. for a backup, or for the initial synchronization

View File

@ -6,13 +6,21 @@
* [To-Endpoint](Database/DatabaseEndpoint.md)
* [Management](Database/DatabaseManagement.md)
* [Notes on Databases](Database/NotesOnDatabases.md)
* [Collections](Collection/README.md)
* [Creating](Collection/Creating.md)
* [Getting Information](Collection/Getting.md)
* [Modifying](Collection/Modifying.md)
* [Documents](Document/README.md)
* [Basics and Terminology](Document/AddressAndEtag.md)
* [Working with Documents](Document/WorkingWithDocuments.md)
* [Edges](Edge/README.md)
* [Address and ETag](Edge/AddressAndEtag.md)
* [Working with Edges](Edge/WorkingWithEdges.md)
* [Exporting data](Export/README.md)
* [General Graph](Gharial/README.md)
* [Management](Gharial/Management.md)
* [Vertices](Gharial/Vertices.md)
* [Edges](Gharial/Edges.md)
* [Traversals](Traversal/README.md)
* [AQL Query Cursors](AqlQueryCursor/README.md)
* [Query Results](AqlQueryCursor/QueryResults.md)
* [Accessing Cursors](AqlQueryCursor/AccessingCursors.md)
@ -20,10 +28,12 @@
* [AQL Query Cache](AqlQueryCache/README.md)
* [AQL User Functions Management](AqlUserFunctions/README.md)
* [Simple Queries](SimpleQuery/README.md)
* [Collections](Collection/README.md)
* [Creating](Collection/Creating.md)
* [Getting Information](Collection/Getting.md)
* [Modifying](Collection/Modifying.md)
* [Async Result Handling](AsyncResultsManagement/README.md)
* [Bulk Import / Export](BulkImports/README.md)
* [JSON Documents](BulkImports/ImportingSelfContained.md)
* [Headers & Values](BulkImports/ImportingHeadersAndValues.md)
* [Batch Requests](BatchRequest/README.md)
* [Exporting data](Export/README.md)
* [Indexes](Indexes/README.md)
* [Working with Indexes](Indexes/WorkingWith.md)
* [Hash](Indexes/Hash.md)
@ -31,24 +41,14 @@
* [Geo](Indexes/Geo.md)
* [Fulltext](Indexes/Fulltext.md)
* [Transactions](Transaction/README.md)
* [General Graph](Gharial/README.md)
* [Management](Gharial/Management.md)
* [Vertices](Gharial/Vertices.md)
* [Edges](Gharial/Edges.md)
* [Traversals](Traversal/README.md)
* [Replication](Replications/README.md)
* [Replication Dump](Replications/ReplicationDump.md)
* [Replication Logger](Replications/ReplicationLogger.md)
* [Replication Applier](Replications/ReplicationApplier.md)
* [Other Replication Commands](Replications/OtherReplication.md)
* [Tasks](Tasks/README.md)
* [Monitoring](AdministrationAndMonitoring/README.md)
* [User Management](UserManagement/README.md)
* [Async Result Handling](AsyncResultsManagement/README.md)
* [Endpoints](Endpoints/README.md)
* [Sharding](ShardingInterface/README.md)
* [Monitoring](AdministrationAndMonitoring/README.md)
* [Endpoints](Endpoints/README.md)
* [User Management](UserManagement/README.md)
* [Tasks](Tasks/README.md)
* [Miscellaneous functions](MiscellaneousFunctions/README.md)
* [Bulk Import / Export](BulkImports/README.md)
* [JSON Documents](BulkImports/ImportingSelfContained.md)
* [Headers & Values](BulkImports/ImportingHeadersAndValues.md)
* [Batch Requests](BatchRequest/README.md)

View File

@ -16,7 +16,7 @@ during transaction execution, all operations performed in the transaction are
rolled back.
For a more detailed description of how transactions work in ArangoDB please
refer to [Transactions](../Transactions/README.md).
refer to [Transactions](../../Users/Transactions/index.html).
<!-- js/actions/api-transaction.js -->
@startDocuBlock JSF_post_api_transaction

View File

@ -7,7 +7,7 @@ initiated by clients by sending the traversal description for execution to
the server.
Traversals in ArangoDB are used to walk over a graph
stored in one [edge collection](../Glossary/README.md#edge-collection). It can easily be described
stored in one [edge collection](../../Users/Appendix/Glossary.html#edge-collection). It can easily be described
which edges of the graph should be followed and which actions
should be performed on each visited vertex.
Furthermore the ordering of visiting the nodes can be
@ -20,4 +20,4 @@ are offered.
All examples were using this graph:
![Persons relation Example Graph](../Graphs/knows_graph.png)
![Persons relation Example Graph](../../Graphs/knows_graph.png)

View File

@ -4,6 +4,10 @@
@RESTHEADER{POST /_api/query, Parse an AQL query}
@RESTDESCRIPTION
This endpoint is for query validation only. To actually query the database,
see `/api/cursor`.
@RESTBODYPARAM{query,string,required,string}
To validate a query string without executing it, the query string can be
passed to the server via an HTTP POST request.

View File

@ -165,7 +165,7 @@ macro (install_command_alias name where alias)
${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$(Configuration)/${alias}.exe)
install(
PROGRAMS ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$(Configuration)/${alias}.exe
RUNTIME DESTINATION ${where})
DESTINATION ${where})
else ()
add_custom_command(
TARGET ${name}
@ -174,7 +174,7 @@ macro (install_command_alias name where alias)
${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${alias})
install(
PROGRAMS ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${alias}
RUNTIME DESTINATION ${where})
DESTINATION ${where})
endif ()
endmacro ()