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

issue #1109: added *bytes* unit to API description where missing

This commit is contained in:
Jan Steemann 2014-11-20 15:04:40 +01:00
parent 5f453b80e5
commit 4f74ed429c
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -188,11 +188,9 @@ function parseBodyForCreateCollection (req, res) {
/// - *doCompact* (optional, default is *true*): whether or not the collection /// - *doCompact* (optional, default is *true*): whether or not the collection
/// will be compacted. /// will be compacted.
/// ///
/// - *journalSize* (optional, default is a /// - *journalSize* (optional, default is a configuration parameter): The
/// configuration parameter): The maximal size of /// maximal size of a journal or datafile in bytes. The value
/// a journal or datafile. /// must be at least `1048576` (1 MB).
/// **Note**: This also limits the maximal
/// size of a single object. Must be at least 1MB.
/// ///
/// - *isSystem* (optional, default is *false*): If *true*, create a /// - *isSystem* (optional, default is *false*): If *true*, create a
/// system collection. In this case *collection-name* should start with /// system collection. In this case *collection-name* should start with
@ -476,7 +474,8 @@ function get_api_collections (req, res) {
/// ///
/// - *doCompact*: Whether or not the collection will be compacted. /// - *doCompact*: Whether or not the collection will be compacted.
/// ///
/// - *journalSize*: The maximal size setting for journals / datafiles. /// - *journalSize*: The maximal size setting for journals / datafiles
/// in bytes.
/// ///
/// - *isVolatile*: If *true* then the collection data will be /// - *isVolatile*: If *true* then the collection data will be
/// kept in memory only and ArangoDB will not write or sync the data /// kept in memory only and ArangoDB will not write or sync the data
@ -661,7 +660,7 @@ function get_api_collections (req, res) {
/// log for this collection that have not been transferred to journals or /// log for this collection that have not been transferred to journals or
/// datafiles. /// datafiles.
/// ///
/// - *journalSize*: The maximal size of the journal in bytes. /// - *journalSize*: The maximal size of a journal or datafile in bytes.
/// ///
/// **Note**: collection data that are stored in the write-ahead log only are /// **Note**: collection data that are stored in the write-ahead log only are
/// not reported in the results. When the write-ahead log is collected, documents /// not reported in the results. When the write-ahead log is collected, documents
@ -1203,8 +1202,11 @@ function put_api_collection_truncate (req, res, collection) {
/// - *waitForSync*: If *true* then creating or changing a /// - *waitForSync*: If *true* then creating or changing a
/// document will wait until the data has been synchronised to disk. /// document will wait until the data has been synchronised to disk.
/// ///
/// - *journalSize*: Size (in bytes) for new journal files that are /// - *journalSize*: The maximal size of a journal or datafile in bytes.
/// created for the collection. /// The value must be at least `1048576` (1 MB). Note that when
/// changing the journalSize value, it will only have an effect for
/// additional journals or datafiles that are created. Already
/// existing journals or datafiles will not be affected.
/// ///
/// If returns an object with the attributes /// If returns an object with the attributes
/// ///