@tachybase/plugin-database-clean 1.6.2

package/README.md

@@ -0,0 +1,134 @@
+# @tachybase/plugin-database-clean
+
+Database Clean Plugin - View table usage and clean database tables
+
+## Features
+
+- 📊 **Table Overview**: View whitelisted table usage including size, row count, creation time, update time
+- 🔍 **Data Filtering**: Filter by createdAt/updatedAt time ranges or ID range
+- 💾 **Data Backup**: Backup filtered data before cleaning (`.tbdump` format, compatible with module-backup)
+- 🗑️ **Data Cleanup**: Safe physical deletion with filtered data cleanup
+- 📦 **Batch Cleaning**: Support batch cleaning for large datasets (split by count or batch size, up to 1000 batches)
+- 🔄 **Space Release**: Optional VACUUM FULL to release disk space after cleaning
+- 🔒 **Security Control**: Whitelist mechanism, only allows operations on specified tables
+- 🏗️ **Database Adapter**: Extensible adapter architecture supporting PostgreSQL, MySQL, and SQLite
+
+## Installation
+
+```bash
+pnpm pm add @tachybase/plugin-database-clean
+pnpm pm enable @tachybase/plugin-database-clean
+```
+
+## Usage
+
+### Configure Whitelist
+
+Configure whitelist tables in `src/server/constants.ts`:
+
+```typescript
+export const WHITELIST_TABLES = [
+  'users',
+  'orders',
+  'logs',
+];
+```
+
+### Permission Configuration
+
+The plugin automatically registers ACL snippet: `pm.database-clean.*`
+
+Configure corresponding permissions in role permissions to use.
+
+## UI Workflow
+
+1. **Table List Page**: View all whitelisted tables with their size, row count, and time info
+2. **Table Detail Page**: 
+   - View table data with pagination
+   - Filter by time range (createdAt/updatedAt) or ID range
+   - Click "Clean" button to start the cleaning workflow
+3. **Cleaning Workflow**:
+   - Step 1: Choose to backup first or clean directly
+   - Step 2: If backup, optionally download the backup file
+   - Step 3: Configure batch settings (no batch / split into N batches / N records per batch)
+   - Step 4: Choose to release disk space (VACUUM FULL) or clean only
+   - During cleaning: Button shows progress like "(1/100) Cleaning..."
+
+## API
+
+### Get Table List
+
+```
+GET /databaseClean:list
+```
+
+### Get Table Info
+
+```
+GET /databaseClean:get?filterByTk=tableName
+```
+
+Returns: Table info including `hasCreatedAt`, `hasUpdatedAt`, `minId`, `maxId`
+
+### Get Table Data
+
+```
+GET /databaseClean:data?filterByTk=tableName&page=1&pageSize=20&filter=...
+```
+
+Returns: Paginated data with `filteredMinId`, `filteredMaxId` for batch cleaning support
+
+### Backup Data
+
+```
+POST /databaseClean:backup
+{
+  "collectionName": "users",
+  "filter": {
+    "createdAt": {
+      "$gte": "2024-01-01T00:00:00Z",
+      "$lte": "2024-12-31T23:59:59Z"
+    }
+  }
+}
+```
+
+### Clean Data
+
+```
+POST /databaseClean:clean
+{
+  "collectionName": "users",
+  "filter": {
+    "createdAt": {
+      "$gte": "2024-01-01T00:00:00Z",
+      "$lte": "2024-12-31T23:59:59Z"
+    }
+  },
+  "vacuumFull": true  // Optional: Execute VACUUM FULL after cleaning (release disk space)
+}
+```
+
+### Download Backup File
+
+```
+GET /databaseClean:download?filterByTk=db-clean_users_20240101_120000.tbdump
+```
+
+## Backup File Format
+
+Backup files use `.tbdump` format (compatible with `module-backup`):
+- Filename: `db-clean_{tableName}_{filterRange}_{timestamp}_{random}.tbdump`
+- Contains: JSON-formatted data with meta information
+- Can be restored using standard backup restore procedures
+
+## Notes
+
+- Supports PostgreSQL, MySQL, and SQLite databases
+- Only allows operations on whitelisted tables
+- Backup is optional before cleanup (recommended but not required)
+- Cleanup operations are physical deletions, please use with caution
+- **VACUUM FULL** (PostgreSQL): Locks the table during execution, may take a long time for large tables
+- **OPTIMIZE TABLE** (MySQL): Reclaims space and defragments the table
+- **VACUUM** (SQLite): Rebuilds the entire database file
+- **Batch Cleaning**: For large datasets (>50,000 records), it's recommended to use batch cleaning to avoid long-running transactions

package/README.zh-CN.md

