mirror of https://gitee.com/bigwinds/arangodb
release version 1.4.9
This commit is contained in:
Frank Celler
parent
f2aa3254b8
commit
0bc50d9d10
147
CHANGELOG
147
CHANGELOG
|
|
@ -1,149 +1,4 @@
|
|||
v1.5.0 (XXXX-XX-XX)
|
||||
-------------------
|
||||
|
||||
* added SHORTEST_PATH AQL function
|
||||
|
||||
this calculates the shortest paths between two vertices, using the Dijkstra
|
||||
algorithm, employing a min-heap
|
||||
|
||||
By default, ArangoDB does not know the distance between any two vertices and
|
||||
will use a default distance of 1. A custom distance function can be registered
|
||||
as an AQL user function to make the distance calculation use any document
|
||||
attributes or custom logic:
|
||||
|
||||
RETURN SHORTEST_PATH(cities, motorways, "cities/CGN", "cities/MUC", "outbound", {
|
||||
paths: true,
|
||||
distance: "myfunctions::citydistance"
|
||||
})
|
||||
|
||||
// using the following custom distance function
|
||||
var aqlfunctions = require("org/arangodb/aql/functions");
|
||||
aqlfunctions.register("myfunctions::distance", function (config, vertex1, vertex2, edge) {
|
||||
return Math.sqrt(Math.pow(vertex1.x - vertex2.x) + Math.pow(vertex1.y - vertex2.y));
|
||||
}, false);
|
||||
|
||||
* issue #751: Create database through API should return HTTP status code 201
|
||||
|
||||
By default, the server now returns HTTP 201 (created) when creating a new
|
||||
database successfully. To keep compatibility with older ArangoDB versions, the
|
||||
startup parameter `--server.default-api-compatibility` can be set to a value
|
||||
of `10400` to indicate API compatibility with ArangoDB 1.4. The compatibility
|
||||
can also be enforced by setting the `X-Arango-Version` HTTP header in a
|
||||
client request to this API on a per-request basis.
|
||||
|
||||
* allow direct access from the `db` object to collections whose names start
|
||||
with an underscore (e.g. db._users).
|
||||
|
||||
Previously, access to such collections via the `db` object was possible from
|
||||
arangosh, but not from arangod (and thus Foxx and actions). The only way
|
||||
to access such collections from these places was via the `db._collection(<name>)`
|
||||
workaround.
|
||||
|
||||
* allow `\n` (as well as `\r\n`) as line terminator in batch requests sent to
|
||||
`/_api/batch` HTTP API.
|
||||
|
||||
* use `--data-binary` instead of `--data` parameter in generated cURL examples
|
||||
|
||||
* issue #703: Also show path of logfile for fm.config()
|
||||
|
||||
* issue #675: Dropping a collection used in "graph" module breaks the graph
|
||||
|
||||
* added "static" Graph.drop() method for graphs API
|
||||
|
||||
* fixed issue #695: arangosh server.password error
|
||||
|
||||
* use pretty-printing in `--console` mode by defaul
|
||||
|
||||
* added `check-server` binary for testing
|
||||
|
||||
* simplified ArangoDB startup options
|
||||
|
||||
Some startup options are now superfluous or their usage is simplified. The
|
||||
following options have been changed:
|
||||
|
||||
* `--javascript.modules-path`: this option has been removed. The modules paths
|
||||
are determined by arangod and arangosh automatically based on the value of
|
||||
`--javascript.startup-directory`.
|
||||
|
||||
If the option is set on startup, it is ignored so startup will not abort with
|
||||
an error `unrecognized option`.
|
||||
|
||||
* `--javascript.action-directory`: this option has been removed. The actions
|
||||
directory is determined by arangod automatically based on the value of
|
||||
`--javascript.startup-directory`.
|
||||
|
||||
If the option is set on startup, it is ignored so startup will not abort with
|
||||
an error `unrecognized option`.
|
||||
|
||||
* `--javascript.package-path`: this option is still available but it is not
|
||||
required anymore to set the standard package paths (e.g. `js/npm`). arangod
|
||||
will automatically use this standard package path regardless of whether it
|
||||
was specified via the options.
|
||||
|
||||
It is possible to use this option to add additional package paths to the
|
||||
standard value.
|
||||
|
||||
Configuration files included with arangod are adjusted accordingly.
|
||||
|
||||
* layout of the graphs tab adapted to better fit with the other tabs
|
||||
|
||||
* database selection is moved to the bottom right corner of the web interface
|
||||
|
||||
* removed priority queues
|
||||
|
||||
this feature was never advertised nor documented nor tested.
|
||||
|
||||
* display internal attributes in document source view of web interface
|
||||
|
||||
* removed separate shape collections
|
||||
|
||||
When upgrading to ArangoDB 1.5, existing collections will be converted to include
|
||||
shapes and attribute markers in the datafiles instead of using separate files for
|
||||
shapes.
|
||||
|
||||
When a collection is converted, existing shapes from the SHAPES directory will
|
||||
be written to a new datafile in the collection directory, and the SHAPES directory
|
||||
will be removed afterwards.
|
||||
|
||||
This saves up to 2 MB of memory and disk space for each collection
|
||||
(savings are higher, the less different shapes there are in a collection).
|
||||
Additionally, one less file descriptor per opened collection will be used.
|
||||
|
||||
When creating a new collection, the amount of sync calls may be reduced. The same
|
||||
may be true for documents with yet-unknown shapes. This may help performance
|
||||
in these cases.
|
||||
|
||||
* added AQL functions `NTH` and `POSITION`
|
||||
|
||||
* added signal handler for arangosh to save last command in more cases
|
||||
|
||||
* added extra prompt placeholders for arangosh:
|
||||
- `%e`: current endpoint
|
||||
- `%u`: current user
|
||||
|
||||
* added arangosh option `--javascript.gc-interval` to control amount of
|
||||
garbage collection performed by arangosh
|
||||
|
||||
* fixed issue #651: Allow addEdge() to take vertex ids in the JS library
|
||||
|
||||
* removed command-line option `--log.format`
|
||||
|
||||
In previous versions, this option did not have an effect for most log messages, so
|
||||
it got removed.
|
||||
|
||||
* removed C++ logger implementation
|
||||
|
||||
Logging inside ArangoDB is now done using the LOG_XXX() macros. The LOGGER_XXX()
|
||||
macros are gone.
|
||||
|
||||
* added collection status "loading"
|
||||
|
||||
* added the option to return the number of elements indexed to the
|
||||
result of <collection>.getIndexes() for each index. This is
|
||||
currently only implemented for hash indices and skiplist indices.
|
||||
|
||||
|
||||
v1.4.9 (XXXX-XX-XX)
|
||||
v1.4.9 (2014-02-07)
|
||||
-------------------
|
||||
|
||||
* return a document's current etag in response header for HTTP HEAD requests on
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
#! /bin/sh
|
||||
# Guess values for system-dependent variables and create Makefiles.
|
||||
# Generated by GNU Autoconf 2.69 for triAGENS ArangoDB 1.4.8.
|
||||
# Generated by GNU Autoconf 2.69 for triAGENS ArangoDB 1.4.9.
|
||||
#
|
||||
# Report bugs to <info@triagens.de>.
|
||||
#
|
||||
|
|
@ -580,8 +580,8 @@ MAKEFLAGS=
|
|||
# Identity of this package.
|
||||
PACKAGE_NAME='triAGENS ArangoDB'
|
||||
PACKAGE_TARNAME='arangodb'
|
||||
PACKAGE_VERSION='1.4.8'
|
||||
PACKAGE_STRING='triAGENS ArangoDB 1.4.8'
|
||||
PACKAGE_VERSION='1.4.9'
|
||||
PACKAGE_STRING='triAGENS ArangoDB 1.4.9'
|
||||
PACKAGE_BUGREPORT='info@triagens.de'
|
||||
PACKAGE_URL='http://www.arangodb.org'
|
||||
|
||||
|
|
@ -1403,7 +1403,7 @@ if test "$ac_init_help" = "long"; then
|
|||
# Omit some internal or obsolete options to make the list less imposing.
|
||||
# This message is too long to be a string in the A/UX 3.1 sh.
|
||||
cat <<_ACEOF
|
||||
\`configure' configures triAGENS ArangoDB 1.4.8 to adapt to many kinds of systems.
|
||||
\`configure' configures triAGENS ArangoDB 1.4.9 to adapt to many kinds of systems.
|
||||
|
||||
Usage: $0 [OPTION]... [VAR=VALUE]...
|
||||
|
||||
|
|
@ -1474,7 +1474,7 @@ fi
|
|||
|
||||
if test -n "$ac_init_help"; then
|
||||
case $ac_init_help in
|
||||
short | recursive ) echo "Configuration of triAGENS ArangoDB 1.4.8:";;
|
||||
short | recursive ) echo "Configuration of triAGENS ArangoDB 1.4.9:";;
|
||||
esac
|
||||
cat <<\_ACEOF
|
||||
|
||||
|
|
@ -1605,7 +1605,7 @@ fi
|
|||
test -n "$ac_init_help" && exit $ac_status
|
||||
if $ac_init_version; then
|
||||
cat <<\_ACEOF
|
||||
triAGENS ArangoDB configure 1.4.8
|
||||
triAGENS ArangoDB configure 1.4.9
|
||||
generated by GNU Autoconf 2.69
|
||||
|
||||
Copyright (C) 2012 Free Software Foundation, Inc.
|
||||
|
|
@ -2070,7 +2070,7 @@ cat >config.log <<_ACEOF
|
|||
This file contains any messages produced by compilers while
|
||||
running configure, to aid debugging if configure makes a mistake.
|
||||
|
||||
It was created by triAGENS ArangoDB $as_me 1.4.8, which was
|
||||
It was created by triAGENS ArangoDB $as_me 1.4.9, which was
|
||||
generated by GNU Autoconf 2.69. Invocation command line was
|
||||
|
||||
$ $0 $@
|
||||
|
|
@ -3276,7 +3276,7 @@ fi
|
|||
|
||||
# Define the identity of the package.
|
||||
PACKAGE='arangodb'
|
||||
VERSION='1.4.8'
|
||||
VERSION='1.4.9'
|
||||
|
||||
|
||||
cat >>confdefs.h <<_ACEOF
|
||||
|
|
@ -9175,7 +9175,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
|
|||
# report actual input values of CONFIG_FILES etc. instead of their
|
||||
# values after options handling.
|
||||
ac_log="
|
||||
This file was extended by triAGENS ArangoDB $as_me 1.4.8, which was
|
||||
This file was extended by triAGENS ArangoDB $as_me 1.4.9, which was
|
||||
generated by GNU Autoconf 2.69. Invocation command line was
|
||||
|
||||
CONFIG_FILES = $CONFIG_FILES
|
||||
|
|
@ -9242,7 +9242,7 @@ _ACEOF
|
|||
cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
|
||||
ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
|
||||
ac_cs_version="\\
|
||||
triAGENS ArangoDB config.status 1.4.8
|
||||
triAGENS ArangoDB config.status 1.4.9
|
||||
configured by $0, generated by GNU Autoconf 2.69,
|
||||
with options \\"\$ac_cs_config\\"
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ dnl ============================================================================
|
|||
dnl --SECTION-- triAGENS GmbH Build Environment
|
||||
dnl ============================================================================
|
||||
|
||||
AC_INIT([triAGENS ArangoDB], [1.4.8], [info@triagens.de], [arangodb], [http://www.arangodb.org])
|
||||
AC_INIT([triAGENS ArangoDB], [1.4.9], [info@triagens.de], [arangodb], [http://www.arangodb.org])
|
||||
|
||||
dnl ----------------------------------------------------------------------------
|
||||
dnl auxillary directory for install-sh and missing
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"swaggerVersion": "1.1",
|
||||
"apiVersion": "1.4.8",
|
||||
"apiVersion": "1.4.9",
|
||||
"apis": [
|
||||
{
|
||||
"path": "api-docs/aqlfunction.{format}",
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@
|
|||
"notes": "Executes a batch request. A batch request can contain any number of other requests that can be sent to ArangoDB in isolation. The benefit of using batch requests is that batching requests requires less client/server roundtrips than when sending isolated requests. <br><br>All parts of a batch request are executed serially on the server. The server will return the results of all parts in a single response when all parts are finished. <br><br>Technically, a batch request is a multipart HTTP request, with content-type <em>multipart/form-data</em>. A batch request consists of an envelope and the individual batch part actions. Batch part actions are \"regular\" HTTP requests, including full header and an optional body. Multiple batch parts are separated by a boundary identifier. The boundary identifier is declared in the batch envelope. The MIME content-type for each individual batch part must be <em>application/x-arango-batchpart</em>. <br><br>The response sent by the server will be an <em>HTTP 200</em> response, with an error summary header <em>x-arango-errors</em>. This header contains the number of batch parts that failed with an HTTP error code of at least 400. <br><br>The response sent by the server is a multipart response, too. It contains the individual HTTP responses for all batch parts, including the full HTTP result header (with status code and other potential headers) and an optional result body. The individual batch parts in the result are seperated using the same boundary value as specified in the request. <br><br>The order of batch parts in the response will be the same as in the original client request. Client can additionally use the <em>Content-Id</em> MIME header in a batch part to define an individual id for each batch part. The server will return this id is the batch part responses, too. <br><br>",
|
||||
"summary": "executes a batch request",
|
||||
"httpMethod": "POST",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl -X POST --header 'Content-Type: multipart/form-data; boundary=SomeBoundaryValue' --data @- --dump - http://localhost:8529/_api/batch\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId1\r\n\r\nGET /_api/version HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId2\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: someId\r\n\r\nPOST /_api/collection/products HTTP/1.1\r\n\r\n{ \"name\": \"products\" }\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: nextId\r\n\r\nGET /_api/collection/products/figures HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: otherId\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n--SomeBoundaryValue--\r\n\n\nHTTP/1.1 200 OK\ncontent-type: multipart/form-data; boundary=SomeBoundaryValue\nx-arango-errors: 1\n\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId1\r\n\r\nHTTP/1.1 200 OK\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 37\r\n\r\n{\"server\":\"arango\",\"version\":\"1.4.8\"}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId2\r\n\r\nHTTP/1.1 404 Not Found\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 88\r\n\r\n{\"error\":true,\"code\":404,\"errorNum\":1203,\"errorMessage\":\"unknown collection 'products'\"}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: someId\r\n\r\nHTTP/1.1 200 OK\r\nlocation: /_db/_system/_api/collection/products\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 137\r\n\r\n{\"id\":\"346505639\",\"name\":\"products\",\"waitForSync\":false,\"isVolatile\":false,\"isSystem\":false,\"status\":3,\"type\":2,\"error\":false,\"code\":200}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: nextId\r\n\r\nHTTP/1.1 200 OK\r\nlocation: /_db/_system/_api/collection/products/figures\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 526\r\n\r\n{\"id\":\"346505639\",\"name\":\"products\",\"doCompact\":true,\"isVolatile\":false,\"isSystem\":false,\"journalSize\":1048576,\"keyOptions\":{\"type\":\"traditional\",\"allowUserKeys\":true},\"waitForSync\":false,\"count\":0,\"figures\":{\"alive\":{\"count\":0,\"size\":0},\"dead\":{\"count\":0,\"size\":0,\"deletion\":0},\"datafiles\":{\"count\":0,\"fileSize\":0},\"journals\":{\"count\":0,\"fileSize\":0},\"compactors\":{\"count\":0,\"fileSize\":0},\"shapefiles\":{\"count\":1,\"fileSize\":2097152},\"shapes\":{\"count\":6},\"attributes\":{\"count\":0}},\"status\":3,\"type\":2,\"error\":false,\"code\":200}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: otherId\r\n\r\nHTTP/1.1 200 OK\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 43\r\n\r\n{\"id\":\"346505639\",\"error\":false,\"code\":200}\r\n--SomeBoundaryValue--\n\n</code></pre><br>",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl -X POST --header 'Content-Type: multipart/form-data; boundary=SomeBoundaryValue' --data @- --dump - http://localhost:8529/_api/batch\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId1\r\n\r\nGET /_api/version HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId2\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: someId\r\n\r\nPOST /_api/collection/products HTTP/1.1\r\n\r\n{ \"name\": \"products\" }\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: nextId\r\n\r\nGET /_api/collection/products/figures HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: otherId\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n--SomeBoundaryValue--\r\n\n\nHTTP/1.1 200 OK\ncontent-type: multipart/form-data; boundary=SomeBoundaryValue\nx-arango-errors: 1\n\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId1\r\n\r\nHTTP/1.1 200 OK\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 37\r\n\r\n{\"server\":\"arango\",\"version\":\"1.4.9\"}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId2\r\n\r\nHTTP/1.1 404 Not Found\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 88\r\n\r\n{\"error\":true,\"code\":404,\"errorNum\":1203,\"errorMessage\":\"unknown collection 'products'\"}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: someId\r\n\r\nHTTP/1.1 200 OK\r\nlocation: /_db/_system/_api/collection/products\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 137\r\n\r\n{\"id\":\"346505639\",\"name\":\"products\",\"waitForSync\":false,\"isVolatile\":false,\"isSystem\":false,\"status\":3,\"type\":2,\"error\":false,\"code\":200}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: nextId\r\n\r\nHTTP/1.1 200 OK\r\nlocation: /_db/_system/_api/collection/products/figures\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 526\r\n\r\n{\"id\":\"346505639\",\"name\":\"products\",\"doCompact\":true,\"isVolatile\":false,\"isSystem\":false,\"journalSize\":1048576,\"keyOptions\":{\"type\":\"traditional\",\"allowUserKeys\":true},\"waitForSync\":false,\"count\":0,\"figures\":{\"alive\":{\"count\":0,\"size\":0},\"dead\":{\"count\":0,\"size\":0,\"deletion\":0},\"datafiles\":{\"count\":0,\"fileSize\":0},\"journals\":{\"count\":0,\"fileSize\":0},\"compactors\":{\"count\":0,\"fileSize\":0},\"shapefiles\":{\"count\":1,\"fileSize\":2097152},\"shapes\":{\"count\":6},\"attributes\":{\"count\":0}},\"status\":3,\"type\":2,\"error\":false,\"code\":200}\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: otherId\r\n\r\nHTTP/1.1 200 OK\r\ncontent-type: application/json; charset=utf-8\r\ncontent-length: 43\r\n\r\n{\"id\":\"346505639\",\"error\":false,\"code\":200}\r\n--SomeBoundaryValue--\n\n</code></pre><br>",
|
||||
"nickname": "executesABatchRequest"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@
|
|||
"notes": "Retrieves information about the current database <br><br>The response is a JSON object with the following attributes: <br><br>- <em>name</em>: the name of the current database<br><br>- <em>id</em>: the id of the current database<br><br>- <em>path</em>: the filesystem path of the current database<br><br>- <em>isSystem</em>: whether or not the current database is the <em>_system</em> database<br><br>",
|
||||
"summary": "retrieves information about the current database",
|
||||
"httpMethod": "GET",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_api/database/current\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"name\" : \"_system\", \n \"id\" : \"82343\", \n \"path\" : \"/tmp/vocdir.39152/databases/database-82343\", \n \"isSystem\" : true \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n</code></pre><br>",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_api/database/current\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : { \n \"name\" : \"_system\", \n \"id\" : \"82343\", \n \"path\" : \"/tmp/vocdir.15328/databases/database-82343\", \n \"isSystem\" : true \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n</code></pre><br>",
|
||||
"nickname": "retrievesInformationAboutTheCurrentDatabase"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -69,16 +69,16 @@
|
|||
"reason": "is returned if the document was found ",
|
||||
"code": "200"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the document or collection was not found ",
|
||||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the \"If-None-Match\" header is given and the document has the same version ",
|
||||
"code": "304"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version ",
|
||||
"reason": "is returned if the document or collection was not found ",
|
||||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version. The response will also contain the found document's current revision in the <em>_rev</em> attribute. Additionally, the attributes <em>_id</em> and <em>_key</em> will be returned. ",
|
||||
"code": "412"
|
||||
}
|
||||
],
|
||||
|
|
@ -160,7 +160,7 @@
|
|||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version ",
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version. The response will also contain the found document's current revision in the <em>etag</em> header. ",
|
||||
"code": "412"
|
||||
}
|
||||
],
|
||||
|
|
@ -221,7 +221,7 @@
|
|||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version ",
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version. The response will also contain the found document's current revision in the <em>_rev</em> attribute. Additionally, the attributes <em>_id</em> and <em>_key</em> will be returned. ",
|
||||
"code": "412"
|
||||
}
|
||||
],
|
||||
|
|
@ -268,7 +268,7 @@
|
|||
"notes": "Completely updates (i.e. replaces) the document identified by <em>document-handle</em>. If the document exists and can be updated, then a <em>HTTP 201</em> is returned and the \"ETag\" header field contains the new revision of the document. <br><br>If the new document passed in the body of the request contains the <em>document-handle</em> in the attribute <em>_id</em> and the revision in <em>_rev</em>, these attributes will be ignored. Only the URI and the \"ETag\" header are relevant in order to avoid confusion when using proxies. <br><br>Optionally, the URL parameter <em>waitForSync</em> can be used to force synchronisation of the document replacement operation to disk even in case that the <em>waitForSync</em> flag had been disabled for the entire collection. Thus, the <em>waitForSync</em> URL parameter can be used to force synchronisation of just specific operations. To use this, set the <em>waitForSync</em> parameter to <em>true</em>. If the <em>waitForSync</em> parameter is not specified or set to <em>false</em>, then the collection's default <em>waitForSync</em> behavior is applied. The <em>waitForSync</em> URL parameter cannot be used to disable synchronisation for collections that have a default <em>waitForSync</em> value of <em>true</em>. <br><br>The body of the response contains a JSON object with the information about the handle and the revision. The attribute <em>_id</em> contains the known <em>document-handle</em> of the updated document, the attribute <em>_rev</em> contains the new document revision. <br><br>If the document does not exist, then a <em>HTTP 404</em> is returned and the body of the response contains an error document. <br><br>There are two ways for specifying the targeted document revision id for conditional replacements (i.e. replacements that will only be executed if the revision id found in the database matches the document revision id specified in the request): - specifying the target revision in the <em>rev</em> URL query parameter- specifying the target revision in the <em>if-match</em> HTTP header<br><br>Specifying a target revision is optional, however, if done, only one of the described mechanisms must be used (either the <em>rev</em> URL parameter or the <em>if-match</em> HTTP header). Regardless which mechanism is used, the parameter needs to contain the target document revision id as returned in the <em>_rev</em> attribute of a document or by an HTTP <em>etag</em> header. <br><br>For example, to conditionally replace a document based on a specific revision id, you can use the following request: <br><br>- PUT /_api/document/<em>document-handle</em>?rev=<em>etag</em><br><br>If a target revision id is provided in the request (e.g. via the <em>etag</em> value in the <em>rev</em> URL query parameter above), ArangoDB will check that the revision id of the document found in the database is equal to the target revision id provided in the request. If there is a mismatch between the revision id, then by default a <em>HTTP 412</em> conflict is returned and no replacement is performed. <br><br>The conditional update behavior can be overriden with the <em>policy</em> URL query parameter: <br><br>- PUT /_api/document/<em>document-handle</em>?policy=<em>policy</em><br><br>If <em>policy</em> is set to <em>error</em>, then the behavior is as before: replacements will fail if the revision id found in the database does not match the target revision id specified in the request. <br><br>If <em>policy</em> is set to <em>last</em>, then the replacement will succeed, even if the revision id found in the database does not match the target revision id specified in the request. You can use the <em>last</em> `policy` to force replacements. <br><br>",
|
||||
"summary": "replaces a document",
|
||||
"httpMethod": "PUT",
|
||||
"examples": "Using document handle: <br><br><pre><code class=\"json\" >unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/357515687\n{\"Hello\": \"you\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"357908903\"\nlocation: /_db/_system/_api/document/products/357515687\n\n{ \n \"error\" : false, \n \"_id\" : \"products/357515687\", \n \"_rev\" : \"357908903\", \n \"_key\" : \"357515687\" \n}\n\n</code></pre><br>Unknown document handle: <br><br><pre><code class=\"json\" >unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/358891943\n{}\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/358891943 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n</code></pre><br>Produce a revision conflict: <br><br><pre><code class=\"json\" >unix> curl -X PUT --header 'If-Match: \"360661415\"' --data @- --dump - http://localhost:8529/_api/document/products/360268199\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/360268199\", \n \"_rev\" : \"360268199\", \n \"_key\" : \"360268199\" \n}\n\n</code></pre><br>Last write wins: <br><br><pre><code class=\"json\" >unix> curl -X PUT --header 'If-Match: \"362234279\"' --data @- --dump - http://localhost:8529/_api/document/products/361841063?policy=last\n{}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"362496423\"\nlocation: /_db/_system/_api/document/products/361841063\n\n{ \n \"error\" : false, \n \"_id\" : \"products/361841063\", \n \"_rev\" : \"362496423\", \n \"_key\" : \"361841063\" \n}\n\n</code></pre><br>Alternative to header field: <br><br><pre><code class=\"json\" >unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/363479463?rev=363872679\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/363479463\", \n \"_rev\" : \"363479463\", \n \"_key\" : \"363479463\" \n}\n\n</code></pre><br>",
|
||||
"examples": "Using document handle: <br><br><pre><code class=\"json\" >unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/357515687\n{\"Hello\": \"you\"}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"357908903\"\nlocation: /_db/_system/_api/document/products/357515687\n\n{ \n \"error\" : false, \n \"_id\" : \"products/357515687\", \n \"_rev\" : \"357908903\", \n \"_key\" : \"357515687\" \n}\n\n</code></pre><br>Unknown document handle: <br><br><pre><code class=\"json\" >unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/358891943\n{}\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/358891943 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n</code></pre><br>Produce a revision conflict: <br><br><pre><code class=\"json\" >unix> curl -X PUT --header 'If-Match: \"360661415\"' --data @- --dump - http://localhost:8529/_api/document/products/360268199\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"360268199\"\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/360268199\", \n \"_rev\" : \"360268199\", \n \"_key\" : \"360268199\" \n}\n\n</code></pre><br>Last write wins: <br><br><pre><code class=\"json\" >unix> curl -X PUT --header 'If-Match: \"362234279\"' --data @- --dump - http://localhost:8529/_api/document/products/361841063?policy=last\n{}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"362496423\"\nlocation: /_db/_system/_api/document/products/361841063\n\n{ \n \"error\" : false, \n \"_id\" : \"products/361841063\", \n \"_rev\" : \"362496423\", \n \"_key\" : \"361841063\" \n}\n\n</code></pre><br>Alternative to header field: <br><br><pre><code class=\"json\" >unix> curl -X PUT --data @- --dump - http://localhost:8529/_api/document/products/363479463?rev=363872679\n{\"other\":\"content\"}\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"363479463\"\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/363479463\", \n \"_rev\" : \"363479463\", \n \"_key\" : \"363479463\" \n}\n\n</code></pre><br>",
|
||||
"nickname": "replacesADocument"
|
||||
}
|
||||
],
|
||||
|
|
@ -295,7 +295,7 @@
|
|||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version ",
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version. The response will also contain the found document's current revision in the <em>_rev</em> attribute. Additionally, the attributes <em>_id</em> and <em>_key</em> will be returned. ",
|
||||
"code": "412"
|
||||
}
|
||||
],
|
||||
|
|
@ -315,7 +315,7 @@
|
|||
"description": "The handle of the document. "
|
||||
},
|
||||
{
|
||||
"dataType": "String",
|
||||
"dataType": "Boolean",
|
||||
"paramType": "query",
|
||||
"name": "keepNull",
|
||||
"description": "If the intention is to delete existing attributes with the patch command, the URL query parameter <em>keepNull</em> can be used with a value of <em>false</em>. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of <em>null</em>. "
|
||||
|
|
@ -371,7 +371,7 @@
|
|||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the current document has a different version ",
|
||||
"reason": "is returned if a \"If-Match\" header or <em>rev</em> is given and the found document has a different version. The response will also contain the found document's current revision in the <em>_rev</em> attribute. Additionally, the attributes <em>_id</em> and <em>_key</em> will be returned. ",
|
||||
"code": "412"
|
||||
}
|
||||
],
|
||||
|
|
@ -411,7 +411,7 @@
|
|||
"notes": "The body of the response contains a JSON object with the information about the handle and the revision. The attribute <em>_id</em> contains the known <em>document-handle</em> of the deleted document, the attribute <em>_rev</em> contains the document revision. <br><br>If the <em>waitForSync</em> parameter is not specified or set to <em>false</em>, then the collection's default <em>waitForSync</em> behavior is applied. The <em>waitForSync</em> URL parameter cannot be used to disable synchronisation for collections that have a default <em>waitForSync</em> value of <em>true</em>. <br><br>",
|
||||
"summary": "deletes a document",
|
||||
"httpMethod": "DELETE",
|
||||
"examples": "Using document handle: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/367542695\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : false, \n \"_id\" : \"products/367542695\", \n \"_rev\" : \"367542695\", \n \"_key\" : \"367542695\" \n}\n\n</code></pre><br>Unknown document handle: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/368787879\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/368787879 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n</code></pre><br>Revision conflict: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --header 'If-Match: \"370557351\"' --dump - http://localhost:8529/_api/document/products/370164135\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/370164135\", \n \"_rev\" : \"370164135\", \n \"_key\" : \"370164135\" \n}\n\n</code></pre><br>",
|
||||
"examples": "Using document handle: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/367542695\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : false, \n \"_id\" : \"products/367542695\", \n \"_rev\" : \"367542695\", \n \"_key\" : \"367542695\" \n}\n\n</code></pre><br>Unknown document handle: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --dump - http://localhost:8529/_api/document/products/368787879\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"document /_api/document/products/368787879 not found\", \n \"code\" : 404, \n \"errorNum\" : 1202 \n}\n\n</code></pre><br>Revision conflict: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --header 'If-Match: \"370557351\"' --dump - http://localhost:8529/_api/document/products/370164135\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"370164135\"\n\n{ \n \"error\" : true, \n \"code\" : 412, \n \"errorNum\" : 1200, \n \"errorMessage\" : \"precondition failed\", \n \"_id\" : \"products/370164135\", \n \"_rev\" : \"370164135\", \n \"_key\" : \"370164135\" \n}\n\n</code></pre><br>",
|
||||
"nickname": "deletesADocument"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -83,13 +83,13 @@
|
|||
"reason": "is returned if the edge was found ",
|
||||
"code": "200"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the edge or collection was not found ",
|
||||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the \"If-None-Match\" header is given and the edge has the same version ",
|
||||
"code": "304"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the edge or collection was not found ",
|
||||
"code": "404"
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
|
|
@ -157,13 +157,13 @@
|
|||
"reason": "is returned if the edge document was found ",
|
||||
"code": "200"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the edge document or collection was not found ",
|
||||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the \"If-None-Match\" header is given and the edge document has same version ",
|
||||
"code": "304"
|
||||
},
|
||||
{
|
||||
"reason": "is returned if the edge document or collection was not found ",
|
||||
"code": "404"
|
||||
}
|
||||
],
|
||||
"parameters": [
|
||||
|
|
@ -303,7 +303,7 @@
|
|||
"description": "The handle of the edge document. "
|
||||
},
|
||||
{
|
||||
"dataType": "String",
|
||||
"dataType": "Boolean",
|
||||
"paramType": "query",
|
||||
"name": "keepNull",
|
||||
"description": "If the intention is to delete existing attributes with the patch command, the URL query parameter <em>keepNull</em> can be used with a value of <em>false</em>. This will modify the behavior of the patch command to remove any attributes from the existing edge document that are contained in the patch document with an attribute value of <em>null</em>. "
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@
|
|||
"notes": "Returns a list of all configured endpoints the server is listening on. For each endpoint, the list of allowed databases is returned too if set. <br><br>The result is a JSON hash which has the endpoints as keys, and the list of mapped database names as values for each endpoint. <br><br>If a list of mapped databases is empty, it means that all databases can be accessed via the endpoint. If a list of mapped databases contains more than one database name, this means that any of the databases might be accessed via the endpoint, and the first database in the list will be treated as the default database for the endpoint. The default database will be used when an incoming request does not specify a database name in the request explicitly. <br><br>Note: retrieving the list of all endpoints is allowed in the system database only. Calling this action in any other database will make the server return an error. <br><br>",
|
||||
"summary": "returns a list of all endpoints",
|
||||
"httpMethod": "GET",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_api/endpoint\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n { \n \"endpoint\" : \"tcp://127.0.0.1:39152\", \n \"databases\" : [ ] \n }, \n { \n \"endpoint\" : \"tcp://127.0.0.1:8532\", \n \"databases\" : [ \n \"mydb1\", \n \"mydb2\" \n ] \n } \n]\n\n</code></pre><br>",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_api/endpoint\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n { \n \"endpoint\" : \"tcp://127.0.0.1:35328\", \n \"databases\" : [ ] \n }, \n { \n \"endpoint\" : \"tcp://127.0.0.1:8532\", \n \"databases\" : [ \n \"mydb1\", \n \"mydb2\" \n ] \n } \n]\n\n</code></pre><br>",
|
||||
"nickname": "returnsAListOfAllEndpoints"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
"notes": "Returns the result of an async job identified by <em>job-id</em>. If the async job result is present on the server, the result will be removed from the list of result. That means this method can be called for each <em>job-id</em> once. <br><br>The method will return the original job result's headers and body, plus the additional HTTP header <em>x-arango-async-job-id</em>. If this header is present, then the job was found and the response contains the original job's result. If the header is not present, the job was not found and the response contains status information from the job amanger. <br><br>",
|
||||
"summary": "Returns the result of an async job",
|
||||
"httpMethod": "PUT",
|
||||
"examples": "Not providing a job-id: <br><br><pre><code class=\"json\" >unix> curl -X PUT --dump - http://localhost:8529/_api/job/\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{\"error\":true,\"errorMessage\":\"bad parameter\",\"code\":400,\"errorNum\":400}\n\n</code></pre><br>Providing a job-id for a non-existing job: <br><br><pre><code class=\"json\" >unix> curl -X PUT --dump - http://localhost:8529/_api/job/foobar\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{\"error\":true,\"errorMessage\":\"not found\",\"code\":404,\"errorNum\":404}\n\n</code></pre><br>Fetching the result of an HTTP GET job: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409813415\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/job/409813415\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 409813415\n\n{\"server\":\"arango\",\"version\":\"1.4.8\"}\n\n</code></pre><br>Fetching the result of an HTTP POST job that failed: <br><br><pre><code class=\"json\" >unix> curl -X POST --header 'x-arango-async: store' --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\" this name is invalid \"}\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409878951\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/job/409878951\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 409878951\n\n{\"error\":true,\"code\":400,\"errorNum\":1208,\"errorMessage\":\"cannot create collection: illegal name\"}\n\n</code></pre><br>",
|
||||
"examples": "Not providing a job-id: <br><br><pre><code class=\"json\" >unix> curl -X PUT --dump - http://localhost:8529/_api/job/\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{\"error\":true,\"errorMessage\":\"bad parameter\",\"code\":400,\"errorNum\":400}\n\n</code></pre><br>Providing a job-id for a non-existing job: <br><br><pre><code class=\"json\" >unix> curl -X PUT --dump - http://localhost:8529/_api/job/foobar\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{\"error\":true,\"errorMessage\":\"not found\",\"code\":404,\"errorNum\":404}\n\n</code></pre><br>Fetching the result of an HTTP GET job: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409813415\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/job/409813415\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 409813415\n\n{\"server\":\"arango\",\"version\":\"1.4.9\"}\n\n</code></pre><br>Fetching the result of an HTTP POST job that failed: <br><br><pre><code class=\"json\" >unix> curl -X POST --header 'x-arango-async: store' --data @- --dump - http://localhost:8529/_api/collection\n{\"name\":\" this name is invalid \"}\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 409878951\n\nunix> curl -X PUT --dump - http://localhost:8529/_api/job/409878951\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 409878951\n\n{\"error\":true,\"code\":400,\"errorNum\":1208,\"errorMessage\":\"cannot create collection: illegal name\"}\n\n</code></pre><br>",
|
||||
"nickname": "ReturnsTheResultOfAnAsyncJob"
|
||||
}
|
||||
],
|
||||
|
|
@ -106,7 +106,7 @@
|
|||
"notes": "Deletes either all job results, expired job results, or the result of a specific job. Clients can use this method to perform an eventual garbage collection of job results. <br><br>",
|
||||
"summary": "Deletes the result of async jobs",
|
||||
"httpMethod": "DELETE",
|
||||
"examples": "Deleting all jobs: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 410075559\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/all\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n</code></pre><br>Deleting expired jobs: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 410141095\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/expired?stamp=1390826479\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n</code></pre><br>Deleting the result of a specific job: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 410206631\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/410206631\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n</code></pre><br>Deleting the result of a non-existing job: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --dump - http://localhost:8529/_api/job/foobar\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"not found\", \n \"code\" : 404, \n \"errorNum\" : 404 \n}\n\n</code></pre><br>",
|
||||
"examples": "Deleting all jobs: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 410075559\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/all\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n</code></pre><br>Deleting expired jobs: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 410141095\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/expired?stamp=1391806166\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n</code></pre><br>Deleting the result of a specific job: <br><br><pre><code class=\"json\" >unix> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 410206631\n\nunix> curl -X DELETE --dump - http://localhost:8529/_api/job/410206631\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : true \n}\n\n</code></pre><br>Deleting the result of a non-existing job: <br><br><pre><code class=\"json\" >unix> curl -X DELETE --dump - http://localhost:8529/_api/job/foobar\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n \"error\" : true, \n \"errorMessage\" : \"not found\", \n \"code\" : 404, \n \"errorNum\" : 404 \n}\n\n</code></pre><br>",
|
||||
"nickname": "DeletesTheResultOfAsyncJobs"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -202,7 +202,7 @@
|
|||
"description": "The Handle of the Document. "
|
||||
},
|
||||
{
|
||||
"dataType": "String",
|
||||
"dataType": "Boolean",
|
||||
"paramType": "query",
|
||||
"name": "keepNull",
|
||||
"description": "If the intention is to delete existing attributes with the patch command, the URL query parameter <em>keepNull</em> can be used with a value of <em>false</em>. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of <em>null</em>. "
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@
|
|||
"notes": "<br><br>Returns the statistics information. The returned object contains the statistics figures grouped together according to the description returned by <em>_admin/statistics-description</em>. For instance, to access a figure <em>userTime</em> from the group <em>system</em>, you first select the sub-object describing the group stored in <em>system</em> and in that sub-object the value for <em>userTime</em> is stored in the attribute of the same name. <br><br>In case of a distribution, the returned object contains the total count in <em>count</em> and the distribution list in <em>counts</em>. The sum (or total) of the individual values is returned in <em>sum</em>. <br><br>",
|
||||
"summary": "reads the statistics",
|
||||
"httpMethod": "GET",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"system\" : { \n \"minorPageFaults\" : 71891, \n \"majorPageFaults\" : 1939, \n \"userTime\" : 12.491862, \n \"systemTime\" : 3.295611, \n \"numberOfThreads\" : 16, \n \"residentSize\" : 57913344, \n \"virtualSize\" : 4994162688 \n }, \n \"client\" : { \n \"httpConnections\" : 1, \n \"connectionTime\" : { \n \"sum\" : 0.00044608116149902344, \n \"count\" : 1, \n \"counts\" : [ \n 1, \n 0, \n 0, \n 0 \n ] \n }, \n \"totalTime\" : { \n \"sum\" : 23.46972107887268, \n \"count\" : 850, \n \"counts\" : [ \n 553, \n 191, \n 47, \n 45, \n 9, \n 4, \n 1 \n ] \n }, \n \"requestTime\" : { \n \"sum\" : 23.310941696166992, \n \"count\" : 850, \n \"counts\" : [ \n 555, \n 189, \n 47, \n 45, \n 9, \n 4, \n 1 \n ] \n }, \n \"queueTime\" : { \n \"sum\" : 0.017937183380126953, \n \"count\" : 848, \n \"counts\" : [ \n 848, \n 0, \n 0, \n 0, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesSent\" : { \n \"sum\" : 381722, \n \"count\" : 850, \n \"counts\" : [ \n 234, \n 501, \n 115, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesReceived\" : { \n \"sum\" : 197140, \n \"count\" : 850, \n \"counts\" : [ \n 625, \n 225, \n 0, \n 0, \n 0, \n 0 \n ] \n } \n }, \n \"http\" : { \n \"requestsTotal\" : 850, \n \"requestsAsync\" : 0, \n \"requestsGet\" : 225, \n \"requestsHead\" : 0, \n \"requestsPost\" : 446, \n \"requestsPut\" : 34, \n \"requestsPatch\" : 3, \n \"requestsDelete\" : 142, \n \"requestsOptions\" : 0, \n \"requestsOther\" : 0 \n }, \n \"server\" : { \n \"uptime\" : 30.084595918655396 \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n</code></pre><br>",
|
||||
"examples": "<br><br><pre><code class=\"json\" >unix> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"system\" : { \n \"minorPageFaults\" : 72292, \n \"majorPageFaults\" : 1916, \n \"userTime\" : 12.610689, \n \"systemTime\" : 1.60762, \n \"numberOfThreads\" : 16, \n \"residentSize\" : 57204736, \n \"virtualSize\" : 4994150400 \n }, \n \"client\" : { \n \"httpConnections\" : 1, \n \"connectionTime\" : { \n \"sum\" : 0.00035881996154785156, \n \"count\" : 1, \n \"counts\" : [ \n 1, \n 0, \n 0, \n 0 \n ] \n }, \n \"totalTime\" : { \n \"sum\" : 22.800187587738037, \n \"count\" : 850, \n \"counts\" : [ \n 534, \n 213, \n 36, \n 55, \n 9, \n 0, \n 3 \n ] \n }, \n \"requestTime\" : { \n \"sum\" : 22.63769221305847, \n \"count\" : 850, \n \"counts\" : [ \n 538, \n 209, \n 36, \n 55, \n 9, \n 0, \n 3 \n ] \n }, \n \"queueTime\" : { \n \"sum\" : 0.018306493759155273, \n \"count\" : 848, \n \"counts\" : [ \n 848, \n 0, \n 0, \n 0, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesSent\" : { \n \"sum\" : 381722, \n \"count\" : 850, \n \"counts\" : [ \n 234, \n 501, \n 115, \n 0, \n 0, \n 0 \n ] \n }, \n \"bytesReceived\" : { \n \"sum\" : 197140, \n \"count\" : 850, \n \"counts\" : [ \n 625, \n 225, \n 0, \n 0, \n 0, \n 0 \n ] \n } \n }, \n \"http\" : { \n \"requestsTotal\" : 850, \n \"requestsAsync\" : 0, \n \"requestsGet\" : 225, \n \"requestsHead\" : 0, \n \"requestsPost\" : 446, \n \"requestsPut\" : 34, \n \"requestsPatch\" : 3, \n \"requestsDelete\" : 142, \n \"requestsOptions\" : 0, \n \"requestsOther\" : 0 \n }, \n \"server\" : { \n \"uptime\" : 29.58106803894043 \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n\n</code></pre><br>",
|
||||
"nickname": "readsTheStatistics"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@
|
|||
"reason": "If the transaction specification is either missing or malformed, the server will respond with <em>HTTP 400</em>. ",
|
||||
"code": "400"
|
||||
},
|
||||
{
|
||||
"reason": "If the transaction specification contains an unknown collection, the server will respond with <em>HTTP 404</em>. ",
|
||||
"code": "404"
|
||||
},
|
||||
{
|
||||
"reason": "Exceptions thrown by users will make the server respond with a return code of <em>HTTP 500</em> ",
|
||||
"code": "500"
|
||||
|
|
|
|||
Loading…
Reference in New Issue