arangodb · Simran-B · Oct 1, 2021 · Sep 30, 2021
@@ -20,7 +20,7 @@ will be *rocksdb*
 
 Return the active storage engine with the RocksDB storage engine in
8000
 use:
 
-@EXAMPLE_ARANGOSH_RUN{RestEngine_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestEngine}
     var response = logCurlRequest('GET', '/_api/engine');
 
     assert(response.code === 200);

@@ -57,7 +57,7 @@ within the timeout, then an *HTTP 408* is returned.
 
 @EXAMPLES
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupCreateBackup_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupCreateBackup}
     var url = "/_admin/backup/create";
     var body = {
       label: "foo"

@@ -23,7 +23,7 @@ If a backup corresponding to the identifier `id` cannot be found.
 
 @EXAMPLES
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupDeleteBackup_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupDeleteBackup}
     var backup = require("@arangodb/hotbackup").create();
     var url = "/_admin/backup/delete";
     var body = {"id" : backup.id};

@@ -61,7 +61,7 @@ there is no known download operation with the given `downloadId`.
 
 @EXAMPLES
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupDownloadBackup_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupDownloadBackup}
     var hotbackup = require("@arangodb/hotbackup");
     try {
       require("fs").makeDirectory("/tmp/backups");
@@ -106,7 +106,7 @@ there is no known download operation with the given `downloadId`.
 The `result` object of the body holds the `downloadId` string attribute which
 can be used to follow the download process.
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupDownloadBackupStarted_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupDownloadBackupStarted}
     var hotbackup = require("@arangodb/hotbackup");
     try {
       require("fs").makeDirectory("/tmp/backups");

@@ -31,7 +31,7 @@ method other than `POST`, then an *HTTP 405 METHOD NOT ALLOWED* is returned.
 
 @EXAMPLES
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupListBackup_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupListBackup}
     var backup = require("@arangodb/hotbackup").create();
     var backup2 = require("@arangodb/hotbackup").create();
     var url = "/_admin/backup/list";

