Skip to content

README.md

Latest commit

 

History

History
104 lines (80 loc) · 2.29 KB

README.md

File metadata and controls

104 lines (80 loc) · 2.29 KB

Auto Remove Plugin

This plugin removes records from resources based on count-based or time-based rules.

It is designed for cleaning up:

  • old records
  • logs
  • demo/test data
  • temporary entities

Installation

To install the plugin:

npm install @adminforth/auto-remove

Import it into your resource:

import AutoRemovePlugin from '../../plugins/adminforth-auto-remove/index.js';

Plugin Options

export interface PluginOptions {
 createdAtField: string;

  /**
   * - count-based: Delete items > keepAtLeast
   * - time-based: Delete age > deleteOlderThan
   */
  mode: AutoRemoveMode;

  /**
   * for count-based mode (100', '1k', '10k', '1m')
   */
  keepAtLeast?: HumanNumber;

  /**
   * Minimum number of items to always keep in count-based mode.
   * This acts as a safety threshold together with `keepAtLeast`.
   * Example formats: '100', '1k', '10k', '1m'.
   * 
   * Validation ensures that minItemsKeep <= keepAtLeast. 
  */
  minItemsKeep?: HumanNumber;

  /**
   * Max age of item for time-based mode ('1d', '7d', '1mo', '1y')
   */
  deleteOlderThan?: HumanDuration;

  /**
   * Interval for running cleanup (e.g. '1h', '1d')
   * Default '1d'
   */
  interval?: HumanDuration;
}

Usage

To use the plugin, add it to your resource file. Here's an example:

for count-based mode

new AutoRemovePlugin({
        createdAtField: 'created_at',   
        mode: 'count-based',            
        keepAtLeast: '200',                  
        interval: '1mo',                  
        minItemsKeep: '180',       
      }),

for time-based mode

new AutoRemovePlugin({
        createdAtField: 'created_at',
        mode: 'time-based',
        deleteOlderThan: '3mo',
        interval: '1mo',  
      }),

Result

After running AutoRemovePlugin, old or excess records are deleted automatically:

  • Count-based mode: keeps the newest keepAtLeast records, deletes older ones.
    Example: keepAtLeast = 500 → table with 650 records deletes 150 oldest.

  • Time-based mode: deletes records older than deleteOlderThan.
    Example: deleteOlderThan = '7d' → removes records older than 7 days.

  • Manual cleanup: POST /plugin/{pluginInstanceId}/cleanup, returns { "ok": true }.

Logs show how many records were removed per run.