@nocobase/plugin-backups 2.1.0-beta.46 → 2.1.0-beta.47

package/dist/externalVersion.js

@@ -8,15 +8,15 @@
  */
 
 module.exports = {
-  "@nocobase/client": "2.1.0-beta.46",
+  "@nocobase/client": "2.1.0-beta.47",
   "react": "18.2.0",
-  "@nocobase/cache": "2.1.0-beta.46",
-  "@nocobase/lock-manager": "2.1.0-beta.46",
-  "@nocobase/server": "2.1.0-beta.46",
+  "@nocobase/cache": "2.1.0-beta.47",
+  "@nocobase/lock-manager": "2.1.0-beta.47",
+  "@nocobase/server": "2.1.0-beta.47",
   "lodash": "4.18.1",
-  "@nocobase/database": "2.1.0-beta.46",
+  "@nocobase/database": "2.1.0-beta.47",
   "sequelize": "6.35.2",
-  "@nocobase/test": "2.1.0-beta.46",
+  "@nocobase/test": "2.1.0-beta.47",
   "@formily/antd-v5": "1.2.3",
   "@formily/react": "2.3.7",
   "@formily/reactive": "2.3.7",
@@ -24,8 +24,8 @@ module.exports = {
   "antd": "5.24.2",
   "@ant-design/icons": "5.6.1",
   "ahooks": "3.7.8",
-  "@nocobase/plugin-file-manager": "2.1.0-beta.46",
-  "@nocobase/resourcer": "2.1.0-beta.46",
+  "@nocobase/plugin-file-manager": "2.1.0-beta.47",
+  "@nocobase/resourcer": "2.1.0-beta.47",
   "dayjs": "1.11.13",
-  "@nocobase/utils": "2.1.0-beta.46"
+  "@nocobase/utils": "2.1.0-beta.47"
 };

package/dist/node_modules/archiver/package.json

@@ -1 +1 @@
-{"name":"archiver","version":"5.3.2","description":"a streaming interface for archive generation","homepage":"https://github.com/archiverjs/node-archiver","author":{"name":"Chris Talkington","url":"http://christalkington.com/"},"repository":{"type":"git","url":"https://github.com/archiverjs/node-archiver.git"},"bugs":{"url":"https://github.com/archiverjs/node-archiver/issues"},"license":"MIT","main":"index.js","files":["index.js","lib"],"engines":{"node":">= 10"},"scripts":{"test":"mocha --reporter dot","bench":"node benchmark/simple/pack-zip.js"},"dependencies":{"archiver-utils":"^2.1.0","async":"^3.2.4","buffer-crc32":"^0.2.1","readable-stream":"^3.6.0","readdir-glob":"^1.1.2","tar-stream":"^2.2.0","zip-stream":"^4.1.0"},"devDependencies":{"archiver-jsdoc-theme":"^1.1.3","chai":"^4.3.7","jsdoc":"^3.6.4","mkdirp":"^2.1.5","mocha":"^9.0.2","rimraf":"^4.3.1","stream-bench":"^0.1.2","tar":"^6.1.13","yauzl":"^2.9.0"},"keywords":["archive","archiver","stream","zip","tar"],"publishConfig":{"registry":"https://registry.npmjs.org/"},"_lastModified":"2026-06-08T07:14:39.210Z"}
+{"name":"archiver","version":"5.3.2","description":"a streaming interface for archive generation","homepage":"https://github.com/archiverjs/node-archiver","author":{"name":"Chris Talkington","url":"http://christalkington.com/"},"repository":{"type":"git","url":"https://github.com/archiverjs/node-archiver.git"},"bugs":{"url":"https://github.com/archiverjs/node-archiver/issues"},"license":"MIT","main":"index.js","files":["index.js","lib"],"engines":{"node":">= 10"},"scripts":{"test":"mocha --reporter dot","bench":"node benchmark/simple/pack-zip.js"},"dependencies":{"archiver-utils":"^2.1.0","async":"^3.2.4","buffer-crc32":"^0.2.1","readable-stream":"^3.6.0","readdir-glob":"^1.1.2","tar-stream":"^2.2.0","zip-stream":"^4.1.0"},"devDependencies":{"archiver-jsdoc-theme":"^1.1.3","chai":"^4.3.7","jsdoc":"^3.6.4","mkdirp":"^2.1.5","mocha":"^9.0.2","rimraf":"^4.3.1","stream-bench":"^0.1.2","tar":"^6.1.13","yauzl":"^2.9.0"},"keywords":["archive","archiver","stream","zip","tar"],"publishConfig":{"registry":"https://registry.npmjs.org/"},"_lastModified":"2026-06-09T23:05:44.491Z"}

package/dist/node_modules/cron-parser/package.json

@@ -1 +1 @@
-{"name":"cron-parser","version":"4.4.0","description":"Node.js library for parsing crontab instructions","main":"lib/parser.js","types":"index.d.ts","typesVersions":{"<4.1":{"*":["types/ts3/*"]}},"directories":{"test":"test"},"scripts":{"test:tsd":"tsd","test:unit":"TZ=UTC tap ./test/*.js","test:cover":"TZ=UTC tap --coverage-report=html ./test/*.js","lint":"eslint .","lint:fix":"eslint --fix .","test":"npm run lint && npm run test:unit && npm run test:tsd"},"repository":{"type":"git","url":"https://github.com/harrisiirak/cron-parser.git"},"keywords":["cron","crontab","parser"],"author":"Harri Siirak","contributors":["Nicholas Clawson","Daniel Prentis <daniel@salsitasoft.com>","Renault John Lecoultre","Richard Astbury <richard.astbury@gmail.com>","Meaglin Wasabi <Meaglin.wasabi@gmail.com>","Mike Kusold <hello@mikekusold.com>","Alex Kit <alex.kit@atmajs.com>","Santiago Gimeno <santiago.gimeno@gmail.com>","Daniel <darc.tec@gmail.com>","Christian Steininger <christian.steininger.cs@gmail.com>","Mykola Piskovyi <m.piskovyi@gmail.com>","Brian Vaughn <brian.david.vaughn@gmail.com>","Nicholas Clawson <nickclaw@gmail.com>","Yasuhiroki <yasuhiroki.duck@gmail.com>","Nicholas Clawson <nickclaw@gmail.com>","Brendan Warkentin <faazshift@gmail.com>","Charlie Fish <fishcharlie.code@gmail.com>","Ian Graves <ian+diskimage@iangrav.es>","Andy Thompson <me@andytson.com>","Regev Brody <regevbr@gmail.com>"],"license":"MIT","dependencies":{"luxon":"^1.28.0"},"devDependencies":{"eslint":"^8.2.0","sinon":"^10.0.0","tap":"^16.0.1","tsd":"^0.19.0"},"engines":{"node":">=0.8"},"browser":{"fs":false},"tap":{"check-coverage":false},"tsd":{"directory":"test","compilerOptions":{"lib":["es2017","dom"]}},"_lastModified":"2026-06-08T07:14:37.805Z"}
+{"name":"cron-parser","version":"4.4.0","description":"Node.js library for parsing crontab instructions","main":"lib/parser.js","types":"index.d.ts","typesVersions":{"<4.1":{"*":["types/ts3/*"]}},"directories":{"test":"test"},"scripts":{"test:tsd":"tsd","test:unit":"TZ=UTC tap ./test/*.js","test:cover":"TZ=UTC tap --coverage-report=html ./test/*.js","lint":"eslint .","lint:fix":"eslint --fix .","test":"npm run lint && npm run test:unit && npm run test:tsd"},"repository":{"type":"git","url":"https://github.com/harrisiirak/cron-parser.git"},"keywords":["cron","crontab","parser"],"author":"Harri Siirak","contributors":["Nicholas Clawson","Daniel Prentis <daniel@salsitasoft.com>","Renault John Lecoultre","Richard Astbury <richard.astbury@gmail.com>","Meaglin Wasabi <Meaglin.wasabi@gmail.com>","Mike Kusold <hello@mikekusold.com>","Alex Kit <alex.kit@atmajs.com>","Santiago Gimeno <santiago.gimeno@gmail.com>","Daniel <darc.tec@gmail.com>","Christian Steininger <christian.steininger.cs@gmail.com>","Mykola Piskovyi <m.piskovyi@gmail.com>","Brian Vaughn <brian.david.vaughn@gmail.com>","Nicholas Clawson <nickclaw@gmail.com>","Yasuhiroki <yasuhiroki.duck@gmail.com>","Nicholas Clawson <nickclaw@gmail.com>","Brendan Warkentin <faazshift@gmail.com>","Charlie Fish <fishcharlie.code@gmail.com>","Ian Graves <ian+diskimage@iangrav.es>","Andy Thompson <me@andytson.com>","Regev Brody <regevbr@gmail.com>"],"license":"MIT","dependencies":{"luxon":"^1.28.0"},"devDependencies":{"eslint":"^8.2.0","sinon":"^10.0.0","tap":"^16.0.1","tsd":"^0.19.0"},"engines":{"node":">=0.8"},"browser":{"fs":false},"tap":{"check-coverage":false},"tsd":{"directory":"test","compilerOptions":{"lib":["es2017","dom"]}},"_lastModified":"2026-06-09T23:05:42.958Z"}

package/dist/node_modules/fs-extra/package.json

@@ -1 +1 @@
-{"name":"fs-extra","version":"9.1.0","description":"fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as recursive mkdir, copy, and remove.","engines":{"node":">=10"},"homepage":"https://github.com/jprichardson/node-fs-extra","repository":{"type":"git","url":"https://github.com/jprichardson/node-fs-extra"},"keywords":["fs","file","file system","copy","directory","extra","mkdirp","mkdir","mkdirs","recursive","json","read","write","extra","delete","remove","touch","create","text","output","move","promise"],"author":"JP Richardson <jprichardson@gmail.com>","license":"MIT","dependencies":{"at-least-node":"^1.0.0","graceful-fs":"^4.2.0","jsonfile":"^6.0.1","universalify":"^2.0.0"},"devDependencies":{"coveralls":"^3.0.0","klaw":"^2.1.1","klaw-sync":"^3.0.2","minimist":"^1.1.1","mocha":"^5.0.5","nyc":"^15.0.0","proxyquire":"^2.0.1","read-dir-files":"^0.1.1","standard":"^14.1.0"},"main":"./lib/index.js","files":["lib/","!lib/**/__tests__/"],"scripts":{"full-ci":"npm run lint && npm run coverage","coverage":"nyc -r lcovonly npm run unit","coveralls":"coveralls < coverage/lcov.info","lint":"standard","test-find":"find ./lib/**/__tests__ -name *.test.js | xargs mocha","test":"npm run lint && npm run unit","unit":"node test.js"},"_lastModified":"2026-06-08T07:14:38.133Z"}
+{"name":"fs-extra","version":"9.1.0","description":"fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as recursive mkdir, copy, and remove.","engines":{"node":">=10"},"homepage":"https://github.com/jprichardson/node-fs-extra","repository":{"type":"git","url":"https://github.com/jprichardson/node-fs-extra"},"keywords":["fs","file","file system","copy","directory","extra","mkdirp","mkdir","mkdirs","recursive","json","read","write","extra","delete","remove","touch","create","text","output","move","promise"],"author":"JP Richardson <jprichardson@gmail.com>","license":"MIT","dependencies":{"at-least-node":"^1.0.0","graceful-fs":"^4.2.0","jsonfile":"^6.0.1","universalify":"^2.0.0"},"devDependencies":{"coveralls":"^3.0.0","klaw":"^2.1.1","klaw-sync":"^3.0.2","minimist":"^1.1.1","mocha":"^5.0.5","nyc":"^15.0.0","proxyquire":"^2.0.1","read-dir-files":"^0.1.1","standard":"^14.1.0"},"main":"./lib/index.js","files":["lib/","!lib/**/__tests__/"],"scripts":{"full-ci":"npm run lint && npm run coverage","coverage":"nyc -r lcovonly npm run unit","coveralls":"coveralls < coverage/lcov.info","lint":"standard","test-find":"find ./lib/**/__tests__ -name *.test.js | xargs mocha","test":"npm run lint && npm run unit","unit":"node test.js"},"_lastModified":"2026-06-09T23:05:43.311Z"}

package/dist/node_modules/semver/package.json

@@ -1 +1 @@
-{"name":"semver","version":"7.6.0","description":"The semantic version parser used by npm.","main":"index.js","scripts":{"test":"tap","snap":"tap","lint":"eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"","postlint":"template-oss-check","lintfix":"npm run lint -- --fix","posttest":"npm run lint","template-oss-apply":"template-oss-apply --force"},"devDependencies":{"@npmcli/eslint-config":"^4.0.0","@npmcli/template-oss":"4.21.3","tap":"^16.0.0"},"license":"ISC","repository":{"type":"git","url":"https://github.com/npm/node-semver.git"},"bin":{"semver":"bin/semver.js"},"files":["bin/","lib/","classes/","functions/","internal/","ranges/","index.js","preload.js","range.bnf"],"tap":{"timeout":30,"coverage-map":"map.js","nyc-arg":["--exclude","tap-snapshots/**"]},"engines":{"node":">=10"},"dependencies":{"lru-cache":"^6.0.0"},"author":"GitHub Inc.","templateOSS":{"//@npmcli/template-oss":"This file is partially managed by @npmcli/template-oss. Edits may be overwritten.","version":"4.21.3","engines":">=10","distPaths":["classes/","functions/","internal/","ranges/","index.js","preload.js","range.bnf"],"allowPaths":["/classes/","/functions/","/internal/","/ranges/","/index.js","/preload.js","/range.bnf"],"publish":"true"},"_lastModified":"2026-06-08T07:14:39.486Z"}
+{"name":"semver","version":"7.6.0","description":"The semantic version parser used by npm.","main":"index.js","scripts":{"test":"tap","snap":"tap","lint":"eslint \"**/*.{js,cjs,ts,mjs,jsx,tsx}\"","postlint":"template-oss-check","lintfix":"npm run lint -- --fix","posttest":"npm run lint","template-oss-apply":"template-oss-apply --force"},"devDependencies":{"@npmcli/eslint-config":"^4.0.0","@npmcli/template-oss":"4.21.3","tap":"^16.0.0"},"license":"ISC","repository":{"type":"git","url":"https://github.com/npm/node-semver.git"},"bin":{"semver":"bin/semver.js"},"files":["bin/","lib/","classes/","functions/","internal/","ranges/","index.js","preload.js","range.bnf"],"tap":{"timeout":30,"coverage-map":"map.js","nyc-arg":["--exclude","tap-snapshots/**"]},"engines":{"node":">=10"},"dependencies":{"lru-cache":"^6.0.0"},"author":"GitHub Inc.","templateOSS":{"//@npmcli/template-oss":"This file is partially managed by @npmcli/template-oss. Edits may be overwritten.","version":"4.21.3","engines":">=10","distPaths":["classes/","functions/","internal/","ranges/","index.js","preload.js","range.bnf"],"allowPaths":["/classes/","/functions/","/internal/","/ranges/","/index.js","/preload.js","/range.bnf"],"publish":"true"},"_lastModified":"2026-06-09T23:05:45.057Z"}

package/dist/node_modules/yauzl/package.json

@@ -1 +1 @@
-{"name":"yauzl","version":"3.3.0","description":"yet another unzip library for node","engines":{"node":">=12"},"main":"index.js","scripts":{"test":"node test/test.js"},"repository":{"type":"git","url":"git+https://github.com/thejoshwolfe/yauzl.git"},"keywords":["unzip","zip","stream","archive","file"],"author":"Josh Wolfe <thejoshwolfe@gmail.com>","license":"MIT","bugs":{"url":"https://github.com/thejoshwolfe/yauzl/issues"},"homepage":"https://github.com/thejoshwolfe/yauzl","dependencies":{"buffer-crc32":"~0.2.3","pend":"~1.2.0"},"devDependencies":{"bl":"^6.0.11"},"files":["fd-slicer.js","index.js"],"_lastModified":"2026-06-08T07:14:37.971Z"}
+{"name":"yauzl","version":"3.3.0","description":"yet another unzip library for node","engines":{"node":">=12"},"main":"index.js","scripts":{"test":"node test/test.js"},"repository":{"type":"git","url":"git+https://github.com/thejoshwolfe/yauzl.git"},"keywords":["unzip","zip","stream","archive","file"],"author":"Josh Wolfe <thejoshwolfe@gmail.com>","license":"MIT","bugs":{"url":"https://github.com/thejoshwolfe/yauzl/issues"},"homepage":"https://github.com/thejoshwolfe/yauzl","dependencies":{"buffer-crc32":"~0.2.3","pend":"~1.2.0"},"devDependencies":{"bl":"^6.0.11"},"files":["fd-slicer.js","index.js"],"_lastModified":"2026-06-09T23:05:43.140Z"}

package/dist/server/adapters/database.d.ts

@@ -1,8 +1,27 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
 import { DatabaseOptions } from '@nocobase/database';
+export type DBBackupOptions = {
+    dir: string;
+    skipFdw?: boolean;
+    includeTables?: string[];
+    excludeTables?: string[];
+};
+export type DBRestoreOptions = {
+    filePath: string;
+    schema?: string;
+    skipDropAllTables?: boolean;
+};
 export interface DBAdapter {
     dbOpts: DatabaseOptions;
-    backup(dir: string, skipFdw?: boolean): Promise<void>;
-    restore(filePath: string, schema?: string): Promise<void>;
+    backup(options: DBBackupOptions): Promise<void>;
+    restore(options: DBRestoreOptions): Promise<void>;
     check(op: 'backup' | 'restore'): Promise<void>;
     clientVersion(op: 'backup' | 'restore'): Promise<string | void>;
 }

package/dist/server/adapters/database.js

@@ -65,6 +65,16 @@ const formatPathInEnv = (path2) => {
   return path2;
 };
 const escapeStringLiteral = (value) => String(value).replace(/'/g, "''");
+const quotePgIdentifier = (value) => `"${String(value).replace(/"/g, '""')}"`;
+const quoteShellArg = (value) => `'${String(value).replace(/'/g, "'\\''")}'`;
+const quotePgTablePattern = (table) => quoteShellArg(String(table).split(".").map(quotePgIdentifier).join("."));
+const qualifyPgTablePattern = (table, schema) => {
+  const tablePattern = String(table);
+  if (!schema || tablePattern.includes(".")) {
+    return tablePattern;
+  }
+  return `${schema}.${tablePattern}`;
+};
 class BaseDBAdapter {
   constructor(dbOpts) {
     this.dbOpts = dbOpts;
@@ -105,7 +115,7 @@ class MySQLAdapter extends BaseDBAdapter {
       return void 0;
     }
   }
-  async backup(dir, skipFdw = false) {
+  async backup({ dir, skipFdw = false, includeTables, excludeTables }) {
     const { username, host, port, database, password } = this.dbOpts;
     const filePath = `${dir}/data`;
     const versionStr = await this.clientVersion("backup");
@@ -115,6 +125,8 @@ class MySQLAdapter extends BaseDBAdapter {
     if (!skipFdw) {
       createServerSQL = await this.#getFederatedServerSQL(username, host, port, database, password);
     }
+    const includeOption = Array.isArray(includeTables) && includeTables.length ? includeTables.map((table) => table) : [];
+    const excludeOption = Array.isArray(excludeTables) && excludeTables.length ? excludeTables.map((table) => `--ignore-table=${database}.${table}`) : [];
     const mysqldumpArgs = [
       "-u",
       username,
@@ -131,6 +143,12 @@ class MySQLAdapter extends BaseDBAdapter {
       ...version && version > 7 ? ["--column-statistics=0"] : [],
       database
     ];
+    if (excludeOption.length) {
+      mysqldumpArgs.push(...excludeOption);
+    }
+    if (includeOption.length) {
+      mysqldumpArgs.push(...includeOption);
+    }
     return new Promise((resolve, reject) => {
       const mysqldumpProcess = (0, import_child_process.spawn)(this.#backupCmd, mysqldumpArgs, {
         env: { ...process.env, MYSQL_PWD: password },
@@ -214,9 +232,10 @@ class MySQLAdapter extends BaseDBAdapter {
       return "";
     }
   }
-  async restore(filePath) {
+  async restore({ filePath, skipDropAllTables = false }) {
     const { username, host, port, database, password } = this.dbOpts;
-    const dropDataCommand = `mysql -u ${username} -h ${host} ${port ? `-P ${port}` : ""} --protocol=tcp -D ${database} -e "
+    if (!skipDropAllTables) {
+      const dropDataCommand = `mysql -u ${username} -h ${host} ${port ? `-P ${port}` : ""} --protocol=tcp -D ${database} -e "
     DELIMITER $$
     DROP PROCEDURE IF EXISTS drop_all_tables_and_triggers$$
     CREATE PROCEDURE drop_all_tables_and_triggers()
@@ -296,7 +315,8 @@ class MySQLAdapter extends BaseDBAdapter {
     DROP PROCEDURE drop_all_tables_and_triggers$$
     DELIMITER ;
     "`;
-    await run(dropDataCommand, { MYSQL_PWD: password });
+      await run(dropDataCommand, { MYSQL_PWD: password });
+    }
     const command = `${this.#restoreCmd} -u ${username} -h ${host} ${port ? `-P ${port}` : ""} --protocol=tcp ${database} < ${filePath}`;
     await run(command, { MYSQL_PWD: password });
   }
@@ -326,14 +346,16 @@ class PostgresAdapter extends BaseDBAdapter {
       return void 0;
     }
   }
-  async backup(dir) {
+  async backup({ dir, includeTables, excludeTables }) {
     const { username, host, port, database, password, schema: backupSchema } = this.dbOpts;
     const filePath = `${dir}/data`;
     const schemaOption = backupSchema ? `--schema=${backupSchema}` : "";
-    const command = `${this.#backupCmd} -U ${username} -h ${host} ${port ? `-p ${port}` : ""} -F c -b --quote-all-identifiers ${schemaOption} -f ${filePath} ${database}`;
+    const includeOption = Array.isArray(includeTables) && includeTables.length ? includeTables.map((table) => `-t ${quotePgTablePattern(qualifyPgTablePattern(table, backupSchema))}`).join(" ") : "";
+    const excludeOption = Array.isArray(excludeTables) && excludeTables.length ? excludeTables.map((table) => `-T ${quotePgTablePattern(qualifyPgTablePattern(table, backupSchema))}`).join(" ") : "";
+    const command = `${this.#backupCmd} ${includeOption} ${excludeOption} -U ${username} -h ${host} ${port ? `-p ${port}` : ""} -F c -b --quote-all-identifiers ${schemaOption} -f ${filePath} ${database}`;
     await run(command, { PGPASSWORD: password });
   }
-  async restore(filePath, schema) {
+  async restore({ filePath, schema, skipDropAllTables = false }) {
     const { username, host, port, database, password } = this.dbOpts;
     let schemaOption = this.dbOpts.schema;
     if (schema && !schemaOption) {
@@ -343,7 +365,8 @@ class PostgresAdapter extends BaseDBAdapter {
     const j = Math.max(1, Math.floor(cpuCores / 2));
     const schemaNameCondition = schemaOption ? `WHERE schemaname = '${schemaOption}'` : `WHERE schemaname NOT IN ('pg_catalog', 'information_schema')`;
     const relnamespaceCondition = schemaOption ? `WHERE relnamespace = '${schemaOption}'::regnamespace` : `WHERE tgrelid IN (SELECT oid FROM pg_class WHERE relnamespace NOT IN (SELECT oid FROM pg_catalog.pg_namespace WHERE nspname IN ('pg_catalog', 'information_schema')))`;
-    const dropDataCommand = `psql -U ${username} -h ${host} ${port ? `-p ${port}` : ""} -d ${database} -c "
+    if (!skipDropAllTables) {
+      const dropDataCommand = `psql -U ${username} -h ${host} ${port ? `-p ${port}` : ""} -d ${database} -c "
     DO ${D$$} DECLARE r RECORD;
     BEGIN
     FOR r IN (SELECT viewname,schemaname FROM pg_views ${schemaNameCondition}) LOOP
@@ -383,7 +406,8 @@ class PostgresAdapter extends BaseDBAdapter {
     END LOOP;
 
     END ${D$$};"`.replace(/\n/g, " ");
-    await run(dropDataCommand, { PGPASSWORD: password });
+      await run(dropDataCommand, { PGPASSWORD: password });
+    }
     if (schema === schemaOption || !schemaOption) {
       const pgRestoreCommand = `${this.#restoreCmd} -U ${username} -h ${host} ${port ? `-p ${port}` : ""} -d ${database} --clean --if-exists --no-owner -j ${j} ${filePath}`;
       await run(pgRestoreCommand, { PGPASSWORD: password });
@@ -451,13 +475,13 @@ class PostgresAdapter extends BaseDBAdapter {
   }
 }
 class SQLiteAdapter extends BaseDBAdapter {
-  async backup(dir) {
+  async backup({ dir }) {
     const { storage } = this.dbOpts;
     const filePath = `${dir}/data`;
     const dbFilePath = import_path.default.resolve(storage);
     await fsPromises.copyFile(dbFilePath, filePath);
   }
-  async restore(filePath) {
+  async restore({ filePath }) {
     const { storage } = this.dbOpts;
     const dbFilePath = import_path.default.resolve(storage);
     await fsPromises.copyFile(filePath, dbFilePath, fsPromises.constants.COPYFILE_FICLONE);

package/dist/server/collections/backup-settings.d.ts

@@ -1,2 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
 declare const _default: import("@nocobase/database").CollectionOptions;
 export default _default;

package/dist/server/collections/backup-settings.js

@@ -33,6 +33,7 @@ var import_database = require("@nocobase/database");
 var import_utils = require("../utils");
 var backup_settings_default = (0, import_database.defineCollection)({
   name: `${import_utils.SETTINGS}`,
+  dataCategory: "business",
   dumpRules: "required",
   migrationRules: ["overwrite", "skip"],
   fields: [

package/dist/server/index.d.ts

@@ -1 +1,13 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export { BackupManager } from './managers/backup';
+export type { BackupSettings, BackupCreator, BackupTaskResult } from './managers/backup';
+export { RestoreManager, RestoreOptions } from './managers/restore';
+export { BACKUP_EXTENSION } from './utils';
 export { default } from './plugin';

package/dist/server/index.js

@@ -36,7 +36,21 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var server_exports = {};
 __export(server_exports, {
+  BACKUP_EXTENSION: () => import_utils.BACKUP_EXTENSION,
+  BackupManager: () => import_backup.BackupManager,
+  RestoreManager: () => import_restore.RestoreManager,
+  RestoreOptions: () => import_restore.RestoreOptions,
   default: () => import_plugin.default
 });
 module.exports = __toCommonJS(server_exports);
+var import_backup = require("./managers/backup");
+var import_restore = require("./managers/restore");
+var import_utils = require("./utils");
 var import_plugin = __toESM(require("./plugin"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BACKUP_EXTENSION,
+  BackupManager,
+  RestoreManager,
+  RestoreOptions
+});

package/dist/server/managers/backup.d.ts

@@ -17,12 +17,22 @@ export interface BackupSettings {
     keep?: number;
     scheduled: boolean;
     cron: string;
+    includeTables?: string[];
+    excludeTables?: string[];
+    description?: string;
+    createdBy?: BackupCreator;
 }
 export interface BackupFile {
     name: string;
     fileSize?: string;
     createdAt?: Date;
+    description?: string;
     inProgress: boolean;
+    createdBy?: BackupCreator;
+}
+export interface BackupCreator {
+    id: string;
+    username: string;
 }
 export interface BackupTaskResult {
     message?: string;
@@ -33,8 +43,13 @@ export declare class BackupManager {
     app: Application;
     ctx: ResourcerContext | null;
     constructor(app: Application, ctx: ResourcerContext | null, settings: BackupSettings);
+    protected set backupPrefix(backupPrefix: string);
+    protected set backupDir(backupDir: string);
+    protected set tempDir(tempDir: string);
+    protected set uploadDir(uploadDir: string);
+    protected set backupTasksCacheName(backupTasksCacheName: string);
     createBackupName(): Promise<string>;
-    backup(fileBaseName: string, opts?: BackupSettings): Promise<string>;
+    backup(fileBaseName: string, opts?: Partial<BackupSettings>): Promise<string>;
     destroy(fileName: string): Promise<void>;
     list(): Promise<BackupFile[]>;
     createReadStream(fileName: string): Promise<Readable>;

package/dist/server/managers/backup.js

@@ -50,12 +50,15 @@ var import_utils = require("@nocobase/utils");
 var import_util = require("util");
 var import_database = require("../adapters/database");
 var import_utils2 = require("../utils");
+const BACKUP_METADATA_VERSION = 1;
 class BackupManager {
   app;
   ctx;
   // when triggered by cron job, ctx is null
   #settings;
   #dbAdapter;
+  #backupTasksCacheName;
+  #backupPrefix;
   #backupDir;
   #tempDir;
   #uploadDir;
@@ -65,11 +68,28 @@ class BackupManager {
     this.ctx = ctx;
     this.#settings = settings;
     this.#dbAdapter = (0, import_database.getDBAdapter)(app.db.options);
+    this.#backupTasksCacheName = import_utils2.BACKUP_TASKS_CACHE_NAME;
+    this.#backupPrefix = "backup_";
     this.#backupDir = (0, import_utils.storagePathJoin)("backups", app.name);
     this.#tempDir = (0, import_utils.storagePathJoin)("tmp", "backups", app.name);
     this.#uploadDir = (0, import_utils.storagePathJoin)("uploads");
     this.#aesKeyPath = (0, import_utils.storagePathJoin)("apps", app.name, "aes_key.dat");
   }
+  set backupPrefix(backupPrefix) {
+    this.#backupPrefix = backupPrefix;
+  }
+  set backupDir(backupDir) {
+    this.#backupDir = backupDir;
+  }
+  set tempDir(tempDir) {
+    this.#tempDir = tempDir;
+  }
+  set uploadDir(uploadDir) {
+    this.#uploadDir = uploadDir;
+  }
+  set backupTasksCacheName(backupTasksCacheName) {
+    this.#backupTasksCacheName = backupTasksCacheName;
+  }
   async createBackupName() {
     await this.#dbAdapter.check("backup");
     await import_promises.default.mkdir(this.#backupDir, { recursive: true });
@@ -77,19 +97,22 @@ class BackupManager {
     await import_promises.default.mkdir(this.#uploadDir, { recursive: true });
     return this.#generateFileBaseName();
   }
-  async backup(fileBaseName, opts = this.#settings) {
+  async backup(fileBaseName, opts) {
     const contentPath = import_path.default.join(this.#tempDir, fileBaseName);
-    return this.#runBackupTask(opts, fileBaseName, contentPath);
+    return this.#runBackupTask({ ...this.#settings, ...opts ?? {} }, fileBaseName, contentPath);
   }
   async destroy(fileName) {
     const filePath = this.#getValidatedFilePath(fileName);
+    const fileBaseName = import_path.default.basename(filePath, `.${import_utils2.BACKUP_EXTENSION}`);
+    const metadataFilePath = import_path.default.join(this.#backupDir, `${fileBaseName}${import_utils2.METADATA_EXTENSION}`);
     await import_promises.default.unlink(filePath);
+    await import_promises.default.rm(metadataFilePath, { force: true });
   }
   async list() {
     const inProgressBackups = await this.#listProgressBackups();
     const completedBackups = await this.#listCompletedBackups(inProgressBackups);
     const cleanStaleLockFiles = async () => {
-      const statusCache = this.app.cacheManager.getCache(import_utils2.BACKUP_TASKS_CACHE_NAME);
+      const statusCache = this.app.cacheManager.getCache(this.#backupTasksCacheName);
       for (const backup of inProgressBackups) {
         if (!await statusCache.get(backup.name)) {
           await this.#removeLockFile(import_path.default.basename(backup.name, `.${import_utils2.BACKUP_EXTENSION}`));
@@ -116,7 +139,12 @@ class BackupManager {
     try {
       await this.#createLockFile(fileBaseName);
       await this.#createContentPath(contentPath);
-      await this.#dbAdapter.backup(contentPath, !this.app.pm.has("collection-fdw"));
+      await this.#dbAdapter.backup({
+        dir: contentPath,
+        skipFdw: !this.app.pm.has("collection-fdw"),
+        includeTables: opts.includeTables,
+        excludeTables: opts.excludeTables
+      });
       await this.#metadataBackup(opts, contentPath);
       const password = opts.encryptionPassword || void 0;
       const filePath = await this.#compressFiles(contentPath, fileBaseName, password, opts);
@@ -159,8 +187,11 @@ class BackupManager {
       };
     });
     const metadata = {
+      metadataVersion: BACKUP_METADATA_VERSION,
       enableFilesBackup: opts.enableFilesBackup,
       version: await this.app.version.get(),
+      description: opts.description,
+      createdBy: opts.createdBy,
       database: {
         dialect,
         underscored,
@@ -171,7 +202,7 @@ class BackupManager {
       },
       plugins
     };
-    const metadataFilePath = import_path.default.join(dir, "_metadata.json");
+    const metadataFilePath = import_path.default.join(dir, import_utils2.METADATA_EXTENSION);
     try {
       await import_promises.default.writeFile(metadataFilePath, JSON.stringify(metadata, null, 2));
     } catch (error) {
@@ -183,6 +214,8 @@ class BackupManager {
       zlib: { level: 9 }
     });
     const filePath = import_path.default.join(this.#backupDir, `${fileBaseName}.${import_utils2.BACKUP_EXTENSION}`);
+    const sourceMetadataFilePath = import_path.default.join(dir, import_utils2.METADATA_EXTENSION);
+    const metadataFilePath = import_path.default.join(this.#backupDir, `${fileBaseName}${import_utils2.METADATA_EXTENSION}`);
     const outputFileStream = fs.createWriteStream(filePath);
     try {
       const output = await this.#createEncryptedStream(outputFileStream, password);
@@ -253,6 +286,7 @@ class BackupManager {
       }
       await archive.finalize();
       await onClose;
+      await import_promises.default.copyFile(sourceMetadataFilePath, metadataFilePath);
     } catch (error) {
       this.app.logger.error(`Error compressing files: ${error.message}`, { module: import_utils2.BACKUPS });
       throw new Error(this.#t("ERROR_COMPRESSING_FILES", error.message));
@@ -385,7 +419,7 @@ class BackupManager {
     }
   }
   #generateFileBaseName() {
-    return `backup_${(0, import_dayjs.default)().format(`YYYYMMDD_HHmmss_${Math.floor(1e3 + Math.random() * 9e3)}`)}`;
+    return `${this.#backupPrefix}${(0, import_dayjs.default)().format(`YYYYMMDD_HHmmss_${Math.floor(1e3 + Math.random() * 9e3)}`)}`;
   }
   async #listCompletedBackups(inProgressFiles = []) {
     let files;
@@ -400,17 +434,35 @@ class BackupManager {
     }
     const inProgressFileNames = inProgressFiles.map((file) => file.name);
     const backupPromises = files.filter((file) => file.endsWith(`.${import_utils2.BACKUP_EXTENSION}`) && !inProgressFileNames.includes(file)).map(async (file) => {
-      const stats = await import_promises.default.stat(import_path.default.join(this.#backupDir, file));
+      const fileBaseName = import_path.default.basename(file, `.${import_utils2.BACKUP_EXTENSION}`);
+      const metadataFilePath = import_path.default.join(this.#backupDir, `${fileBaseName}${import_utils2.METADATA_EXTENSION}`);
+      const [stats, metadata] = await Promise.all([
+        import_promises.default.stat(import_path.default.join(this.#backupDir, file)),
+        this.#readBackupDescription(metadataFilePath)
+      ]);
       return {
         name: file,
         fileSize: (0, import_utils2.humanFileSize)(stats.size),
         createdAt: stats.ctime,
+        description: metadata == null ? void 0 : metadata.description,
+        createdBy: metadata == null ? void 0 : metadata.createdBy,
         inProgress: false
       };
     });
     const backups = await Promise.all(backupPromises);
     return backups.sort((a, b) => b.createdAt.getTime() - a.createdAt.getTime());
   }
+  async #readBackupDescription(metadataFilePath) {
+    try {
+      const metadata = JSON.parse(await import_promises.default.readFile(metadataFilePath, "utf8"));
+      return {
+        description: metadata.description,
+        createdBy: metadata.createdBy
+      };
+    } catch (_error) {
+      return void 0;
+    }
+  }
   async #listProgressBackups() {
     try {
       const files = await import_promises.default.readdir(this.#tempDir);

package/dist/server/managers/restore.d.ts

@@ -8,17 +8,21 @@
  */
 /// <reference types="multer" />
 import { ResourcerContext } from '@nocobase/resourcer';
-interface RestoreOptions {
+export interface RestoreOptions {
     forceSchemaRestore?: boolean;
+    skipDropAllTables?: boolean;
 }
 export declare class RestoreManager {
     #private;
     ctx: ResourcerContext;
     constructor(ctx: ResourcerContext, dbOptions?: any);
+    protected set backupDir(backupDir: string);
+    protected set tempDir(tempDir: string);
+    protected set uploadDir(uploadDir: string);
+    protected set restoreTasksCacheName(restoreTasksCacheName: string);
     restoreFromBackup(backupFileName: string, taskId: string, password?: string, tolerentMode?: boolean, options?: RestoreOptions): Promise<void>;
     restoreFromUpload(backupFile: Express.Multer.File, taskId: string, password?: string, tolerentMode?: boolean, options?: RestoreOptions): Promise<void>;
     restoreCLI(filePath: string, password?: string, tolerentMode?: boolean, skipRevertOnError?: boolean, options?: RestoreOptions): Promise<void>;
-    private getStatusCache;
+    protected getStatusCache(): Promise<any>;
     restore(filePath: string, taskId: string, password?: string, tolerentMode?: boolean, skipRevertOnError?: boolean, options?: RestoreOptions): Promise<void>;
 }
-export {};

package/dist/server/managers/restore.js

@@ -57,6 +57,7 @@ const RESTORE_STEPS = {
 class RestoreManager {
   ctx;
   #dbAdapter;
+  #restoreTasksCacheName;
   #backupDir;
   #tempDir;
   #uploadDir;
@@ -64,11 +65,24 @@ class RestoreManager {
   constructor(ctx, dbOptions) {
     this.ctx = ctx;
     this.#dbAdapter = (0, import_database.getDBAdapter)(dbOptions || ctx.app.db.options);
+    this.#restoreTasksCacheName = import_utils2.RESTORE_TASKS_CACHE_NAME;
     this.#backupDir = (0, import_utils.storagePathJoin)("backups", ctx.app.name);
     this.#tempDir = (0, import_utils.storagePathJoin)("tmp", "backups", ctx.app.name);
     this.#uploadDir = (0, import_utils.storagePathJoin)("uploads");
     this.#aesKeyPath = (0, import_utils.storagePathJoin)("apps", ctx.app.name, "aes_key.dat");
   }
+  set backupDir(backupDir) {
+    this.#backupDir = backupDir;
+  }
+  set tempDir(tempDir) {
+    this.#tempDir = tempDir;
+  }
+  set uploadDir(uploadDir) {
+    this.#uploadDir = uploadDir;
+  }
+  set restoreTasksCacheName(restoreTasksCacheName) {
+    this.#restoreTasksCacheName = restoreTasksCacheName;
+  }
   async restoreFromBackup(backupFileName, taskId, password, tolerentMode, options) {
     const backupFilePath = this.#getValidatedBackupFilePath(backupFileName);
     await this.restore(backupFilePath, taskId, password, tolerentMode, void 0, options);
@@ -90,7 +104,7 @@ class RestoreManager {
     }
     const metadata = await this.#parseMetadataFile(import_path.default.join(extractedDir, metadataFile), tolerentMode, options);
     try {
-      await this.#restoreDataCLI(extractedDir, dbFile, uploadsExist, metadata);
+      await this.#restoreDataCLI(extractedDir, dbFile, uploadsExist, metadata, options);
     } catch (error) {
       const dbVersion = await (0, import_utils2.getDBVersion)(this.ctx.app.db);
       const restoreClientVersion = await this.#dbAdapter.clientVersion("restore");
@@ -119,13 +133,17 @@ class RestoreManager {
     }
     return filePath;
   }
-  async #restoreDataCLI(extractedDir, dbFile, restoreUploads, metadata) {
+  async #restoreDataCLI(extractedDir, dbFile, restoreUploads, metadata, options) {
     const tmpBackupDir = import_path.default.join(this.#tempDir, "before-restore");
     try {
       await import_fs_extra.default.mkdir(tmpBackupDir, { recursive: true });
       await this.ctx.app.emitAsync("beforeStop");
       await this.ctx.app.emitAsync("afterStop");
-      await this.#dbAdapter.restore(import_path.default.join(extractedDir, dbFile), metadata.database.schema);
+      await this.#dbAdapter.restore({
+        filePath: import_path.default.join(extractedDir, dbFile),
+        schema: metadata.database.schema,
+        skipDropAllTables: (options == null ? void 0 : options.skipDropAllTables) === true
+      });
       this.ctx.logger.info("Database restored successfully", { module: import_utils2.BACKUPS });
       await this.#restoreFilesAndCleanup(restoreUploads, extractedDir);
     } catch (error) {
@@ -137,10 +155,10 @@ class RestoreManager {
   }
   async getStatusCache() {
     try {
-      return this.ctx.app.cacheManager.getCache(import_utils2.RESTORE_TASKS_CACHE_NAME);
+      return this.ctx.app.cacheManager.getCache(this.#restoreTasksCacheName);
     } catch (e) {
       return await this.ctx.app.cacheManager.createCache({
-        name: import_utils2.RESTORE_TASKS_CACHE_NAME,
+        name: this.#restoreTasksCacheName,
         store: "memory",
         ttl: import_utils2.RESTORE_TASKS_CACHE_TTL,
         max: 10
@@ -159,7 +177,7 @@ class RestoreManager {
       throw new Error(this.#t("Not a valid backup file"));
     }
     const metadata = await this.#parseMetadataFile(import_path.default.join(extractedDir, metadataFile), tolerentMode, options);
-    this.#restoreData(extractedDir, dbFile, uploadsExist, taskId, metadata).catch(async (error) => {
+    this.#restoreData(extractedDir, dbFile, uploadsExist, taskId, metadata, options).catch(async (error) => {
       try {
         const dbVersion = await (0, import_utils2.getDBVersion)(this.ctx.app.db);
         const restoreClientVersion = await this.#dbAdapter.clientVersion("restore");
@@ -341,17 +359,21 @@ class RestoreManager {
       throw error;
     }
   }
-  async #restoreData(extractedDir, dbFile, restoreUploads, taskId, metadata) {
+  async #restoreData(extractedDir, dbFile, restoreUploads, taskId, metadata, options) {
     this.#notify(RESTORE_STEPS.BEGIN);
     this.#notify(RESTORE_STEPS.DATABASE);
     const statusCache = await this.getStatusCache();
     const tmpBackupDir = import_path.default.join(this.#tempDir, "before-restore");
     try {
       await import_promises.default.mkdir(tmpBackupDir, { recursive: true });
-      await this.#dbAdapter.backup(tmpBackupDir);
+      await this.#dbAdapter.backup({ dir: tmpBackupDir });
       await this.ctx.app.emitAsync("beforeStop");
       await this.ctx.app.emitAsync("afterStop");
-      await this.#dbAdapter.restore(import_path.default.join(extractedDir, dbFile), metadata.database.schema);
+      await this.#dbAdapter.restore({
+        filePath: import_path.default.join(extractedDir, dbFile),
+        schema: metadata.database.schema,
+        skipDropAllTables: (options == null ? void 0 : options.skipDropAllTables) === true
+      });
       this.ctx.logger.info("Database restored successfully", { module: import_utils2.BACKUPS });
       if (restoreUploads) {
         this.#notify(RESTORE_STEPS.UPLOADS);
@@ -393,7 +415,7 @@ class RestoreManager {
     const dbFile = import_path.default.join(this.#tempDir, "before-restore", "data");
     if (await import_fs_extra.default.pathExists(dbFile)) {
       try {
-        await this.#dbAdapter.restore(dbFile, this.#dbAdapter.dbOpts.schema);
+        await this.#dbAdapter.restore({ filePath: dbFile, schema: this.#dbAdapter.dbOpts.schema });
       } catch (error) {
         this.ctx.logger.error("Error reverting the database restore process", { module: import_utils2.BACKUPS });
       }

package/dist/server/utils.d.ts

@@ -9,6 +9,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 export declare const BACKUP_EXTENSION = "nbdata";
+export declare const METADATA_EXTENSION = "_metadata.json";
 export declare const STORAGE_PATH = "storage/uploads";
 export declare const SETTINGS = "backupSettings";
 export declare const BACKUPS = "backups";

package/dist/server/utils.js

@@ -42,6 +42,7 @@ __export(utils_exports, {
   EscapeQuoteTransform: () => EscapeQuoteTransform,
   Extractor: () => Extractor,
   FILE_ENCRYPTION_SALT: () => FILE_ENCRYPTION_SALT,
+  METADATA_EXTENSION: () => METADATA_EXTENSION,
   PLUGIN_BACKUPS_NAME: () => PLUGIN_BACKUPS_NAME,
   RESTORE_TASKS_CACHE_NAME: () => RESTORE_TASKS_CACHE_NAME,
   RESTORE_TASKS_CACHE_TTL: () => RESTORE_TASKS_CACHE_TTL,
@@ -61,6 +62,7 @@ var import_path = __toESM(require("path"));
 var import_sequelize = require("sequelize");
 var import_package = require("../../package.json");
 const BACKUP_EXTENSION = "nbdata";
+const METADATA_EXTENSION = "_metadata.json";
 const STORAGE_PATH = "storage/uploads";
 const SETTINGS = "backupSettings";
 const BACKUPS = "backups";
@@ -310,6 +312,7 @@ class EscapeQuoteTransform extends import_stream.Transform {
   EscapeQuoteTransform,
   Extractor,
   FILE_ENCRYPTION_SALT,
+  METADATA_EXTENSION,
   PLUGIN_BACKUPS_NAME,
   RESTORE_TASKS_CACHE_NAME,
   RESTORE_TASKS_CACHE_TTL,

package/package.json

@@ -4,7 +4,7 @@
   "displayName.zh-CN": "备份管理器",
   "description": "Provides backup and restore functionality, supports scheduled backups, and ensures data security and quick recovery.",
   "description.zh-CN": "提供备份与还原功能，支持定时备份，确保数据安全与快速恢复。",
-  "version": "2.1.0-beta.46",
+  "version": "2.1.0-beta.47",
   "license": "Apache-2.0",
   "main": "dist/server/index.js",
   "nocobase": {
@@ -47,5 +47,5 @@
   "keywords": [
     "System management"
   ],
-  "gitHead": "91fd3ab238a5ff58735bbfca04a8cb05d233b0af"
+  "gitHead": "bf8fc3790e3494c901b4d22861c5471a0d27c464"
 }