@@ -29,7 +29,7 @@ are detailed in the returned error document.
 
 @EXAMPLES
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupRestoreBackup_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupRestoreBackup}
     var backup = require("@arangodb/hotbackup").create();
     var url = "/_admin/backup/restore";
     var body = {

@@ -61,7 +61,7 @@ there is no known upload operation with the given `uploadId`.
 
 @EXAMPLES
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupUploadBackup_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupUploadBackup}
     try {
       require("fs").makeDirectory("/tmp/backups");
     } catch(e) {
@@ -91,7 +91,7 @@ there is no known upload operation with the given `uploadId`.
 The `result` object of the body holds the `uploadId` string attribute which can
 be used to follow the upload process.
 
-@EXAMPLE_ARANGOSH_RUN{RestBackupUploadBackupStarted_rocksdb}
+@EXAMPLE_ARANGOSH_RUN{RestBackupUploadBackupStarted}
     try {
       require("fs").makeDirectory("/tmp/backups");
     } catch(e) {

@@ -75,18 +75,5 @@ The type of the collection:
   - 2: regular document collection
   - 3: edge collection
 
-@RESTSTRUCT{status,collection_info,string,optional,}
-corresponds to **statusString**; *Only relevant for the MMFiles storage engine*
-  - 0: "unknown" - may be corrupted
-  - 1: (deprecated, maps to "unknown")
-  - 2: "unloaded"
-  - 3: "loaded"
-  - 4: "unloading"
-  - 5: "deleted"
-  - 6: "loading"
-
-@RESTSTRUCT{statusString,collection_info,string,optional,}
-any of: ["unloaded", "loading", "loaded", "unloading", "deleted", "unknown"] *Only relevant for the MMFiles storage engine*
-
 @RESTSTRUCT{globallyUniqueId,collection_info,string,optional,}
 Unique identifier of the collection
@@ -24,17 +24,14 @@ All lookups that could be found in the cache are much faster
 than lookups not stored in the cache so you get a nice performance boost.
 It is also guaranteed that the cache is consistent with the stored data.
 
-For the time being this function is only useful on RocksDB storage engine,
-as in MMFiles engine all indexes are in memory anyways.
-
-On RocksDB this function honors all memory limits, if the indexes you want
+This function honors all memory limits, if the indexes you want
 to load are smaller than your memory limit this function guarantees that most
 index values are cached.
 If the index is larger than your memory limit this function will fill up values
 up to this limit and for the time being there is no way to control which indexes
 of the collection should have priority over others.
 
-On sucess this function returns an object with attribute `result` set to `true`
+On success this function returns an object with attribute `result` set to `true`
 
 @RESTRETURNCODES
 

@@ -16,8 +16,6 @@ It returns an object with the att
6D3F
ributes
 
 - *result*: will be *true* if recalculating the document count succeeded.
 
-**Note**: this method is specific for the RocksDB storage engine
-
 @RESTRETURNCODES
 
 @RESTRETURNCODE{200}

@@ -152,15 +152,15 @@ The query has to be executed within the given runtime or it will be killed.
 The value is specified in seconds. The default value is *0.0* (no timeout).
 
 @RESTSTRUCT{maxTransactionSize,post_api_cursor_opts,integer,optional,int64}
-Transaction size limit in bytes. Honored by the RocksDB storage engine only.
+Transaction size limit in bytes.
 
 @RESTSTRUCT{intermediateCommitSize,post_api_cursor_opts,integer,optional,int64}
 Maximum total size of operations after which an intermediate commit is performed
-automatically. Honored by the RocksDB storage engine only.
+automatically.
 
 @RESTSTRUCT{intermediateCommitCount,post_api_cursor_opts,integer,optional,int64}
 Maximum number of operations after which an intermediate commit is performed
-automatically. Honored by the RocksDB storage engine only.
+automatically.
 
 @RESTSTRUCT{skipInaccessibleCollections,post_api_cursor_opts,boolean,optional,}
 AQL queries (especially graph traversals) will treat collection to which a user has no access rights as if these collections were empty. Instead of returning a forbidden access error, your queries will execute normally. This is intended to help with certain use-cases: A graph contains several collections and different users execute AQL queries on that graph. You can now naturally limit the accessible results by changing the access rights of users on collections. This feature is only available in the Enterprise Edition.

@@ -6,8 +6,8 @@
 
 @HINTS
 {% hint 'warning' %}
-This revision-based replication endpoint will only work with the RocksDB
-engine, and with collections created in ArangoDB v3.8.0 or later.
+This revision-based replication endpoint will only work with collections
+created in ArangoDB v3.8.0 or later.
 {% endhint %}
 
 @RESTQUERYPARAMETERS
@@ -70,7 +70,6 @@ is returned when an invalid HTTP method is used.
 is returned if an error occurred while assembling the response.
 
 @RESTRETURNCODE{501}
-is returned if called with mmfiles or on a collection which doesn't support
-sync-by-revision
+is returned if called on a collection which doesn't support sync-by-revision
 
 @endDocuBlock
@@ -6,8 +6,8 @@
 
 @HINTS
 {% hint 'warning' %}
-This revision-based replication endpoint will only work with the RocksDB
-engine, and with collections created in ArangoDB v3.8.0 or later.
+This revision-based replication endpoint will only work with collections
+created in ArangoDB v3.8.0 or later.
 {% endhint %}
 
 @RESTQUERYPARAMETERS
@@ -38,7 +38,6 @@ is returned when an invalid HTTP method is used.
 is returned if an error occurred while assembling the response.
 
 @RESTRETURNCODE{501}
-is returned if called with mmfiles or on a collection which doesn't support
-sync-by-revision
+is returned if called on a collection which doesn't support sync-by-revision
 
 @endDocuBlock
@@ -6,8 +6,8 @@
 
 @HINTS
 {% hint 'warning' %}
-This revision-based replication endpoint will only work with the RocksDB
-engine, and with collections created in ArangoDB v3.8.0 or later.
+This revision-based replication endpoint will only work with collections
+created in ArangoDB v3.8.0 or later.
 {% endhint %}
 
 @RESTQUERYPARAMETERS
@@ -68,7 +68,6 @@ is returned when an invalid HTTP method is used.
 is returned if an error occurred while assembling the response.
 
 @RESTRETURNCODE{501}
-is returned if called with mmfiles or on a collection which doesn't support
-sync-by-revision
+is returned if called on a collection which doesn't support sync-by-revision
 
 @endDocuBlock
@@ -89,7 +89,6 @@ is returned when an invalid HTTP method is used.
 is returned if an error occurred while assembling the response.
 
 @RESTRETURNCODE{501}
-is returned if called with mmfiles or on a collection which doesn't support
-sync-by-revision
+is returned if called on a collection which doesn't support sync-by-revision
 
 @endDocuBlock
@@ -41,7 +41,7 @@ not time out waiting for a lock.
 optional arguments passed to *action*.
 
 @RESTBODYPARAM{maxTransactionSize,integer,optional,int64}
-Transaction size limit in bytes. Honored by the RocksDB storage engine only.
+Transaction size limit in bytes.
 
 @RESTDESCRIPTION
 The transaction description must be passed in the body of the POST request.

@@ -26,7 +26,7 @@ value will be used. Setting *lockTimeout* to *0* will make ArangoDB
 not time out waiting for a lock.
 
 @RESTBODYPARAM{maxTransactionSize,integer,optional,int64}
-Transaction size limit in bytes. Honored by the RocksDB storage engine only.
+Transaction size limit in bytes.
 
 @RESTDESCRIPTION
 The transaction description must be passed in the body of the POST request.