@@ -0,0 +1,136 @@
+# @tachybase/plugin-database-clean
+
+数据库清理插件 - 用于查看数据表占用和清理数据表
+
+## 功能特性
+
+- 📊 **表概览**：查看白名单数据表的占用大小、数据条数、创建时间、更新时间
+- 🔍 **数据筛选**：支持按 createdAt/updatedAt 时间范围或 ID 范围筛选
+- 💾 **数据备份**：清理前备份筛选数据（`.tbdump` 格式，兼容 module-backup）
+- 🗑️ **数据清理**：安全的物理删除操作，支持筛选数据清理
+- 📦 **分批清理**：支持大数据量分批清理（按批数或每批条数分割，最多 1000 批）
+- 🔄 **空间释放**：清理后可选执行 VACUUM FULL 释放磁盘空间
+- 🔒 **安全控制**：白名单机制，只允许操作指定的表
+- 🏗️ **数据库适配器**：可扩展的适配器架构，支持 PostgreSQL、MySQL 和 SQLite
+
+## 安装
+
+```bash
+pnpm pm add @tachybase/plugin-database-clean
+pnpm pm enable @tachybase/plugin-database-clean
+```
+
+## 使用
+
+### 配置白名单
+
+在 `src/server/constants.ts` 中配置白名单表：
+
+```typescript
+export const WHITELIST_TABLES = [
+  'users',
+  'orders',
+  'logs',
+];
+```
+
+### 权限配置
+
+插件会自动注册 ACL snippet：`pm.database-clean.*`
+
+在角色权限中配置相应权限即可使用。
+
+## 界面操作流程
+
+1. **表列表页面**：查看所有白名单表的大小、数据条数和时间信息
+2. **表详情页面**：
+   - 分页查看表数据
+   - 按时间范围（createdAt/updatedAt）或 ID 范围筛选
+   - 点击"清理"按钮开始清理流程
+3. **清理流程**：
+   - 第一步：选择先备份还是直接清理
+   - 第二步：如果备份，可选择下载备份文件
+   - 第三步：配置分批设置（不分批 / 分为 N 批 / 每批 N 条）
+   - 第四步：选择是否释放磁盘空间（VACUUM FULL）
+   - 清理过程中：按钮显示进度，如 "(1/100) 清理中..."
+
+## API
+
+### 获取表列表
+
+```
+GET /databaseClean:list
+```
+
+### 获取表信息
+
+```
+GET /databaseClean:get?filterByTk=表名
+```
+
+返回：表信息，包含 `hasCreatedAt`、`hasUpdatedAt`、`minId`、`maxId`
+
+### 获取表数据
+
+```
+GET /databaseClean:data?filterByTk=表名&page=1&pageSize=20&filter=...
+```
+
+返回：分页数据，包含 `filteredMinId`、`filteredMaxId` 用于分批清理
+
+### 备份数据
+
+```
+POST /databaseClean:backup
+{
+  "collectionName": "users",
+  "filter": {
+    "createdAt": {
+      "$gte": "2024-01-01T00:00:00Z",
+      "$lte": "2024-12-31T23:59:59Z"
+    }
+  }
+}
+```
+
+### 清理数据
+
+```
+POST /databaseClean:clean
+{
+  "collectionName": "users",
+  "filter": {
+    "createdAt": {
+      "$gte": "2024-01-01T00:00:00Z",
+      "$lte": "2024-12-31T23:59:59Z"
+    }
+  },
+  "vacuumFull": true  // 可选：清理后执行 VACUUM FULL（释放磁盘空间）
+}
+```
+
+### 下载备份文件
+
+```
+GET /databaseClean:download?filterByTk=db-clean_users_20240101_120000.tbdump
+```
+
+## 备份文件格式
+
+备份文件使用 `.tbdump` 格式（兼容 `module-backup`）：
+- 文件名：`db-clean_{表名}_{筛选范围}_{时间戳}_{随机数}.tbdump`
+- 内容：JSON 格式的数据及元信息
+- 可通过标准备份恢复流程进行恢复
+
+## 注意事项
+
+- 支持 PostgreSQL、MySQL 和 SQLite 数据库
+- 只允许操作白名单中的表
+- 清理前备份是可选的（建议备份但不强制）
+- 清理操作是物理删除，请谨慎操作
+- **VACUUM FULL**（PostgreSQL）：执行时会锁定数据表，对于大表可能需要较长时间
+- **OPTIMIZE TABLE**（MySQL）：回收空间并整理表碎片
+- **VACUUM**（SQLite）：重建整个数据库文件
+- **分批清理**：对于大数据量（超过 5 万条），建议使用分批清理以避免长时间事务
+- **索引维护**：所有数据库在执行 DELETE 操作时会自动维护索引，无需手动重建
+

package/client.d.ts

@@ -0,0 +1,2 @@
+export * from './dist/client';
+export { default } from './dist/client';

package/client.js

@@ -0,0 +1 @@
+module.exports = require('./dist/client/index.js');

package/dist/client/index.d.ts

@@ -0,0 +1 @@
+export { default } from './plugin';

package/dist/client/index.js

