CBFS Storage 2020 Node.js Edition

Questions / Feedback?

AutoCompactAt Property

The free space percentage threshold a vault must reach to be eligible for automatic compaction.

Syntax

 cbvault.getAutoCompactAt([callback])
 cbvault.setAutoCompactAt( autoCompactAt, [callback])

Default Value

25

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAutoCompactAt([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAutoCompactAt([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies the percentage of free space a vault must have, at minimum, in order for it to be eligible for automatic vault compaction. An eligible vault may be compacted automatically in the background at any time. Please refer to the CompactVault method for more information about the compacting process itself.

To help guard against excessive automatic compaction operations, applications can set the AutoCompactDelay configuration setting to a non-zero value. Alternatively, this property can be set to 0 to disable automatic compaction completely.

A vault opened in ReadOnly mode will never be compacted, regardless of this property's value.

Note: This property cannot be changed within events.

Data Type

Integer

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 Node.js Edition - Version 20.0 [Build 7922]