Skip to content

docs: backups manager permission #304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: backups manager permission #304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fd123a
feat: add db permissions requirement for backups plugin
gchust Jan 24, 2025
081e0e4
feat: add en jp doc placeholder part
gchust Jan 24, 2025
8cd5c60
docs: update mysql permission
gchust Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/en-US/handbook/backups/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ The NocoBase backup manager plugin provides features for fully backing up of the

## Usage Instructions

执行备份和还原操作需要数据库用户具备相应的权限。以下是不同数据库类型所需的最小权限要求：

| 数据库类型 | 备份 | 还原 |
|-----------|------|------|
| MySQL/MariaDB | `SELECT`、`SHOW VIEW`、`TRIGGER`、`LOCK TABLES`、`EVENT`、`SELECT ON mysql.servers` (开启 FDW 时需要) | `SELECT`、`SHOW VIEW`、`TRIGGER`、`LOCK TABLES`、`EVENT`、`CREATE`、`UPDATE`、`INDEX`、`DROP`、`INSERT`、`ALTER`、`CREATE ROUTINE`、`REFERENCES`、`CREATE VIEW`、`SUPER` (开启 FDW 时需要) |
| PostgreSQL | `SELECT`、`CONNECT`、`USAGE` | `CREATE`、`USAGE`、`CONNECT`、`DROP`、`ALTER`、`SELECT`、`INSERT`、`UPDATE`、`DELETE`、`TRUNCATE`、`REFERENCES`、`TRIGGER`、`SUPERUSER` (开启 FDW 时需要) |

![Main Interface](./static/main-screen.png)

### Create New Backup
Expand Down
7 changes: 7 additions & 0 deletions docs/ja-JP/handbook/backups/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ NocoBaseバックアップマネージャープラグインは、NocoBaseデー

## 使用説明書

执行备份和还原操作需要数据库用户具备相应的权限。以下是不同数据库类型所需的最小权限要求：

| 数据库类型 | 备份 | 还原 |
|-----------|------|------|
| MySQL/MariaDB | `SELECT`、`SHOW VIEW`、`TRIGGER`、`LOCK TABLES`、`EVENT`、`SELECT ON mysql.servers` (开启 FDW 时需要) | `SELECT`、`SHOW VIEW`、`TRIGGER`、`LOCK TABLES`、`EVENT`、`CREATE`、`UPDATE`、`INDEX`、`DROP`、`INSERT`、`ALTER`、`CREATE ROUTINE`、`REFERENCES`、`CREATE VIEW`、`SUPER` (开启 FDW 时需要) |
| PostgreSQL | `SELECT`、`CONNECT`、`USAGE` | `CREATE`、`USAGE`、`CONNECT`、`DROP`、`ALTER`、`SELECT`、`INSERT`、`UPDATE`、`DELETE`、`TRUNCATE`、`REFERENCES`、`TRIGGER`、`SUPERUSER` (开启 FDW 时需要) |

![メイン画面](./static/main-screen.png)

### 新規バックアップの作成
Expand Down
9 changes: 9 additions & 0 deletions docs/zh-CN/handbook/backups/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ NocoBase 备份管理器插件，提供了 NocoBase 数据库及用户上传文

## 使用说明

### 权限要求

执行备份和还原操作需要数据库用户具备相应的权限。以下是不同数据库类型所需的最小权限要求：

| 数据库类型 | 备份 | 还原 |
|-----------|------|------|
| MySQL/MariaDB | `SELECT`、`SHOW VIEW`、`TRIGGER`、`LOCK TABLES`、`EVENT`、`SELECT ON mysql.servers` (开启 FDW 时需要) | `SELECT`、`SHOW VIEW`、`TRIGGER`、`LOCK TABLES`、`EVENT`、`CREATE`、`UPDATE`、`INDEX`、`DROP`、`INSERT`、`ALTER`、`CREATE ROUTINE`、`REFERENCES`、`CREATE VIEW`、`SUPER` (开启 FDW 时需要) |
| PostgreSQL | `SELECT`、`CONNECT`、`USAGE` | `CREATE`、`USAGE`、`CONNECT`、`DROP`、`ALTER`、`SELECT`、`INSERT`、`UPDATE`、`DELETE`、`TRUNCATE`、`REFERENCES`、`TRIGGER`、`SUPERUSER` (开启 FDW 时需要) |

![主界面](./static/main-screen.png)

### 新建备份
Expand Down
Loading