Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

documentation

This commit is contained in:
Jan Steemann 2014-03-03 10:40:29 +01:00
parent 8041752f4f
commit 65bc5dddad
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
arangod/V8Server/v8-vocbase.cpp
View File

@ -7018,6 +7018,12 @@ static v8::Handle<v8::Value> JS_PlanIdVocbaseCol (v8::Arguments const& argv) {
/// - @LIT{offset}: initial offset value for @LIT{autoincrement} key generator.
/// Not used for other key generator types.
///
/// In a cluster setup, the result will also contain the following attributes:
/// - `numberOfShards`: the number of shards of the collection.
///
/// - `shardKeys`: contains the names of document attributes that are used to
/// determine the target shard for documents.
///
/// @FUN{@FA{collection}.properties(@FA{properties})}
///
/// Changes the collection properties. @FA{properties} must be a object with

14
js/actions/api-collection.js
View File

@ -246,7 +246,7 @@ function parseBodyForCreateCollection (req, res) {
/// - `shardKeys` (optional, default is `[ "_key" ]`): in a cluster, this
/// attribute determines which document attributes are used to determine the
/// target shard for documents. Documents are sent to shards based on the
/// values they have in their shard key attributes. The values of all shard
/// values of their shard key attributes. The values of all shard
/// key attributes in a document are hashed, and the hash value is used to
/// determine the target shard. Note that values of shard key attributes cannot
/// be changed once set.
@ -471,7 +471,7 @@ function get_api_collections (req, res) {
///
/// @RESTDESCRIPTION
/// In addition to the above, the result will always contain the
/// `waitForSync`, `doCompact`, `journalSize`, and `isVolatile` properties.
/// `waitForSync`, `doCompact`, `journalSize`, and `isVolatile` attributes.
/// This is achieved by forcing a load of the underlying collection.
///
/// - `waitForSync`: If `true` then creating or changing a
@ -485,6 +485,11 @@ function get_api_collections (req, res) {
/// kept in memory only and ArangoDB will not write or sync the data
/// to disk.
///
/// In a cluster setup, the result will also contain the following attributes:
/// - `numberOfShards`: the number of shards of the collection.
///
/// - `shardKeys`: contains the names of document attributes that are used to
/// determine the target shard for documents.
/// @RESTRETURNCODES
///
/// @RESTRETURNCODE{400}
@ -1181,8 +1186,9 @@ function put_api_collection_truncate (req, res, collection) {
/// - 2: document collection
/// - 3: edges collection
///
/// Note: some other collection properties, such as `type` or `isVolatile`
/// cannot be changed once the collection is created.
/// Note: some other collection properties, such as `type`, `isVolatile`,
/// `numberOfShards` or `shardKeys` cannot be changed once a collection is
/// created.
///
/// @EXAMPLES
///