@@ -0,0 +1 @@
+(function(p,u){typeof exports=="object"&&typeof module!="undefined"?u(exports,require("@tachybase/client"),require("react/jsx-runtime"),require("react"),require("@ant-design/icons"),require("antd"),require("dayjs"),require("react-router-dom")):typeof define=="function"&&define.amd?define(["exports","@tachybase/client","react/jsx-runtime","react","@ant-design/icons","antd","dayjs","react-router-dom"],u):(p=typeof globalThis!="undefined"?globalThis:p||self,u(p["@tachybase/plugin-database-clean"]={},p["@tachybase/client"],p.jsxRuntime,p.react,p["@ant-design/icons"],p.antd,p.dayjs,p["react-router-dom"]))})(this,function(p,u,e,r,I,a,P,j){"use strict";var ut=Object.defineProperty,ht=Object.defineProperties;var pt=Object.getOwnPropertyDescriptors;var Ee=Object.getOwnPropertySymbols;var ft=Object.prototype.hasOwnProperty,gt=Object.prototype.propertyIsEnumerable;var Ne=(p,u,e)=>u in p?ut(p,u,{enumerable:!0,configurable:!0,writable:!0,value:e}):p[u]=e,v=(p,u)=>{for(var e in u||(u={}))ft.call(u,e)&&Ne(p,e,u[e]);if(Ee)for(var e of Ee(u))gt.call(u,e)&&Ne(p,e,u[e]);return p},A=(p,u)=>ht(p,pt(u));var T=(p,u,e)=>new Promise((r,I)=>{var a=M=>{try{j(e.next(M))}catch(_){I(_)}},P=M=>{try{j(e.throw(M))}catch(_){I(_)}},j=M=>M.done?r(M.value):Promise.resolve(M.value).then(a,P);j((e=e.apply(p,u)).next())});const M="database-clean";function _(){const{i18n:t}=u.useApp();return{t:(w,f={})=>t.t(w,v({ns:[M,"client"],nsMode:"fallback"},f))}}var ne=typeof globalThis!="undefined"?globalThis:typeof window!="undefined"?window:typeof global!="undefined"?global:typeof self!="undefined"?self:{},oe={exports:{}},je=oe.exports,ye;function $e(){return ye||(ye=1,function(t,y){(function(w,f){f()})(je,function(){function w(o,i){return typeof i=="undefined"?i={autoBom:!1}:typeof i!="object"&&(console.warn("Deprecated: Expected third argument to be a object"),i={autoBom:!i}),i.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(o.type)?new Blob(["\uFEFF",o],{type:o.type}):o}function f(o,i,C){var c=new XMLHttpRequest;c.open("GET",o),c.responseType="blob",c.onload=function(){L(c.response,i,C)},c.onerror=function(){console.error("could not download file")},c.send()}function Y(o){var i=new XMLHttpRequest;i.open("HEAD",o,!1);try{i.send()}catch(C){}return 200<=i.status&&299>=i.status}function b(o){try{o.dispatchEvent(new MouseEvent("click"))}catch(C){var i=document.createEvent("MouseEvents");i.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),o.dispatchEvent(i)}}var g=typeof window=="object"&&window.window===window?window:typeof self=="object"&&self.self===self?self:typeof ne=="object"&&ne.global===ne?ne:void 0,W=g.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),L=g.saveAs||(typeof window!="object"||window!==g?function(){}:"download"in HTMLAnchorElement.prototype&&!W?function(o,i,C){var c=g.URL||g.webkitURL,k=document.createElement("a");i=i||o.name||"download",k.download=i,k.rel="noopener",typeof o=="string"?(k.href=o,k.origin===location.origin?b(k):Y(k.href)?f(o,i,C):b(k,k.target="_blank")):(k.href=c.createObjectURL(o),setTimeout(function(){c.revokeObjectURL(k.href)},4e4),setTimeout(function(){b(k)},0))}:"msSaveOrOpenBlob"in navigator?function(o,i,C){if(i=i||o.name||"download",typeof o!="string")navigator.msSaveOrOpenBlob(w(o,C),i);else if(Y(o))f(o,i,C);else{var c=document.createElement("a");c.href=o,c.target="_blank",setTimeout(function(){b(c)})}}:function(o,i,C,c){if(c=c||open("","_blank"),c&&(c.document.title=c.document.body.innerText="downloading..."),typeof o=="string")return f(o,i,C);var k=o.type==="application/octet-stream",K=/constructor/i.test(g.HTMLElement)||g.safari,h=/CriOS\/[\d]+/.test(navigator.userAgent);if((h||k&&K||W)&&typeof FileReader!="undefined"){var D=new FileReader;D.onloadend=function(){var B=D.result;B=h?B:B.replace(/^data:[^;]*;/,"data:attachment/file;"),c?c.location.href=B:location=B,c=null},D.readAsDataURL(o)}else{var O=g.URL||g.webkitURL,$=O.createObjectURL(o);c?c.location=$:location.href=$,c=null,setTimeout(function(){O.revokeObjectURL($)},4e4)}});g.saveAs=L.saveAs=L,t.exports=L})}(oe)),oe.exports}var Ve=$e();function J(t){const y={};if(t.createdAt&&t.createdAt[0]&&t.createdAt[1]){const w=P(t.createdAt[0]),f=P(t.createdAt[1]);w.isValid()&&f.isValid()&&(y.createdAt={$gte:w.startOf("day").toISOString(),$lte:f.endOf("day").toISOString()})}if(t.updatedAt&&t.updatedAt[0]&&t.updatedAt[1]){const w=P(t.updatedAt[0]),f=P(t.updatedAt[1]);w.isValid()&&f.isValid()&&(y.updatedAt={$gte:w.startOf("day").toISOString(),$lte:f.endOf("day").toISOString()})}return t.idRange&&(t.idRange[0]!==null||t.idRange[1]!==null)&&(y.id={},t.idRange[0]!==null&&(y.id.$gte=t.idRange[0]),t.idRange[1]!==null&&(y.id.$lte=t.idRange[1])),y}const qe=()=>{var Te,Be,me,Me,xe,Ie,Le,De,Oe,ze;const{t}=_(),y=u.useAPIClient(),w=j.useNavigate(),f=j.useLocation(),b=j.useParams().tableName||f.pathname.split("/").pop(),{message:g,modal:W,notification:L}=a.App.useApp(),[o,i]=r.useState(null),[C,c]=r.useState([]),[k,K]=r.useState(!1),[h,D]=r.useState(!1),[O,$]=r.useState(!1),[B,be]=r.useState(!1),[de,yt]=r.useState(!1),[Se,ue]=r.useState(null),[Ge,Q]=r.useState(!1),[He,Z]=r.useState(!1),[Xe,G]=r.useState(!1),[Je,le]=r.useState(!1),[Ye,he]=r.useState(null),[E,Qe]=r.useState({count:0,minId:null,maxId:null}),[V,we]=r.useState("none"),[se,Ze]=r.useState(10),[re,Re]=r.useState(1e4),[z,R]=r.useState(null),[ee,pe]=r.useState({current:1,pageSize:20,total:0}),[x,te]=r.useState({}),d=h||O||B||de,ae=r.useMemo(()=>y.resource("databaseClean"),[y]);r.useEffect(()=>{b&&Ce()},[b]),r.useEffect(()=>{b&&o&&ke()},[b,o,ee.current,ee.pageSize,x]);const Ce=()=>T(null,null,function*(){var n;if(b)try{const s=yield ae.get({filterByTk:b});i((n=s.data)==null?void 0:n.data)}catch(s){g.error(s.message||t("Failed to load table info")),w("/_admin/system-services/database-clean")}}),ke=()=>T(null,null,function*(){var n,s;if(b){K(!0);try{const l=J(x),m=yield ae.data({filterByTk:b,page:ee.current,pageSize:ee.pageSize,filter:Object.keys(l).length>0?l:void 0}),{data:q,meta:S}=m.data;c(Array.isArray(q)?q:[]),pe(H=>A(v({},H),{total:(S==null?void 0:S.count)||0})),Qe({count:(S==null?void 0:S.count)||0,minId:(n=S==null?void 0:S.filteredMinId)!=null?n:null,maxId:(s=S==null?void 0:S.filteredMaxId)!=null?s:null})}catch(l){g.error(l.message||t("Failed to load table data"))}finally{K(!1)}}}),ve=()=>T(null,null,function*(){yield Promise.all([Ce(),ke()])}),et=()=>T(null,null,function*(){var n,s;if(b){D(!0);try{const l=J(x),q=(s=(n=(yield ae.backup({values:{collectionName:b,filter:Object.keys(l).length>0?l:void 0}})).data)==null?void 0:n.data)==null?void 0:s.fileName;return ue(q),g.success(t("Backup Success")),q}catch(l){return g.error(l.message||t("Backup Failed")),null}finally{D(!1)}}}),tt=n=>T(null,null,function*(){const s=n||Se;if(s){$(!0);try{const l=yield y.request({url:"databaseClean:download",method:"get",params:{filterByTk:s},responseType:"blob"}),m=new Blob([l.data]);return Ve.saveAs(m,s),g.success(t("Download")+" "+t("Success")),!0}catch(l){return g.error(l.message||t("Download")+" "+t("Failed")),!1}finally{$(!1)}}}),at=()=>{Q(!0)},nt=()=>T(null,null,function*(){const n=yield et();n&&(ue(n),he(J(x)),Q(!1),Z(!0))}),ot=()=>T(null,null,function*(){(yield tt(Se))&&(Z(!1),G(!0))}),lt=()=>{Z(!1),G(!0)},st=()=>T(null,null,function*(){he(J(x)),Q(!1),G(!0)}),rt=()=>{G(!1),le(!0)},Ae=n=>T(null,null,function*(){le(!1),yield it(n)}),it=(n=!1)=>T(null,null,function*(){var s,l,m,q;if(b){be(!0),R(null);try{const S=Ye||J(x);let H=0;const{minId:ie,maxId:fe,count:Fe}=E;let U=[];if(V!=="none"&&ie!==null&&fe!==null&&Fe>0){const F=fe-ie+1;let N;V==="count"?N=se:N=Math.ceil(Fe/re),N=Math.max(1,N);const ce=Math.ceil(F/N);for(let X=0;X<N;X++){const Pe=ie+X*ce,ge=Math.min(ie+(X+1)*ce-1,fe);U.push({minId:Pe,maxId:ge})}}if(U.length>1){R({current:0,total:U.length,deletedCount:0});for(let F=0;F<U.length;F++){const N=U[F],ce=A(v({},S),{id:A(v({},S.id),{$gte:N.minId,$lte:N.maxId})}),X=F===U.length-1,ge=((l=(s=(yield ae.clean({values:{collectionName:b,filter:ce,vacuumFull:X&&n}})).data)==null?void 0:s.data)==null?void 0:l.deletedCount)||0;H+=ge,R({current:F+1,total:U.length,deletedCount:H})}}else H=((q=(m=(yield ae.clean({values:{collectionName:b,filter:Object.keys(S).length>0?S:void 0,vacuumFull:n}})).data)==null?void 0:m.data)==null?void 0:q.deletedCount)||0;g.success(t("Clean Success")+` (${H} ${t("records deleted")})`),n&&g.success(t("Space released successfully")),ue(null),he(null),R(null),we("none"),te({}),pe(F=>A(v({},F),{current:1})),yield ve()}catch(S){g.error(S.message||t("Clean Failed"))}finally{be(!1),R(null)}}}),ct=n=>{pe(s=>A(v({},s),{current:n.current,pageSize:n.pageSize}))},dt=r.useMemo(()=>{if(!C.length)return[];const n=C[0];return Object.keys(n).map(s=>({title:s,dataIndex:s,key:s,render:l=>l instanceof Date||typeof l=="string"&&l.match(/^\d{4}-\d{2}-\d{2}/)?e.jsx(u.DatePicker.ReadPretty,{value:P(l),showTime:!0}):typeof l=="object"&&l!==null?e.jsx("pre",{style:{margin:0},children:JSON.stringify(l,null,2)}):String(l)}))},[C]);return o?e.jsx("div",{children:e.jsx(a.Card,{bordered:!1,children:e.jsxs(a.Space,{direction:"vertical",style:{width:"100%"},size:"large",children:[e.jsxs("div",{children:[e.jsx("h2",{children:o.name}),e.jsxs(a.Space,{children:[e.jsxs("span",{children:[t("Origin"),": ",o.origin]}),e.jsx("span",{children:"|"}),e.jsxs("span",{children:[t("Size"),": ",Ue(o.size)]}),e.jsx("span",{children:"|"}),e.jsxs("span",{children:[t("Row Count"),": ",o.rowCount.toLocaleString()]})]})]}),e.jsx(a.Card,{size:"small",title:t("Filter"),children:e.jsxs(a.Space,{direction:"vertical",style:{width:"100%"},children:[o.hasCreatedAt&&e.jsxs("div",{children:[e.jsxs("label",{children:[t("Created At Range"),": "]}),e.jsx(u.DatePicker.RangePicker,{value:x.createdAt,onChange:n=>{te(s=>A(v({},s),{createdAt:n}))},showTime:!0,style:{width:400}})]}),o.hasUpdatedAt&&e.jsxs("div",{children:[e.jsxs("label",{children:[t("Updated At Range"),": "]}),e.jsx(u.DatePicker.RangePicker,{value:x.updatedAt,onChange:n=>{te(s=>A(v({},s),{updatedAt:n}))},showTime:!0,style:{width:400}})]}),e.jsxs("div",{children:[e.jsxs("label",{children:[t("ID Range"),": "]}),e.jsxs(a.Space,{children:[e.jsx(a.InputNumber,{placeholder:t("Min ID"),value:(Te=x.idRange)==null?void 0:Te[0],onChange:n=>{te(s=>{var m;const l=(m=s.idRange)==null?void 0:m[1];return n!==null&&l!==null&&n>l?A(v({},s),{idRange:[n,n]}):A(v({},s),{idRange:[n,l!=null?l:null]})})},style:{width:150},min:(Be=o.minId)!=null?Be:0,max:(xe=(Me=(me=x.idRange)==null?void 0:me[1])!=null?Me:o.maxId)!=null?xe:void 0}),e.jsx("span",{children:"-"}),e.jsx(a.InputNumber,{placeholder:t("Max ID"),value:(Ie=x.idRange)==null?void 0:Ie[1],onChange:n=>{te(s=>{var m;const l=(m=s.idRange)==null?void 0:m[0];return n!==null&&l!==null&&n<l?A(v({},s),{idRange:[n,n]}):A(v({},s),{idRange:[l!=null?l:null,n]})})},style:{width:150},min:(Oe=(De=(Le=x.idRange)==null?void 0:Le[0])!=null?De:o.minId)!=null?Oe:0,max:(ze=o.maxId)!=null?ze:void 0})]})]}),!o.hasCreatedAt&&!o.hasUpdatedAt&&e.jsx(a.Alert,{message:t("No time fields, use ID range filter"),type:"info",showIcon:!0})]})}),e.jsxs(a.Space,{children:[e.jsx(a.Button,{onClick:ve,icon:e.jsx(I.ReloadOutlined,{}),disabled:d,children:t("Refresh")}),e.jsx(a.Button,{danger:!0,icon:e.jsx(I.DeleteOutlined,{}),loading:B,disabled:d,onClick:at,children:B?z?`(${z.current}/${z.total}) ${t("Cleaning...")}`:t("Cleaning..."):t("Clean")})]}),e.jsx(a.Modal,{title:e.jsxs(a.Space,{children:[e.jsx(I.WarningOutlined,{style:{color:"#faad14"}}),t("Confirm Clean")]}),open:Ge,onCancel:()=>!d&&Q(!1),closable:!d,maskClosable:!d,keyboard:!d,footer:null,width:500,children:e.jsxs(a.Space,{direction:"vertical",style:{width:"100%"},size:"middle",children:[e.jsx(a.Alert,{message:t("This action cannot be undone"),description:t("Are you sure you want to clean the filtered data?"),type:"warning",showIcon:!0}),e.jsx(a.Typography.Text,{type:"secondary",children:t("It is recommended to backup before cleaning. You can also clean directly without backup.")}),e.jsxs(a.Space,{style:{width:"100%",justifyContent:"flex-end"},children:[e.jsx(a.Button,{onClick:()=>Q(!1),disabled:d,children:t("Cancel")}),e.jsx(a.Button,{icon:e.jsx(I.SaveOutlined,{}),loading:h,disabled:d,onClick:nt,children:t("Backup then Clean")}),e.jsx(a.Button,{danger:!0,icon:e.jsx(I.DeleteOutlined,{}),disabled:d,onClick:st,children:t("Clean directly")})]})]})}),e.jsx(a.Modal,{title:t("Backup Complete"),open:He,onCancel:()=>!d&&Z(!1),closable:!d,maskClosable:!d,keyboard:!d,footer:null,width:450,children:e.jsxs(a.Space,{direction:"vertical",style:{width:"100%"},size:"middle",children:[e.jsx(a.Typography.Text,{children:t("Do you want to download the backup file before cleaning?")}),e.jsxs(a.Space,{style:{width:"100%",justifyContent:"flex-end"},children:[e.jsx(a.Button,{onClick:()=>Z(!1),disabled:d,children:t("Cancel")}),e.jsx(a.Button,{onClick:lt,disabled:d,children:t("Skip download")}),e.jsx(a.Button,{type:"primary",icon:e.jsx(I.DownloadOutlined,{}),loading:O,disabled:d&&!O,onClick:ot,children:t("Download and continue")})]})]})}),e.jsx(a.Modal,{title:t("Batch Settings"),open:Xe,onCancel:()=>!d&&G(!1),closable:!d,maskClosable:!d,keyboard:!d,footer:null,width:550,children:e.jsxs(a.Space,{direction:"vertical",style:{width:"100%"},size:"middle",children:[e.jsxs(a.Typography.Text,{children:[t("Total records to clean"),": ",e.jsx("strong",{children:E.count.toLocaleString()})]}),e.jsx(a.Radio.Group,{value:V,onChange:n=>we(n.target.value),style:{width:"100%"},children:e.jsxs(a.Space,{direction:"vertical",style:{width:"100%"},children:[e.jsx(a.Radio,{value:"none",children:t("No batching")}),e.jsx(a.Radio,{value:"count",children:e.jsxs(a.Space,{children:[t("Split into"),e.jsx(a.InputNumber,{min:2,max:1e3,value:se,onChange:n=>n&&Ze(n),changeOnWheel:!0,disabled:V!=="count",style:{width:80}}),t("batches")]})}),e.jsx(a.Radio,{value:"size",children:e.jsxs(a.Space,{children:[t("Each batch"),e.jsx(a.InputNumber,{min:1e3,max:1e6,step:1e3,value:re,onChange:n=>n&&Re(n),changeOnWheel:!0,disabled:V!=="size",style:{width:100}}),t("records")]})})]})}),e.jsx(a.Alert,{type:"info",showIcon:!0,message:V==="none"?E.count>5e4?t("Will clean {{count}} records at once. Large data volume may take a long time.",{count:E.count.toLocaleString()}):t("Will clean {{count}} records at once.",{count:E.count.toLocaleString()}):V==="count"?t("Will clean {{count}} records in {{batches}} batches, {{perBatch}} records per batch.",{count:E.count.toLocaleString(),batches:se,perBatch:Math.ceil(E.count/se).toLocaleString()}):t("Will clean {{count}} records in {{batches}} batches, {{perBatch}} records per batch.",{count:E.count.toLocaleString(),batches:Math.ceil(E.count/re),perBatch:re.toLocaleString()})}),e.jsxs(a.Space,{style:{width:"100%",justifyContent:"flex-end"},children:[e.jsx(a.Button,{onClick:()=>G(!1),disabled:d,children:t("Cancel")}),e.jsx(a.Button,{type:"primary",onClick:rt,disabled:d,children:t("Next")})]})]})}),e.jsx(a.Modal,{title:e.jsxs(a.Space,{children:[e.jsx(I.WarningOutlined,{style:{color:"#faad14"}}),t("Release disk space")]}),open:Je,onCancel:()=>!d&&le(!1),closable:!d,maskClosable:!d,keyboard:!d,footer:null,width:550,children:e.jsxs(a.Space,{direction:"vertical",style:{width:"100%"},size:"middle",children:[z&&e.jsxs("div",{children:[e.jsxs(a.Typography.Text,{children:[t("Cleaning progress"),": ",z.current," / ",z.total," ",t("batches")]}),e.jsx(a.Progress,{percent:Math.round(z.current/z.total*100),status:"active"}),e.jsxs(a.Typography.Text,{type:"secondary",children:[t("Deleted"),": ",z.deletedCount.toLocaleString()," ",t("records")]})]}),!z&&e.jsxs(e.Fragment,{children:[e.jsx(a.Typography.Text,{children:t("Do you want to release disk space after cleaning?")}),e.jsx(a.Alert,{message:t("Release space warning"),description:e.jsxs(e.Fragment,{children:[t("Releasing space will lock the table and may take a long time for large tables. Other operations on this table will be blocked during the process."),V!=="none"&&e.jsxs(e.Fragment,{children:[e.jsx("br",{}),e.jsx("br",{}),t("Space will be released only after the last batch is completed.")]})]}),type:"warning",showIcon:!0}),e.jsxs(a.Space,{style:{width:"100%",justifyContent:"flex-end"},children:[e.jsx(a.Button,{onClick:()=>le(!1),disabled:d,children:t("Cancel")}),e.jsx(a.Button,{onClick:()=>Ae(!1),loading:B,disabled:d&&!B,children:t("Clean only")}),e.jsx(a.Button,{danger:!0,onClick:()=>Ae(!0),loading:B||de,disabled:d&&!(B||de),children:t("Clean and release space")})]})]})]})}),e.jsx(a.Table,{dataSource:C,loading:k,columns:dt,rowKey:(n,s)=>n.id||s,pagination:A(v({},ee),{showSizeChanger:!0,showTotal:n=>t("Total: {{total}}",{total:n})}),onChange:ct,scroll:{x:"max-content"}})]})})}):e.jsx("div",{style:{textAlign:"center",padding:50},children:e.jsx(a.Spin,{size:"large"})})};function Ue(t){if(t===0)return"0 B";const y=1024,w=["B","KB","MB","GB","TB"],f=Math.floor(Math.log(t)/Math.log(y));return Math.round(t/Math.pow(y,f)*100)/100+" "+w[f]}function _e(t){if(t===0)return"0 B";const y=1024,w=["B","KB","MB","GB","TB"],f=Math.floor(Math.log(t)/Math.log(y));return Math.round(t/Math.pow(y,f)*100)/100+" "+w[f]}const We=()=>{const{t}=_(),y=u.useAPIClient(),w=j.useNavigate(),{message:f}=a.App.useApp(),[Y,b]=r.useState([]),[g,W]=r.useState(!1),[L,o]=r.useState({current:1,pageSize:20,total:0}),i=r.useMemo(()=>y.resource("databaseClean"),[y]),C=r.useCallback(()=>T(null,null,function*(){yield c()}),[]);r.useEffect(()=>{c()},[L.current,L.pageSize]);const c=()=>T(null,null,function*(){W(!0);try{const h=yield i.list({params:{page:L.current,pageSize:L.pageSize}}),{data:D,meta:O}=h.data;b(Array.isArray(D)?D:[]),o($=>A(v({},$),{total:(O==null?void 0:O.count)||0}))}catch(h){f.error(h.message||t("Failed to load table list"))}finally{W(!1)}}),k=h=>{o(D=>A(v({},D),{current:h.current,pageSize:h.pageSize}))},K=[{title:t("Table Name"),dataIndex:"name",key:"name",render:h=>e.jsx("a",{onClick:()=>{w(`/_admin/system-services/database-clean/${h}`)},children:h})},{title:t("Origin"),dataIndex:"origin",key:"origin"},{title:t("Size"),dataIndex:"size",key:"size",render:h=>_e(h)},{title:t("Row Count"),dataIndex:"rowCount",key:"rowCount",render:h=>h.toLocaleString()},{title:t("Created At"),dataIndex:"createdAt",key:"createdAt",render:h=>h?e.jsx(u.DatePicker.ReadPretty,{value:P(h),showTime:!0}):"-"},{title:t("Updated At"),dataIndex:"updatedAt",key:"updatedAt",render:h=>h?e.jsx(u.DatePicker.ReadPretty,{value:P(h),showTime:!0}):"-"}];return e.jsx("div",{children:e.jsxs(a.Card,{bordered:!1,children:[e.jsx(a.Space,{style:{float:"right",marginBottom:16},children:e.jsx(a.Button,{onClick:C,icon:e.jsx(I.ReloadOutlined,{}),children:t("Refresh")})}),e.jsx(a.Table,{dataSource:Y,loading:g,columns:K,rowKey:"name",pagination:A(v({},L),{showSizeChanger:!0,showTotal:h=>t("Total: {{total}}",{total:h})}),onChange:k})]})})};class Ke extends u.Plugin{afterAdd(){return T(this,null,function*(){})}beforeLoad(){return T(this,null,function*(){})}load(){return T(this,null,function*(){this.app.systemSettingsManager.add("system-services."+M,{title:this.t("Database Clean"),icon:"DatabaseOutlined",Component:We,aclSnippet:"pm.database-clean.*",sort:-50}),this.app.systemSettingsManager.add("system-services."+M+"/:tableName",{title:this.t("Table Detail"),Component:qe,groupKey:"system-services."+M,aclSnippet:"pm.database-clean.*"})})}}p.default=Ke,Object.defineProperties(p,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/dist/client/locale.d.ts

@@ -0,0 +1,7 @@
+export declare const NAMESPACE = "database-clean";
+export declare function lang(key: string): string;
+export declare function generateNTemplate(key: string): string;
+export declare function useTranslation(): {
+    t: (key: string, props?: {}) => string;
+};
+export declare const tval: (key: string) => string;

package/dist/client/pages/TableDetail.d.ts

@@ -0,0 +1 @@
+export declare const TableDetail: () => import("react/jsx-runtime").JSX.Element;

package/dist/client/pages/TableList.d.ts

@@ -0,0 +1 @@
+export declare const TableList: () => import("react/jsx-runtime").JSX.Element;

package/dist/client/plugin.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from '@tachybase/client';
+declare class PluginPluginDatabaseClean extends Plugin {
+    afterAdd(): Promise<void>;
+    beforeLoad(): Promise<void>;
+    load(): Promise<void>;
+}
+export default PluginPluginDatabaseClean;

package/dist/externalVersion.js

@@ -0,0 +1,11 @@
+module.exports = {
+  "@tachybase/client": "1.6.1",
+  "@tego/server": "1.6.1",
+  "lodash": "4.17.21",
+  "react": "18.3.1",
+  "@ant-design/icons": "5.6.1",
+  "antd": "5.22.5",
+  "dayjs": "1.11.13",
+  "react-router-dom": "6.28.1",
+  "sequelize": "6.37.5"
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './server';
+export { default } from './server';

package/dist/index.js

@@ -0,0 +1,39 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var index_exports = {};
+__export(index_exports, {
+  default: () => import_server.default
+});
+module.exports = __toCommonJS(index_exports);
+__reExport(index_exports, require("./server"), module.exports);
+var import_server = __toESM(require("./server"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./server")
+});

package/dist/locale/en-US.json

@@ -0,0 +1,65 @@
+{
+  "Are you sure you want to clean the filtered data?": "Are you sure you want to clean the filtered data?",
+  "Backup Complete": "Backup Complete",
+  "Backup Failed": "Backup Failed",
+  "Backup Success": "Backup Success",
+  "Backup then Clean": "Backup then Clean",
+  "Batch Settings": "Batch Settings",
+  "Cancel": "Cancel",
+  "Clean": "Clean",
+  "Clean Failed": "Clean Failed",
+  "Clean Success": "Clean Success",
+  "Clean and release space": "Clean and release space",
+  "Clean directly": "Clean directly",
+  "Clean only": "Clean only",
+  "Cleaning progress": "Cleaning progress",
+  "Cleaning...": "Cleaning...",
+  "Confirm Clean": "Confirm Clean",
+  "Created At": "Created At",
+  "Created At Range": "Created At Range",
+  "Database Clean": "Database Clean",
+  "Deleted": "Deleted",
+  "Do you want to download the backup file before cleaning?": "Do you want to download the backup file before cleaning?",
+  "Do you want to release disk space after cleaning?": "Do you want to release disk space after cleaning?",
+  "Download": "Download",
+  "Download and continue": "Download and continue",
+  "Each batch": "Each batch",
+  "Failed": "Failed",
+  "Failed to load table data": "Failed to load table data",
+  "Failed to load table info": "Failed to load table info",
+  "Failed to load table list": "Failed to load table list",
+  "Failed to release space": "Failed to release space",
+  "Filter": "Filter",
+  "ID Range": "ID Range",
+  "It is recommended to backup before cleaning. You can also clean directly without backup.": "It is recommended to backup before cleaning. You can also clean directly without backup.",
+  "Max ID": "Max ID",
+  "Min ID": "Min ID",
+  "Next": "Next",
+  "No batching": "No batching",
+  "No time fields, use ID range filter": "This table has no time fields, you can use ID range filter",
+  "Origin": "Origin",
+  "Refresh": "Refresh",
+  "Release disk space": "Release disk space",
+  "Release space warning": "Release Space Warning",
+  "Releasing space will lock the table and may take a long time for large tables. Other operations on this table will be blocked during the process.": "Releasing space will lock the table and may take a long time for large tables. Other operations on this table will be blocked during the process.",
+  "Row Count": "Row Count",
+  "Size": "Size",
+  "Skip download": "Skip download",
+  "Space released successfully": "Space released successfully",
+  "Space will be released only after the last batch is completed.": "Space will be released only after the last batch is completed.",
+  "Split into": "Split into",
+  "Success": "Success",
+  "Table Detail": "Table Detail",
+  "Table Name": "Table Name",
+  "This action cannot be undone": "This action cannot be undone",
+  "Total records to clean": "Total records to clean",
+  "Total: {{total}}": "Total: {{total}}",
+  "Updated At": "Updated At",
+  "Updated At Range": "Updated At Range",
+  "Will clean {{count}} records at once.": "Will clean {{count}} records at once.",
+  "Will clean {{count}} records at once. Large data volume may take a long time.": "Will clean {{count}} records at once. Large data volume may take a long time.",
+  "Will clean {{count}} records in {{batches}} batches, {{perBatch}} records per batch.": "Will clean {{count}} records in {{batches}} batches, {{perBatch}} records per batch.",
+  "batches": "batches",
+  "records": "records",
+  "records deleted": "records deleted"
+}

package/dist/locale/zh-CN.json

@@ -0,0 +1,65 @@
+{
+  "Are you sure you want to clean the filtered data?": "确定要清理筛选后的数据吗？",
+  "Backup Complete": "备份完成",
+  "Backup Failed": "备份失败",
+  "Backup Success": "备份成功",
+  "Backup then Clean": "备份后清理",
+  "Batch Settings": "分批设置",
+  "Cancel": "取消",
+  "Clean": "清理",
+  "Clean Failed": "清理失败",
+  "Clean Success": "清理成功",
+  "Clean and release space": "清理并释放空间",
+  "Clean directly": "直接清理",
+  "Clean only": "仅清理",
+  "Cleaning progress": "清理进度",
+  "Cleaning...": "清理中...",
+  "Confirm Clean": "确认清理",
+  "Created At": "创建时间",
+  "Created At Range": "创建时间范围",
+  "Database Clean": "数据库清理",
+  "Deleted": "已删除",
+  "Do you want to download the backup file before cleaning?": "是否在清理前下载备份文件？",
+  "Do you want to release disk space after cleaning?": "是否在清理后释放磁盘空间？",
+  "Download": "下载",
+  "Download and continue": "下载并继续",
+  "Each batch": "每批",
+  "Failed": "失败",
+  "Failed to load table data": "加载表数据失败",
+  "Failed to load table info": "加载表信息失败",
+  "Failed to load table list": "加载表列表失败",
+  "Failed to release space": "释放空间失败",
+  "Filter": "筛选",
+  "ID Range": "ID 范围",
+  "It is recommended to backup before cleaning. You can also clean directly without backup.": "建议在清理前先备份数据。您也可以选择不备份直接清理。",
+  "Max ID": "最大 ID",
+  "Min ID": "最小 ID",
+  "Next": "下一步",
+  "No batching": "不分批",
+  "No time fields, use ID range filter": "该表没有时间字段，可以使用 ID 范围筛选",
+  "Origin": "来源",
+  "Refresh": "刷新",
+  "Release disk space": "释放磁盘空间",
+  "Release space warning": "释放空间警告",
+  "Releasing space will lock the table and may take a long time for large tables. Other operations on this table will be blocked during the process.": "释放空间会锁定数据表，对于大表可能需要较长时间。在此过程中，该表的其他操作将被阻塞。",
+  "Row Count": "数据条数",
+  "Size": "占用大小",
+  "Skip download": "跳过下载",
+  "Space released successfully": "空间释放成功",
+  "Space will be released only after the last batch is completed.": "空间将仅在最后一批清理完成后释放。",
+  "Split into": "分为",
+  "Success": "成功",
+  "Table Detail": "表详情",
+  "Table Name": "表名",
+  "This action cannot be undone": "此操作不可恢复",
+  "Total records to clean": "待清理数据总数",
+  "Total: {{total}}": "共 {{total}} 条",
+  "Updated At": "最近更新时间",
+  "Updated At Range": "更新时间范围",
+  "Will clean {{count}} records at once.": "将一次性清理 {{count}} 条数据。",
+  "Will clean {{count}} records at once. Large data volume may take a long time.": "将一次性清理 {{count}} 条数据，数据量较大可能需要较长时间。",
+  "Will clean {{count}} records in {{batches}} batches, {{perBatch}} records per batch.": "将清理 {{count}} 条数据，分 {{batches}} 批进行，每批 {{perBatch}} 条。",
+  "batches": "批",
+  "records": "条",
+  "records deleted": "条记录已删除"
+}

package/dist/node_modules/archiver/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2014 Chris Talkington, contributors.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.