外观
lib-purge 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793750735/FIN+5.3.1+lib-purge 中文整理基于 FIN 5.3.1
导读： 用于自动清理警报、历史等的清理扩展
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
概述（中译）
用于自动清理警报、历史等的清理扩展
API 正文（英文）
finSettings
| alarmPurgeEnable | Enables or disables the alarm purge module |
| alarmPurgeMaxAge | How old the alarm data has to be for purging |
| alarmPurgeNow | Will execute the alarm purge task immediately, using the given parameters |
| historyPurgeEnable | Enables or disables the history purge module |
| historyPurgeMaxAge | How old the history data has to be for purging |
| historyPurgeNow | Will execute the history purge task immediately, using the given parameters |
| snapshotPurgeEnable | Enables or disables the snapshot purge module |
| snapshotPurgeKeep | The number of local snapshots to keep |
| snapshotPurgeNow | Will execute the snapshot purge task immediately, using the given parameters |
| snapshotPurgeRemoteKeep | The number of remote snapshots to keep |
def
finSetting:alarmPurgeEnable
Enables or disables the alarm purge module
meta
| def | finSetting:alarmPurgeEnable |
| defVal | false |
| dis | Enable Alarm Purge |
| enum | See below |
| is | finSetting |
| kind | Bool |
| lib | lib:purge |
| order | purge:0 |
enum
| Disabled | |
| Enabled |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:alarmPurgeMaxAge
How old the alarm data has to be for purging
meta
| def | finSetting:alarmPurgeMaxAge |
| defVal | 30day |
| dis | Alarm Max Age |
| is | finSetting |
| kind | Number |
| lib | lib:purge |
| minVal | 1day |
| order | purge:2 |
| unit | day |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:alarmPurgeNow
Will execute the alarm purge task immediately, using the given parameters
meta
| def | finSetting:alarmPurgeNow |
| defVal | ✓ |
| dis | Run Alarm Purge |
| is | finSetting |
| kind | Marker |
| lib | lib:purge |
| order | purge:1 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:historyPurgeEnable
Enables or disables the history purge module
meta
| def | finSetting:historyPurgeEnable |
| defVal | false |
| dis | Enable History Purge |
| enum | See below |
| is | finSetting |
| kind | Bool |
| lib | lib:purge |
| order | purge:0 |
enum
| Disabled | |
| Enabled |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:historyPurgeMaxAge
How old the history data has to be for purging
meta
| def | finSetting:historyPurgeMaxAge |
| defVal | 6mo |
| dis | History Max Age |
| disKey | purgeExt::historyPurgeMaxAgeHistory |
| is | finSetting |
| kind | Number |
| lib | lib:purge |
| minVal | 1mo |
| order | purge:2 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:historyPurgeNow
Will execute the history purge task immediately, using the given parameters
meta
| def | finSetting:historyPurgeNow |
| defVal | ✓ |
| dis | Run History Purge |
| is | finSetting |
| kind | Marker |
| lib | lib:purge |
| order | purge:1 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotPurgeEnable
Enables or disables the snapshot purge module
meta
| def | finSetting:snapshotPurgeEnable |
| defVal | false |
| dis | Enable Snapshot Purge |
| enum | See below |
| is | finSetting |
| kind | Bool |
| lib | lib:purge |
| order | purge:0 |
enum
| Disabled | |
| Enabled |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotPurgeKeep
The number of local snapshots to keep
meta
| def | finSetting:snapshotPurgeKeep |
| defVal | 3 |
| dis | Max Local Snapshots |
| is | finSetting |
| kind | Number |
| lib | lib:purge |
| minVal | 1 |
| order | purge:2 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotPurgeNow
Will execute the snapshot purge task immediately, using the given parameters
meta
| def | finSetting:snapshotPurgeNow |
| defVal | ✓ |
| dis | Run Snapshot Purge |
| is | finSetting |
| kind | Marker |
| lib | lib:purge |
| order | purge:1 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotPurgeRemoteKeep
The number of remote snapshots to keep
meta
| def | finSetting:snapshotPurgeRemoteKeep |
| defVal | 10 |
| dis | Max Remote Snapshots |
| is | finSetting |
| kind | Number |
| lib | lib:purge |
| minVal | 1 |
| order | purge:3 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |