diff --git a/js/apps/system/_admin/aardvark/APP/api-docs.json b/js/apps/system/_admin/aardvark/APP/api-docs.json index 77f4df8745..b58e1d656c 100644 --- a/js/apps/system/_admin/aardvark/APP/api-docs.json +++ b/js/apps/system/_admin/aardvark/APP/api-docs.json @@ -1618,7 +1618,7 @@ "post_api_collection": { "properties": { "distributeShardsLike": { - "description": "(The default is *\"\"*): in an Enterprise Edition cluster, this attribute binds\nthe specifics of sharding for the newly created collection to follow that of a\nspecified existing collection.\n**Note**: Using this parameter has consequences for the prototype\ncollection. It can no longer be dropped, before sharding imitating\ncollections are dropped. Equally, backups and restores of imitating\ncollections alone will generate warnings, which can be overridden,\nabout missing sharding prototype.\n\n", + "description": "(The default is *\"\"*): in an Enterprise Edition cluster, this attribute binds\nthe specifics of sharding for the newly created collection to follow that of a\nspecified existing collection.\n**Note**: Using this parameter has consequences for the prototype\ncollection. It can no longer be dropped, before the sharding-imitating\ncollections are dropped. Equally, backups and restores of imitating\ncollections alone will generate warnings (which can be overridden)\nabout missing sharding prototype.\n\n", "type": "string" }, "doCompact": { @@ -1667,8 +1667,12 @@ "description": "(The default is *[ \"_key\" ]*): in a cluster, this attribute determines\nwhich document attributes are used to determine the target shard for documents.\nDocuments are sent to shards based on the values of their shard key attributes.\nThe values of all shard key attributes in a document are hashed,\nand the hash value is used to determine the target shard.\n**Note**: Values of shard key attributes cannot be changed once set.\n This option is meaningless in a single server setup.\n\n", "type": "string" }, + "shardingStrategy": { + "description": "This attribute specifies the name of the sharding strategy to use for \nthe collection. Since ArangoDB 3.4 there are different sharding strategies \nto select from when creating a new collection. The selected *shardingStrategy* \nvalue will remain fixed for the collection and cannot be changed afterwards. \nThis is important to make the collection keep its sharding settings and\nalways find documents already distributed to shards using the same\ninitial sharding algorithm.\n\nThe available sharding strategies are:\n- *community-compat*: default sharding used by ArangoDB community\n versions before ArangoDB 3.4\n- *enterprise-compat*: default sharding used by ArangoDB enterprise\n versions before ArangoDB 3.4\n- *enterprise-smart-edge-compat*: default sharding used by smart edge\n collections in ArangoDB enterprise versions before ArangoDB 3.4\n- *hash*: default sharding used by ArangoDB 3.4 for new collections\n (excluding smart edge collections)\n- *enterprise-hash-smart-edge*: default sharding used by ArangoDB 3.4 \n for new smart edge collections\n\nIf no sharding strategy is specified, the default will be *hash* for\nall collections, and *enterprise-hash-smart-edge* for all smart edge\ncollections (requires the *Enterprise Edition* of ArangoDB). \nManually overriding the sharding strategy does not yet provide a \nbenefit, but it may later in case other sharding strategies are added.\n\n", + "type": "string" + }, "type": { - "description": "(The default is *2*): the type of the collection to create.\nThe following values for *type* are valid:\n\n- *2*: document collection\n- *3*: edges collection\n\n", + "description": "(The default is *2*): the type of the collection to create.\nThe following values for *type* are valid:\n\n- *2*: document collection\n- *3*: edge collection\n\n", "format": "int64", "type": "integer" }, @@ -4589,7 +4593,7 @@ "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md" }, "post": { - "description": "\n\nCreates a new collection with a given name. The request must contain an\nobject with the following attributes.\n\n\n**A JSON object with these properties is required:**\n\n - **journalSize**: The maximal size of a journal or datafile in bytes. The value\n must be at least `1048576` (1 MiB). (The default is a configuration parameter)\n This option is meaningful for the MMFiles storage engine only.\n - **replicationFactor**: (The default is *1*): in a cluster, this attribute determines how many copies\n of each shard are kept on different DBServers. The value 1 means that only one\n copy (no synchronous replication) is kept. A value of k means that k-1 replicas\n are kept. Any two copies reside on different DBServers. Replication between them is \n synchronous, that is, every write operation to the \"leader\" copy will be replicated \n to all \"follower\" replicas, before the write operation is reported successful.\n If a server fails, this is detected automatically and one of the servers holding \n copies take over, usually without an error being reported.\n - **keyOptions**:\n - **allowUserKeys**: if set to *true*, then it is allowed to supply own key values in the\n *_key* attribute of a document. If set to *false*, then the key generator\n will solely be responsible for generating keys and supplying own key values\n in the *_key* attribute of documents is considered an error.\n - **type**: specifies the type of the key generator. The currently available generators are\n *traditional*, *autoincrement*, *uuid* and *padded*.\n The *traditional* key generator generates numerical keys in ascending order.\n The *autoincrement* key generator generates numerical keys in ascending order, \n the inital offset and the spacing can be configured\n The *padded* key generator generates keys of a fixed length (16 bytes) in\n ascending lexicographical sort order. This is ideal for usage with the _RocksDB_\n engine, which will slightly benefit keys that are inserted in lexicographically\n ascending order. The key generator can be used in a single-server or cluster.\n The *uuid* key generator generates universally unique 128 bit keys, which \n are stored in hexadecimal human-readable format. This key generator can be used\n in a single-server or cluster to generate \"seemingly random\" keys. The keys \n produced by this key generator are not lexicographically sorted.\n - **increment**: increment value for *autoincrement* key generator. Not used for other key\n generator types.\n - **offset**: Initial offset value for *autoincrement* key generator.\n Not used for other key generator types.\n - **name**: The name of the collection.\n - **waitForSync**: If *true* then the data is synchronized to disk before returning from a\n document create, update, replace or removal operation. (default: false)\n - **doCompact**: whether or not the collection will be compacted (default is *true*)\n This option is meaningful for the MMFiles storage engine only.\n - **isVolatile**: If *true* then the collection data is kept in-memory only and not made persistent.\n Unloading the collection will cause the collection data to be discarded. Stopping\n or re-starting the server will also cause full loss of data in the\n collection. Setting this option will make the resulting collection be\n slightly faster than regular collections because ArangoDB does not\n enforce any synchronization to disk and does not calculate any CRC\n checksums for datafiles (as there are no datafiles). This option\n should therefore be used for cache-type collections only, and not\n for data that cannot be re-created otherwise.\n (The default is *false*)\n This option is meaningful for the MMFiles storage engine only.\n - **shardKeys**: (The default is *[ \"_key\" ]*): in a cluster, this attribute determines\n which document attributes are used to determine the target shard for documents.\n Documents are sent to shards based on the values of their shard key attributes.\n The values of all shard key attributes in a document are hashed,\n and the hash value is used to determine the target shard.\n **Note**: Values of shard key attributes cannot be changed once set.\n This option is meaningless in a single server setup.\n - **numberOfShards**: (The default is *1*): in a cluster, this value determines the\n number of shards to create for the collection. In a single\n server setup, this option is meaningless.\n - **isSystem**: If *true*, create a system collection. In this case *collection-name*\n should start with an underscore. End users should normally create non-system\n collections only. API implementors may be required to create system\n collections in very special occasions, but normally a regular collection will do.\n (The default is *false*)\n - **type**: (The default is *2*): the type of the collection to create.\n The following values for *type* are valid:\n - *2*: document collection\n - *3*: edges collection\n - **indexBuckets**: The number of buckets into which indexes using a hash\n table are split. The default is 16 and this number has to be a\n power of 2 and less than or equal to 1024.\n For very large collections one should increase this to avoid long pauses\n when the hash table has to be initially built or resized, since buckets\n are resized individually and can be initially built in parallel. For\n example, 64 might be a sensible value for a collection with 100\n 000 000 documents. Currently, only the edge index respects this\n value, but other index types might follow in future ArangoDB versions.\n Changes (see below) are applied when the collection is loaded the next\n time.\n This option is meaningful for the MMFiles storage engine only.\n - **distributeShardsLike**: (The default is *\"\"*): in an Enterprise Edition cluster, this attribute binds\n the specifics of sharding for the newly created collection to follow that of a\n specified existing collection.\n **Note**: Using this parameter has consequences for the prototype\n collection. It can no longer be dropped, before sharding imitating\n collections are dropped. Equally, backups and restores of imitating\n collections alone will generate warnings, which can be overridden,\n about missing sharding prototype.\n\n\n\n\n\n**Example:**\n \n\n
\n\n\n\n\n**Example:**\n \n\ncurl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n
{ \n
\"name\" : \"testCollectionBasics\" \n
}\n
EOF\n
\n
HTTP/1.1 200 OK\n
content-type: application/json; charset=utf-8\n
x-content-type-options: nosniff\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"testCollectionBasics\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/101952\", \n
\"doCompact\" : true, \n
\"waitForSync\" : false, \n
\"id\" : \"101952\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n
{ \n
\"name\" : \"testCollectionEdges\", \n
\"type\" : 3 \n
}\n
EOF\n
\n
HTTP/1.1 200 OK\n
content-type: application/json; charset=utf-8\n
x-content-type-options: nosniff\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"testCollectionEdges\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 3, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/101955\", \n
\"doCompact\" : true, \n
\"waitForSync\" : false, \n
\"id\" : \"101955\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
\n\n\n\n\n", + "description": "\n\nCreates a new collection with a given name. The request must contain an\nobject with the following attributes.\n\n\n**A JSON object with these properties is required:**\n\n - **journalSize**: The maximal size of a journal or datafile in bytes. The value\n must be at least `1048576` (1 MiB). (The default is a configuration parameter)\n This option is meaningful for the MMFiles storage engine only.\n - **replicationFactor**: (The default is *1*): in a cluster, this attribute determines how many copies\n of each shard are kept on different DBServers. The value 1 means that only one\n copy (no synchronous replication) is kept. A value of k means that k-1 replicas\n are kept. Any two copies reside on different DBServers. Replication between them is \n synchronous, that is, every write operation to the \"leader\" copy will be replicated \n to all \"follower\" replicas, before the write operation is reported successful.\n If a server fails, this is detected automatically and one of the servers holding \n copies take over, usually without an error being reported.\n - **keyOptions**:\n - **allowUserKeys**: if set to *true*, then it is allowed to supply own key values in the\n *_key* attribute of a document. If set to *false*, then the key generator\n will solely be responsible for generating keys and supplying own key values\n in the *_key* attribute of documents is considered an error.\n - **type**: specifies the type of the key generator. The currently available generators are\n *traditional*, *autoincrement*, *uuid* and *padded*.\n The *traditional* key generator generates numerical keys in ascending order.\n The *autoincrement* key generator generates numerical keys in ascending order, \n the inital offset and the spacing can be configured\n The *padded* key generator generates keys of a fixed length (16 bytes) in\n ascending lexicographical sort order. This is ideal for usage with the _RocksDB_\n engine, which will slightly benefit keys that are inserted in lexicographically\n ascending order. The key generator can be used in a single-server or cluster.\n The *uuid* key generator generates universally unique 128 bit keys, which \n are stored in hexadecimal human-readable format. This key generator can be used\n in a single-server or cluster to generate \"seemingly random\" keys. The keys \n produced by this key generator are not lexicographically sorted.\n - **increment**: increment value for *autoincrement* key generator. Not used for other key\n generator types.\n - **offset**: Initial offset value for *autoincrement* key generator.\n Not used for other key generator types.\n - **name**: The name of the collection.\n - **waitForSync**: If *true* then the data is synchronized to disk before returning from a\n document create, update, replace or removal operation. (default: false)\n - **doCompact**: whether or not the collection will be compacted (default is *true*)\n This option is meaningful for the MMFiles storage engine only.\n - **shardingStrategy**: This attribute specifies the name of the sharding strategy to use for \n the collection. Since ArangoDB 3.4 there are different sharding strategies \n to select from when creating a new collection. The selected *shardingStrategy* \n value will remain fixed for the collection and cannot be changed afterwards. \n This is important to make the collection keep its sharding settings and\n always find documents already distributed to shards using the same\n initial sharding algorithm.\n The available sharding strategies are:\n - *community-compat*: default sharding used by ArangoDB community\n versions before ArangoDB 3.4\n - *enterprise-compat*: default sharding used by ArangoDB enterprise\n versions before ArangoDB 3.4\n - *enterprise-smart-edge-compat*: default sharding used by smart edge\n collections in ArangoDB enterprise versions before ArangoDB 3.4\n - *hash*: default sharding used by ArangoDB 3.4 for new collections\n (excluding smart edge collections)\n - *enterprise-hash-smart-edge*: default sharding used by ArangoDB 3.4 \n for new smart edge collections\n If no sharding strategy is specified, the default will be *hash* for\n all collections, and *enterprise-hash-smart-edge* for all smart edge\n collections (requires the *Enterprise Edition* of ArangoDB). \n Manually overriding the sharding strategy does not yet provide a \n benefit, but it may later in case other sharding strategies are added.\n - **isVolatile**: If *true* then the collection data is kept in-memory only and not made persistent.\n Unloading the collection will cause the collection data to be discarded. Stopping\n or re-starting the server will also cause full loss of data in the\n collection. Setting this option will make the resulting collection be\n slightly faster than regular collections because ArangoDB does not\n enforce any synchronization to disk and does not calculate any CRC\n checksums for datafiles (as there are no datafiles). This option\n should therefore be used for cache-type collections only, and not\n for data that cannot be re-created otherwise.\n (The default is *false*)\n This option is meaningful for the MMFiles storage engine only.\n - **shardKeys**: (The default is *[ \"_key\" ]*): in a cluster, this attribute determines\n which document attributes are used to determine the target shard for documents.\n Documents are sent to shards based on the values of their shard key attributes.\n The values of all shard key attributes in a document are hashed,\n and the hash value is used to determine the target shard.\n **Note**: Values of shard key attributes cannot be changed once set.\n This option is meaningless in a single server setup.\n - **numberOfShards**: (The default is *1*): in a cluster, this value determines the\n number of shards to create for the collection. In a single\n server setup, this option is meaningless.\n - **isSystem**: If *true*, create a system collection. In this case *collection-name*\n should start with an underscore. End users should normally create non-system\n collections only. API implementors may be required to create system\n collections in very special occasions, but normally a regular collection will do.\n (The default is *false*)\n - **type**: (The default is *2*): the type of the collection to create.\n The following values for *type* are valid:\n - *2*: document collection\n - *3*: edge collection\n - **indexBuckets**: The number of buckets into which indexes using a hash\n table are split. The default is 16 and this number has to be a\n power of 2 and less than or equal to 1024.\n For very large collections one should increase this to avoid long pauses\n when the hash table has to be initially built or resized, since buckets\n are resized individually and can be initially built in parallel. For\n example, 64 might be a sensible value for a collection with 100\n 000 000 documents. Currently, only the edge index respects this\n value, but other index types might follow in future ArangoDB versions.\n Changes (see below) are applied when the collection is loaded the next\n time.\n This option is meaningful for the MMFiles storage engine only.\n - **distributeShardsLike**: (The default is *\"\"*): in an Enterprise Edition cluster, this attribute binds\n the specifics of sharding for the newly created collection to follow that of a\n specified existing collection.\n **Note**: Using this parameter has consequences for the prototype\n collection. It can no longer be dropped, before the sharding-imitating\n collections are dropped. Equally, backups and restores of imitating\n collections alone will generate warnings (which can be overridden)\n about missing sharding prototype.\n\n\n\n\n\n**Example:**\n \n\ncurl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n
{ \n
\"name\" : \"testCollectionUsers\", \n
\"keyOptions\" : { \n
\"type\" : \"autoincrement\", \n
\"increment\" : 5, \n
\"allowUserKeys\" : true \n
} \n
}\n
EOF\n
\n
HTTP/1.1 200 OK\n
content-type: application/json; charset=utf-8\n
x-content-type-options: nosniff\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"testCollectionUsers\", \n
\"keyOptions\" : { \n
\"type\" : \"autoincrement\", \n
\"allowUserKeys\" : true, \n
\"offset\" : 0, \n
\"increment\" : 5, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/101960\", \n
\"doCompact\" : true, \n
\"waitForSync\" : false, \n
\"id\" : \"101960\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
\n\n\n\n\n**Example:**\n \n\ncurl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n
{ \n
\"name\" : \"testCollectionBasics\" \n
}\n
EOF\n
\n
HTTP/1.1 200 OK\n
content-type: application/json; charset=utf-8\n
x-content-type-options: nosniff\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"testCollectionBasics\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/101952\", \n
\"doCompact\" : true, \n
\"waitForSync\" : false, \n
\"id\" : \"101952\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n
{ \n
\"name\" : \"testCollectionEdges\", \n
\"type\" : 3 \n
}\n
EOF\n
\n
HTTP/1.1 200 OK\n
content-type: application/json; charset=utf-8\n
x-content-type-options: nosniff\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"testCollectionEdges\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 3, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/101955\", \n
\"doCompact\" : true, \n
\"waitForSync\" : false, \n
\"id\" : \"101955\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -4865,7 +4869,7 @@ }, "/_api/collection/{collection-name}/properties": { "get": { - "description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync* attribute, and the *doCompact*, *journalSize*, \nand *isVolatile* attributes for the MMFiles storage engine.\nThis is achieved by forcing a load of the underlying collection.\n\n- *waitForSync*: If *true* then creating, changing or removing\n documents will wait until the data has been synchronized to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n This option is only present for the MMFiles storage engine.\n\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\n This option is only present for the MMFiles storage engine.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional*, *autoincrement*, *uuid*\n and *padded*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n This option is only present for the MMFiles storage engine.\n\nIn a cluster setup, the result will also contain the following attributes:\n- *numberOfShards*: the number of shards of the collection.\n\n- *shardKeys*: contains the names of document attributes that are used to\n determine the target shard for documents.\n\n- *replicationFactor*: contains how many copies of each shard are kept on different DBServers.\n\n\n\n\n**Example:**\n Using an identifier:\n\ncurl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n
{ \n
\"name\" : \"testCollectionUsers\", \n
\"keyOptions\" : { \n
\"type\" : \"autoincrement\", \n
\"increment\" : 5, \n
\"allowUserKeys\" : true \n
} \n
}\n
EOF\n
\n
HTTP/1.1 200 OK\n
content-type: application/json; charset=utf-8\n
x-content-type-options: nosniff\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"testCollectionUsers\", \n
\"keyOptions\" : { \n
\"type\" : \"autoincrement\", \n
\"allowUserKeys\" : true, \n
\"offset\" : 0, \n
\"increment\" : 5, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/101960\", \n
\"doCompact\" : true, \n
\"waitForSync\" : false, \n
\"id\" : \"101960\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
\n\n\n\n\n**Example:**\n Using a name:\n\ncurl --dump - http://localhost:8529/_api/collection/102332/properties\n
\n
HTTP/1.1 200 OK\n
x-content-type-options: nosniff\n
content-type: application/json; charset=utf-8\n
location: /_api/collection/102332/properties\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"products\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/102332\", \n
\"doCompact\" : true, \n
\"waitForSync\" : true, \n
\"id\" : \"102332\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
\n\n\n\n\n", + "description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync* attribute, and the *doCompact*, *journalSize*, \nand *isVolatile* attributes for the MMFiles storage engine.\nThis is achieved by forcing a load of the underlying collection.\n\n- *waitForSync*: If *true* then creating, changing or removing\n documents will wait until the data has been synchronized to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n This option is only present for the MMFiles storage engine.\n\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\n This option is only present for the MMFiles storage engine.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional*, *autoincrement*, *uuid*\n and *padded*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n This option is only present for the MMFiles storage engine.\n\nIn a cluster setup, the result will also contain the following attributes:\n- *numberOfShards*: the number of shards of the collection.\n\n- *shardKeys*: contains the names of document attributes that are used to\n determine the target shard for documents.\n\n- *replicationFactor*: contains how many copies of each shard are kept on different DBServers.\n\n- *shardingStrategy*: the sharding strategy selected for the collection.\n\n\n\n\n**Example:**\n Using an identifier:\n\ncurl --dump - http://localhost:8529/_api/collection/products/properties\n
\n
HTTP/1.1 200 OK\n
x-content-type-options: nosniff\n
content-type: application/json; charset=utf-8\n
location: /_api/collection/products/properties\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"products\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/102337\", \n
\"doCompact\" : true, \n
\"waitForSync\" : true, \n
\"id\" : \"102337\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
\n\n\n\n\n**Example:**\n Using a name:\n\ncurl --dump - http://localhost:8529/_api/collection/102332/properties\n
\n
HTTP/1.1 200 OK\n
x-content-type-options: nosniff\n
content-type: application/json; charset=utf-8\n
location: /_api/collection/102332/properties\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"products\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/102332\", \n
\"doCompact\" : true, \n
\"waitForSync\" : true, \n
\"id\" : \"102332\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", diff --git a/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html b/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html index dabda3f269..d620f516e1 100644 --- a/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html +++ b/js/apps/system/_admin/aardvark/APP/frontend/build/index-min.html @@ -3501,4 +3501,4 @@ var cutByResolution = function (str) {curl --dump - http://localhost:8529/_api/collection/products/properties\n
\n
HTTP/1.1 200 OK\n
x-content-type-options: nosniff\n
content-type: application/json; charset=utf-8\n
location: /_api/collection/products/properties\n
\n
{ \n
\"error\" : false, \n
\"code\" : 200, \n
\"status\" : 3, \n
\"statusString\" : \"loaded\", \n
\"name\" : \"products\", \n
\"keyOptions\" : { \n
\"type\" : \"traditional\", \n
\"allowUserKeys\" : true, \n
\"lastValue\" : 0 \n
}, \n
\"type\" : 2, \n
\"indexBuckets\" : 8, \n
\"globallyUniqueId\" : \"h4B4326755FEE/102337\", \n
\"doCompact\" : true, \n
\"waitForSync\" : true, \n
\"id\" : \"102337\", \n
\"isSystem\" : false, \n
\"journalSize\" : 33554432, \n
\"isVolatile\" : false \n
}\n