@nocobase/plugin-ai 2.2.0-beta.3 → 2.2.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ai/docs/nocobase/get-started/deployment/how-to-deploy-nocobase-faster.mdx +2 -2
- package/dist/ai/docs/nocobase/ops-management/backup-manager/index.mdx +9 -7
- package/dist/ai/docs/nocobase/ops-management/migration-manager/built-in-tables.md +423 -0
- package/dist/ai/docs/nocobase/ops-management/migration-manager/index.md +12 -9
- package/dist/ai/docs/nocobase/ops-management/release-management/index.md +111 -24
- package/dist/client/ai-employees/form-filler/tools/index.d.ts +8 -0
- package/dist/client/index.js +3 -3
- package/dist/externalVersion.js +16 -16
- package/dist/node_modules/@langchain/xai/package.json +1 -1
- package/dist/node_modules/fs-extra/package.json +1 -1
- package/dist/node_modules/jsonrepair/package.json +1 -1
- package/dist/node_modules/just-bash/package.json +1 -1
- package/dist/node_modules/nodejs-snowflake/package.json +1 -1
- package/dist/node_modules/openai/package.json +1 -1
- package/dist/node_modules/zod/package.json +1 -1
- package/package.json +2 -2
|
@@ -116,7 +116,7 @@ When users access NocoBase, requests go directly to your server. An appropriate
|
|
|
116
116
|
- Disadvantages: This method is simple but performs poorly when handling high concurrency or static files; suitable for development and testing only.
|
|
117
117
|
- Recommendation: Please avoid this method if possible.
|
|
118
118
|
|
|
119
|
-
> Reference "[Installation Documentation](https://
|
|
119
|
+
> Reference "[Installation Documentation](https://docs.nocobase.com/get-started/quickstart)"
|
|
120
120
|
|
|
121
121
|
Without a reverse proxy, homepage loading takes about 6.1 seconds
|
|
122
122
|

|
|
@@ -126,7 +126,7 @@ Without a reverse proxy, homepage loading takes about 6.1 seconds
|
|
|
126
126
|
- Advantages: Reverse proxy servers can efficiently handle concurrent connections, serve static files, implement load balancing, and make HTTP/2 configuration simple.
|
|
127
127
|
- Recommendation: In production environments, after application deployment (source code deployment / create-nocobase-app / Docker image), use Nginx or Caddy as a reverse proxy.
|
|
128
128
|
|
|
129
|
-
> Reference "[Deployment Documentation](https://
|
|
129
|
+
> Reference "[Deployment Documentation](https://docs.nocobase.com/get-started/deployment/production)"
|
|
130
130
|
|
|
131
131
|
With Nginx proxy, homepage loading takes about 3-4 seconds
|
|
132
132
|

|
|
@@ -8,18 +8,20 @@ pkg: '@nocobase/plugin-backups'
|
|
|
8
8
|
|
|
9
9
|
The NocoBase backup manager plugin provides features for fully backing up of the NocoBase database and user uploaded files, including backup's scheduling, downloading, deleting, and restoring operation.
|
|
10
10
|
|
|
11
|
-
:::warning
|
|
12
|
-
The Backup Manager plugin is included in the Professional and Enterprise editions. For Community and Standard edition users, you can directly back up the database; see details at: [`How to Backup and Restore NocoBase`](https://www.nocobase.com/en/blog/nocobase-backup-restore)
|
|
13
|
-
:::
|
|
14
|
-
|
|
15
11
|
## Install Database Client
|
|
16
12
|
|
|
17
|
-
|
|
13
|
+
Backup Manager depends on the database client for the primary database. Before use, confirm that the current runtime environment has a client that matches your database version.
|
|
14
|
+
|
|
15
|
+
:::tip
|
|
16
|
+
When installing NocoBase with Docker, use the corresponding `full` image when possible, such as `latest-full`, `beta-full`, or `alpha-full`. These images already include common database clients, so manual installation is usually not required.
|
|
17
|
+
:::
|
|
18
|
+
|
|
19
|
+
If the current environment does not have the required database client, download the client that matches your database version from the official website:
|
|
18
20
|
|
|
19
21
|
- MySQL: https://dev.mysql.com/downloads/
|
|
20
22
|
- PostgreSQL: https://www.postgresql.org/download/
|
|
21
23
|
|
|
22
|
-
|
|
24
|
+
If you need to install it manually in a Docker environment, you can write a script in the `./storage/scripts` directory:
|
|
23
25
|
|
|
24
26
|
```bash
|
|
25
27
|
mkdir ./storage/scripts
|
|
@@ -188,4 +190,4 @@ Switch to the "Settings" tab, modify the backup settings, and click `Save` to ta
|
|
|
188
190
|
- `Backup local storage files`: Whether to include files uploaded by users to the server's local storage (storage/uploads) in the backup.
|
|
189
191
|
- `Restore password`: If a restore password is set, it must be entered when restoring the backup.
|
|
190
192
|
|
|
191
|
-
> **Please keep the restore password safe. Forgetting the password will make it impossible to restore the backup file.**
|
|
193
|
+
> **Please keep the restore password safe. Forgetting the password will make it impossible to restore the backup file.**
|
|
@@ -0,0 +1,423 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Built-in tables for applications and major plugins"
|
|
3
|
+
description: "Reference for built-in tables of applications and major plugins, covering Migration Manager default strategies, version-control scope, and backup/restore handling."
|
|
4
|
+
keywords: "Migration Manager,version control,backup restore,built-in tables,application configuration,plugin configuration,dataCategory,overwrite,schema-only,skip,NocoBase"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Built-in tables for applications and major plugins
|
|
8
|
+
|
|
9
|
+
## Introduction
|
|
10
|
+
|
|
11
|
+
This list explains common handling for built-in tables of applications and major plugins in Migration Manager, version control, and backup/restore. In most cases, users do not need to adjust tables one by one. Use the default strategy.
|
|
12
|
+
|
|
13
|
+
These mechanisms focus on different concerns:
|
|
14
|
+
|
|
15
|
+
- **Migration Manager**: publishes across environments. Common strategies include overwrite, schema-only, and skip.
|
|
16
|
+
- **Version control**: saves and restores key checkpoints during application building.
|
|
17
|
+
- **Backup/restore**: backs up and restores the application runtime state.
|
|
18
|
+
|
|
19
|
+
The “Data type” column comes from built-in classification. System base data participates in version control; business runtime data does not; runtime temporary data is not backed up.
|
|
20
|
+
|
|
21
|
+
## Built-in table reference
|
|
22
|
+
|
|
23
|
+
### Database
|
|
24
|
+
|
|
25
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
26
|
+
| --- | --- | --- | --- | --- | --- |
|
|
27
|
+
| `migrations` | Executed ORM/SQL migration versions | System base data | Schema-only | Included | Backed up |
|
|
28
|
+
|
|
29
|
+
### Server
|
|
30
|
+
|
|
31
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
32
|
+
| --- | --- | --- | --- | --- | --- |
|
|
33
|
+
| `applicationPlugins` | Plugin list and versions loaded by the application | System base data | Overwrite | Included | Backed up |
|
|
34
|
+
| `applicationVersion` | Application and core version used for upgrade and compatibility checks | System base data | Schema-only | Included | Backed up |
|
|
35
|
+
|
|
36
|
+
### System settings
|
|
37
|
+
|
|
38
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
39
|
+
| --- | --- | --- | --- | --- | --- |
|
|
40
|
+
| `systemSettings` | Installation-level system parameters and feature switches | System base data | Overwrite | Included | Backed up |
|
|
41
|
+
|
|
42
|
+
### Client
|
|
43
|
+
|
|
44
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
45
|
+
| --- | --- | --- | --- | --- | --- |
|
|
46
|
+
| `desktopRoutes` | Desktop menu and route structure | System base data | Overwrite | Included | Backed up |
|
|
47
|
+
|
|
48
|
+
### Multi-space
|
|
49
|
+
|
|
50
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
51
|
+
| --- | --- | --- | --- | --- | --- |
|
|
52
|
+
| `spaces` | Top-level containers for space or workspace isolation | Business runtime data | Schema-only | Not included | Backed up |
|
|
53
|
+
| `spacesUsers` | Membership between users and spaces | Business runtime data | Schema-only | Not included | Backed up |
|
|
54
|
+
|
|
55
|
+
### App monitoring
|
|
56
|
+
|
|
57
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
58
|
+
| --- | --- | --- | --- | --- | --- |
|
|
59
|
+
| `apps` | Application entries managed by the app monitoring plugin | Business runtime data | Schema-only | Not included | Backed up |
|
|
60
|
+
|
|
61
|
+
### Main data source
|
|
62
|
+
|
|
63
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
64
|
+
| --- | --- | --- | --- | --- | --- |
|
|
65
|
+
| `collectionCategories` | UI grouping for business collections | System base data | Overwrite | Included | Backed up |
|
|
66
|
+
| `collections` | Business collection fields, indexes, and metadata | System base data | Overwrite | Included | Backed up |
|
|
67
|
+
| `fields` | Field types and constraints under collections | System base data | Overwrite | Included | Backed up |
|
|
68
|
+
|
|
69
|
+
### Data source manager
|
|
70
|
+
|
|
71
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
72
|
+
| --- | --- | --- | --- | --- | --- |
|
|
73
|
+
| `dataSources` | Main or external database connection configuration | System base data | Overwrite | Included | Backed up |
|
|
74
|
+
| `dataSourcesCollections` | Mapping for synced tables or collections from external sources | System base data | Overwrite | Included | Backed up |
|
|
75
|
+
| `dataSourcesFields` | Mapping between external fields and NocoBase fields | System base data | Overwrite | Included | Backed up |
|
|
76
|
+
| `dataSourcesRoles` | Access roles at data-source level | System base data | Overwrite | Included | Backed up |
|
|
77
|
+
| `dataSourcesRolesResources` | Collections and operations accessible by roles | System base data | Overwrite | Included | Backed up |
|
|
78
|
+
| `dataSourcesRolesResourcesActions` | Allowed actions such as create, read, update, and delete | System base data | Overwrite | Included | Backed up |
|
|
79
|
+
| `dataSourcesRolesResourcesScopes` | Row-level or filter-scope restrictions | System base data | Overwrite | Included | Backed up |
|
|
80
|
+
|
|
81
|
+
### External database connections
|
|
82
|
+
|
|
83
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
84
|
+
| --- | --- | --- | --- | --- | --- |
|
|
85
|
+
| `databaseServers` | Registered database instances available for connection | System base data | Overwrite | Included | Backed up |
|
|
86
|
+
|
|
87
|
+
### Visual data modeling
|
|
88
|
+
|
|
89
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
90
|
+
| --- | --- | --- | --- | --- | --- |
|
|
91
|
+
| `graphPositions` | Node positions in graph or flow editors | System base data | Overwrite | Included | Backed up |
|
|
92
|
+
|
|
93
|
+
### China region field
|
|
94
|
+
|
|
95
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
96
|
+
| --- | --- | --- | --- | --- | --- |
|
|
97
|
+
| `chinaRegions` | Province, city, and district geographic dictionary | Business runtime data | Schema-only | Not included | Backed up |
|
|
98
|
+
|
|
99
|
+
### Auto-number field
|
|
100
|
+
|
|
101
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
102
|
+
| --- | --- | --- | --- | --- | --- |
|
|
103
|
+
| `sequences` | Sequence table for auto-generated business numbers | System base data | Overwrite | Included | Backed up |
|
|
104
|
+
|
|
105
|
+
### UI Schema
|
|
106
|
+
|
|
107
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
108
|
+
| --- | --- | --- | --- | --- | --- |
|
|
109
|
+
| `uiButtonSchemasRoles` | Relationship between button permissions and roles | System base data | Overwrite | Included | Backed up |
|
|
110
|
+
| `uiSchemaServerHooks` | Server-side hook extension points for UI configuration | System base data | Overwrite | Included | Backed up |
|
|
111
|
+
| `uiSchemaTemplates` | Reusable form and detail layout fragments | System base data | Overwrite | Included | Backed up |
|
|
112
|
+
| `uiSchemaTreePath` | Materialized paths for component-tree hierarchy | System base data | Overwrite | Included | Backed up |
|
|
113
|
+
| `uiSchemas` | JSON layout definitions for pages and blocks | System base data | Overwrite | Included | Backed up |
|
|
114
|
+
|
|
115
|
+
### UI templates
|
|
116
|
+
|
|
117
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
118
|
+
| --- | --- | --- | --- | --- | --- |
|
|
119
|
+
| `flowModelTemplateUsages` | Entities instantiated from a flow template | System base data | Overwrite | Included | Backed up |
|
|
120
|
+
| `flowModelTemplates` | Reusable flow-structure templates | System base data | Overwrite | Included | Backed up |
|
|
121
|
+
|
|
122
|
+
### Flow engine
|
|
123
|
+
|
|
124
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
125
|
+
| --- | --- | --- | --- | --- | --- |
|
|
126
|
+
| `flowModelTreePath` | Materialized paths for flow-model tree structures | System base data | Overwrite | Included | Backed up |
|
|
127
|
+
| `flowModels` | Model definitions for the modern flow engine | System base data | Overwrite | Included | Backed up |
|
|
128
|
+
| `flowSql` | SQL snippets or scripts registered in flows | System base data | Overwrite | Included | Backed up |
|
|
129
|
+
|
|
130
|
+
### Block templates
|
|
131
|
+
|
|
132
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
133
|
+
| --- | --- | --- | --- | --- | --- |
|
|
134
|
+
| `blockTemplateLinks` | Relationships between pages and block templates | System base data | Overwrite | Included | Backed up |
|
|
135
|
+
| `blockTemplates` | Reusable UI block definitions | System base data | Overwrite | Included | Backed up |
|
|
136
|
+
|
|
137
|
+
### iframe block
|
|
138
|
+
|
|
139
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
140
|
+
| --- | --- | --- | --- | --- | --- |
|
|
141
|
+
| `iframeHtml` | HTML configuration required by embedded iframes | System base data | Overwrite | Included | Backed up |
|
|
142
|
+
|
|
143
|
+
### Mobile
|
|
144
|
+
|
|
145
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
146
|
+
| --- | --- | --- | --- | --- | --- |
|
|
147
|
+
| `mobileRoutes` | Mobile app menus and routes | System base data | Overwrite | Included | Backed up |
|
|
148
|
+
|
|
149
|
+
### Theme editor
|
|
150
|
+
|
|
151
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
152
|
+
| --- | --- | --- | --- | --- | --- |
|
|
153
|
+
| `themeConfig` | Light/dark themes and brand colors | System base data | Overwrite | Included | Backed up |
|
|
154
|
+
|
|
155
|
+
### Map block
|
|
156
|
+
|
|
157
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
158
|
+
| --- | --- | --- | --- | --- | --- |
|
|
159
|
+
| `mapConfiguration` | Map widget center, zoom, and base-map configuration | System base data | Overwrite | Included | Backed up |
|
|
160
|
+
|
|
161
|
+
### Public forms
|
|
162
|
+
|
|
163
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
164
|
+
| --- | --- | --- | --- | --- | --- |
|
|
165
|
+
| `publicForms` | External forms and submission-entry configuration | System base data | Overwrite | Included | Backed up |
|
|
166
|
+
|
|
167
|
+
### Template printing
|
|
168
|
+
|
|
169
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
170
|
+
| --- | --- | --- | --- | --- | --- |
|
|
171
|
+
| `printingTemplates` | Print layouts for list or detail views | System base data | Overwrite | Included | Backed up |
|
|
172
|
+
|
|
173
|
+
### ACL
|
|
174
|
+
|
|
175
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
176
|
+
| --- | --- | --- | --- | --- | --- |
|
|
177
|
+
| `roles` | Role definitions for permission sets | System base data | Overwrite | Included | Backed up |
|
|
178
|
+
| `rolesResources` | Resources granted to roles | System base data | Overwrite | Included | Backed up |
|
|
179
|
+
| `rolesResourcesActions` | Actions allowed on resources, such as view and update | System base data | Overwrite | Included | Backed up |
|
|
180
|
+
| `rolesResourcesScopes` | Data filter scopes visible to roles | System base data | Overwrite | Included | Backed up |
|
|
181
|
+
| `rolesUsers` | Many-to-many relationship between users and roles | Business runtime data | Schema-only | Not included | Backed up |
|
|
182
|
+
|
|
183
|
+
### Authentication
|
|
184
|
+
|
|
185
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
186
|
+
| --- | --- | --- | --- | --- | --- |
|
|
187
|
+
| `authenticators` | Password and third-party login method configuration | System base data | Overwrite | Included | Backed up |
|
|
188
|
+
| `tokenControlConfig` | Session duration and refresh strategy | System base data | Overwrite | Included | Backed up |
|
|
189
|
+
| `issuedTokens` | Issued login or API access tokens | Business runtime data | Schema-only | Not included | Backed up |
|
|
190
|
+
| `tokenBlacklist` | Tokens that have been logged out or forcibly invalidated | Business runtime data | Schema-only | Not included | Backed up |
|
|
191
|
+
| `usersAuthenticators` | Bindings between users and authentication methods | Business runtime data | Schema-only | Not included | Backed up |
|
|
192
|
+
|
|
193
|
+
### Two-factor authentication
|
|
194
|
+
|
|
195
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
196
|
+
| --- | --- | --- | --- | --- | --- |
|
|
197
|
+
| `twoFactorAuthSettings` | 2FA methods and user-level switches | System base data | Overwrite | Included | Backed up |
|
|
198
|
+
|
|
199
|
+
### API keys
|
|
200
|
+
|
|
201
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
202
|
+
| --- | --- | --- | --- | --- | --- |
|
|
203
|
+
| `apiKeys` | Open API keys and permission scopes | Business runtime data | Schema-only | Not included | Backed up |
|
|
204
|
+
|
|
205
|
+
### Password policy
|
|
206
|
+
|
|
207
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
208
|
+
| --- | --- | --- | --- | --- | --- |
|
|
209
|
+
| `passwordPolicy` | Password complexity and expiration policies | System base data | Overwrite | Included | Backed up |
|
|
210
|
+
| `lockedUsers` | Accounts temporarily locked by policy | Business runtime data | Schema-only | Not included | Backed up |
|
|
211
|
+
| `userPasswordHistory` | Recent password hashes used to prevent reuse | Business runtime data | Schema-only | Not included | Backed up |
|
|
212
|
+
|
|
213
|
+
### IP restriction
|
|
214
|
+
|
|
215
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
216
|
+
| --- | --- | --- | --- | --- | --- |
|
|
217
|
+
| `ipRestrictionConfig` | IP allowlist or blocklist rules | System base data | Overwrite | Included | Backed up |
|
|
218
|
+
|
|
219
|
+
### Users
|
|
220
|
+
|
|
221
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
222
|
+
| --- | --- | --- | --- | --- | --- |
|
|
223
|
+
| `users` | Login accounts, profiles, and basic status | Business runtime data | Schema-only | Not included | Backed up |
|
|
224
|
+
|
|
225
|
+
### Departments
|
|
226
|
+
|
|
227
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
228
|
+
| --- | --- | --- | --- | --- | --- |
|
|
229
|
+
| `departments` | Department tree in the organization structure | Business runtime data | Overwrite | Not included | Backed up |
|
|
230
|
+
| `departmentsRoles` | Bindings between departments and default roles | Business runtime data | Overwrite | Not included | Backed up |
|
|
231
|
+
| `departmentsUsers` | Relationships between users and departments | Business runtime data | Schema-only | Not included | Backed up |
|
|
232
|
+
|
|
233
|
+
### User data sync
|
|
234
|
+
|
|
235
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
236
|
+
| --- | --- | --- | --- | --- | --- |
|
|
237
|
+
| `userDataSyncSources` | External identity source or account-system connection configuration | System base data | Overwrite | Included | Backed up |
|
|
238
|
+
| `userDataSyncRecords` | Execution records for synchronization jobs | Business runtime data | Schema-only | Not included | Backed up |
|
|
239
|
+
| `userDataSyncRecordsResources` | Tables or resources involved in synchronization jobs | Business runtime data | Schema-only | Not included | Backed up |
|
|
240
|
+
| `userDataSyncTasks` | Synchronization task records | Business runtime data | Schema-only | Not included | Backed up |
|
|
241
|
+
|
|
242
|
+
### Workflow
|
|
243
|
+
|
|
244
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
245
|
+
| --- | --- | --- | --- | --- | --- |
|
|
246
|
+
| `flow_nodes` | Workflow nodes | System base data | Overwrite | Included | Backed up |
|
|
247
|
+
| `workflows` | Automation flow charts, triggers, and node configuration | System base data | Overwrite | Included | Backed up |
|
|
248
|
+
| `jobs` | Execution result of each node in a workflow run | Business runtime data | Schema-only | Not included | Backed up |
|
|
249
|
+
| `executions` | Status, inputs, outputs, and log indexes for workflow runs | Business runtime data | Schema-only | Not included | Backed up |
|
|
250
|
+
| `userWorkflowTasks` | Task-count statistics for users | Business runtime data | Schema-only | Not included | Backed up |
|
|
251
|
+
| `workflowCategories` | Workflow grouping in the UI | Business runtime data | Overwrite | Not included | Backed up |
|
|
252
|
+
| `workflowCategoryRelations` | Many-to-many relationship between workflows and categories | Business runtime data | Overwrite | Not included | Backed up |
|
|
253
|
+
| `workflowStats` | Aggregated metrics such as run count and success rate | Business runtime data | Schema-only | Not included | Backed up |
|
|
254
|
+
| `workflowTasks` | Task execution records for automation nodes | Business runtime data | Schema-only | Not included | Backed up |
|
|
255
|
+
| `workflowVersionStats` | Execution and performance statistics by workflow version | Business runtime data | Schema-only | Not included | Backed up |
|
|
256
|
+
|
|
257
|
+
### Workflow approval
|
|
258
|
+
|
|
259
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
260
|
+
| --- | --- | --- | --- | --- | --- |
|
|
261
|
+
| `approvalAudienceUsers` | Relationship between approval audiences and users | Business runtime data | Schema-only | Not included | Backed up |
|
|
262
|
+
| `approvalAudiences` | Approval notification or participation scope grouped by role or user | Business runtime data | Schema-only | Not included | Backed up |
|
|
263
|
+
| `approvalExecutions` | Runtime status and current node of an approval flow | Business runtime data | Schema-only | Not included | Backed up |
|
|
264
|
+
| `approvalMsgTpls` | Message templates for approval notices and tasks | Business runtime data | Overwrite | Not included | Backed up |
|
|
265
|
+
| `approvalRecords` | Approval tasks and processing results from a personal view | Business runtime data | Schema-only | Not included | Backed up |
|
|
266
|
+
| `approvals` | Approval-flow templates and step configuration | Business runtime data | Schema-only | Not included | Backed up |
|
|
267
|
+
|
|
268
|
+
### Workflow manual node
|
|
269
|
+
|
|
270
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
271
|
+
| --- | --- | --- | --- | --- | --- |
|
|
272
|
+
| `workflowManualTasks` | Manual-node tasks that require human handling | Business runtime data | Schema-only | Not included | Backed up |
|
|
273
|
+
|
|
274
|
+
### Workflow CC
|
|
275
|
+
|
|
276
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
277
|
+
| --- | --- | --- | --- | --- | --- |
|
|
278
|
+
| `workflowCcTasks` | Read-only copied workflow tasks | Business runtime data | Schema-only | Not included | Backed up |
|
|
279
|
+
|
|
280
|
+
### Notification manager
|
|
281
|
+
|
|
282
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
283
|
+
| --- | --- | --- | --- | --- | --- |
|
|
284
|
+
| `notificationChannels` | Delivery channel configuration such as in-app messages and email | System base data | Overwrite | Included | Backed up |
|
|
285
|
+
| `notificationSendLogs` | Delivery status and failure reason for notifications | Business runtime data | Schema-only | Not included | Backed up |
|
|
286
|
+
|
|
287
|
+
### In-app messages
|
|
288
|
+
|
|
289
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
290
|
+
| --- | --- | --- | --- | --- | --- |
|
|
291
|
+
| `notificationInAppMessages` | In-app messages received by users | Business runtime data | Schema-only | Not included | Backed up |
|
|
292
|
+
|
|
293
|
+
### Verification
|
|
294
|
+
|
|
295
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
296
|
+
| --- | --- | --- | --- | --- | --- |
|
|
297
|
+
| `verifiers` | Configuration for who can initiate or complete verification | System base data | Overwrite | Included | Backed up |
|
|
298
|
+
| `otpRecords` | SMS or email OTP issue and verification records | Business runtime data | Schema-only | Not included | Backed up |
|
|
299
|
+
| `usersVerifiers` | Bindings between users and verification channels or entities | Business runtime data | Schema-only | Not included | Backed up |
|
|
300
|
+
|
|
301
|
+
### Mail manager
|
|
302
|
+
|
|
303
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
304
|
+
| --- | --- | --- | --- | --- | --- |
|
|
305
|
+
| `mailGeneralSettings` | Global mail behavior and default values | System base data | Overwrite | Included | Backed up |
|
|
306
|
+
| `mailSettings` | Mail plugin switches and parameters | System base data | Overwrite | Included | Backed up |
|
|
307
|
+
| `mailAccounts` | Sending mailbox accounts and SMTP configuration | Business runtime data | Overwrite | Not included | Backed up |
|
|
308
|
+
| `mailMassMessages` | Mass-mail tasks and recipient batches | Business runtime data | Schema-only | Not included | Backed up |
|
|
309
|
+
| `mailMessageLabels` | Mail category label definitions | Business runtime data | Schema-only | Not included | Backed up |
|
|
310
|
+
| `mailMessageNotes` | Internal notes for individual emails | Business runtime data | Schema-only | Not included | Backed up |
|
|
311
|
+
| `mailMessages` | Indexes for synced or sent email content | Business runtime data | Schema-only | Not included | Backed up |
|
|
312
|
+
| `mailTemplates` | HTML/text templates for notification emails | Business runtime data | Schema-only | Not included | Backed up |
|
|
313
|
+
| `mailmessagelabelsMailmessages` | Join table between emails and many-to-many labels | Business runtime data | Schema-only | Not included | Backed up |
|
|
314
|
+
| `mailmessagelabelsMailmessagesRel` | Auxiliary fields or extension table for mail-label relationships | Business runtime data | Schema-only | Not included | Backed up |
|
|
315
|
+
|
|
316
|
+
### AI
|
|
317
|
+
|
|
318
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
319
|
+
| --- | --- | --- | --- | --- | --- |
|
|
320
|
+
| `aiEmployees` | AI employee profiles: nickname, skills, models, knowledge bases, and related configuration | System base data | Overwrite | Included | Backed up |
|
|
321
|
+
| `aiSettings` | AI basic settings | System base data | Overwrite | Included | Backed up |
|
|
322
|
+
| `rolesAiEmployees` | Relationship between AI employees and roles | System base data | Overwrite | Included | Backed up |
|
|
323
|
+
| `llmServices` | LLM providers and model endpoint configuration | System base data | Overwrite | Included | Backed up |
|
|
324
|
+
| `aiContextDatasources` | Business collections, fields, and filters queryable by AI employees | Business runtime data | Schema-only | Not included | Backed up |
|
|
325
|
+
| `aiConversations` | Conversation context for sessions, topics, and message threads | Business runtime data | Schema-only | Not included | Backed up |
|
|
326
|
+
| `aiFiles` | Uploaded files and storage references generated by the AI plugin | Business runtime data | Schema-only | Not included | Backed up |
|
|
327
|
+
| `aiMessages` | User and assistant messages in conversations | Business runtime data | Schema-only | Not included | Backed up |
|
|
328
|
+
| `aiToolMessages` | Requests and responses for function or tool calls | Business runtime data | Schema-only | Not included | Backed up |
|
|
329
|
+
| `usersAiEmployees` | Relationship between user custom prompts and AI employees | Business runtime data | Schema-only | Not included | Backed up |
|
|
330
|
+
| `lcCheckpointBlobs` | Binary blocks for LLM conversation checkpoints | Runtime temporary data | Schema-only | Not included | Not backed up |
|
|
331
|
+
| `lcCheckpointWrites` | Incremental checkpoint write records | Runtime temporary data | Schema-only | Not included | Not backed up |
|
|
332
|
+
| `lcCheckpoints` | LangGraph checkpoint metadata for recoverable conversations | Runtime temporary data | Schema-only | Not included | Not backed up |
|
|
333
|
+
|
|
334
|
+
### AI knowledge base
|
|
335
|
+
|
|
336
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
337
|
+
| --- | --- | --- | --- | --- | --- |
|
|
338
|
+
| `aiKnowledgeBaseDocs` | Document chunks and index metadata stored in knowledge bases | Business runtime data | Schema-only | Not included | Backed up |
|
|
339
|
+
| `aiKnowledgeBase` | Knowledge-base type, external ID, and base information | Business runtime data | Schema-only | Not included | Backed up |
|
|
340
|
+
| `aiVectorDatabases` | Vector database service and connection configuration | Business runtime data | Schema-only | Not included | Backed up |
|
|
341
|
+
| `aiVectorStoreConfig` | Relationship between vector database connections and embedding models | Business runtime data | Schema-only | Not included | Backed up |
|
|
342
|
+
|
|
343
|
+
### Environment variables
|
|
344
|
+
|
|
345
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
346
|
+
| --- | --- | --- | --- | --- | --- |
|
|
347
|
+
| `environmentVariables` | Deployment-related key-value entries, such as secret placeholder names | System base data | Schema-only | Included | Backed up |
|
|
348
|
+
|
|
349
|
+
### Migration manager
|
|
350
|
+
|
|
351
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
352
|
+
| --- | --- | --- | --- | --- | --- |
|
|
353
|
+
| `migrationRules` | Rules and scope configuration in the migration manager | System base data | Schema-only | Included | Backed up |
|
|
354
|
+
|
|
355
|
+
### Backup manager
|
|
356
|
+
|
|
357
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
358
|
+
| --- | --- | --- | --- | --- | --- |
|
|
359
|
+
| `backupSettings` | Automatic backup and retention policy | Business runtime data | Overwrite | Not included | Backed up |
|
|
360
|
+
|
|
361
|
+
### Audit logs
|
|
362
|
+
|
|
363
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
364
|
+
| --- | --- | --- | --- | --- | --- |
|
|
365
|
+
| `auditTrails` | Trace of who operated on which resources and when | Business runtime data | Schema-only | Not included | Backed up |
|
|
366
|
+
|
|
367
|
+
### Async tasks
|
|
368
|
+
|
|
369
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
370
|
+
| --- | --- | --- | --- | --- | --- |
|
|
371
|
+
| `asyncTasks` | Queue, status, and result of long-running tasks | Business runtime data | Schema-only | Not included | Backed up |
|
|
372
|
+
|
|
373
|
+
### Record history
|
|
374
|
+
|
|
375
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
376
|
+
| --- | --- | --- | --- | --- | --- |
|
|
377
|
+
| `recordHistoryCollections` | Collections with field history enabled | System base data | Overwrite | Included | Backed up |
|
|
378
|
+
| `recordHistoryFields` | Fields that need history records | System base data | Overwrite | Included | Backed up |
|
|
379
|
+
| `recordHistoryTemplate` | Display template for history records | System base data | Overwrite | Included | Backed up |
|
|
380
|
+
| `recordFieldHistories` | Historical values and timeline for field changes | Business runtime data | Schema-only | Not included | Backed up |
|
|
381
|
+
| `recordFieldSnapshots` | Snapshot proof of field values at a point in time | Business runtime data | Schema-only | Not included | Backed up |
|
|
382
|
+
| `recordHistories` | Versioned change records for entire records | Business runtime data | Schema-only | Not included | Backed up |
|
|
383
|
+
|
|
384
|
+
### File manager
|
|
385
|
+
|
|
386
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
387
|
+
| --- | --- | --- | --- | --- | --- |
|
|
388
|
+
| `storages` | Local, S3, OSS, and other storage bucket configuration | System base data | Overwrite | Included | Backed up |
|
|
389
|
+
| `attachments` | File attachment metadata associated with business records | Business runtime data | Schema-only | Not included | Backed up |
|
|
390
|
+
|
|
391
|
+
### Localization
|
|
392
|
+
|
|
393
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
394
|
+
| --- | --- | --- | --- | --- | --- |
|
|
395
|
+
| `localizationTexts` | Keys and default text awaiting translation | System base data | Overwrite | Included | Backed up |
|
|
396
|
+
| `localizationTranslations` | Actual translated content for each language | System base data | Overwrite | Included | Backed up |
|
|
397
|
+
|
|
398
|
+
### Localization tester
|
|
399
|
+
|
|
400
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
401
|
+
| --- | --- | --- | --- | --- | --- |
|
|
402
|
+
| `localeTester` | Entries used for localization debugging or testing | Business runtime data | Schema-only | Not included | Backed up |
|
|
403
|
+
|
|
404
|
+
### Custom request
|
|
405
|
+
|
|
406
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
407
|
+
| --- | --- | --- | --- | --- | --- |
|
|
408
|
+
| `customRequests` | Custom HTTP request actions with URL and method configuration | System base data | Overwrite | Included | Backed up |
|
|
409
|
+
| `customRequestsRoles` | Roles allowed to call custom requests | System base data | Overwrite | Included | Backed up |
|
|
410
|
+
|
|
411
|
+
### Custom variables
|
|
412
|
+
|
|
413
|
+
| Table | Description | Data type | Default migration strategy | Version control | Backup/restore |
|
|
414
|
+
| --- | --- | --- | --- | --- | --- |
|
|
415
|
+
| `customVariables` | Variable definitions and default values available to flows or globally | System base data | Overwrite | Included | Backed up |
|
|
416
|
+
|
|
417
|
+
## User-defined tables
|
|
418
|
+
|
|
419
|
+
User-defined tables are treated as business data by default. In most cases, migrate only the table structure and choose schema-only.
|
|
420
|
+
|
|
421
|
+
If a user-defined table stores business configuration, categories, templates, rules, or other metadata, and those records should be synchronized from development to staging or production with the release, choose overwrite based on the business scenario.
|
|
422
|
+
|
|
423
|
+
If a user-defined table stores runtime data such as customers, orders, tickets, approval records, messages, or logs, avoid overwriting production records.
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
pkg: '@nocobase/plugin-migration-manager'
|
|
3
|
+
title: "Migration Manager"
|
|
4
|
+
description: "Operations migration: migrate application configuration from one environment to another, with schema-only, overwrite, and skip rules. Depends on Backup Manager."
|
|
5
|
+
keywords: "Migration Manager,Migration,application configuration migration,migration rules,schema-only,overwrite,skip,database migration,operations,NocoBase"
|
|
3
6
|
---
|
|
4
7
|
|
|
5
8
|
# Migration Manager
|
|
@@ -26,17 +29,15 @@ The Migration Manager transfers tables and data from the primary database based
|
|
|
26
29
|
|
|
27
30
|
### Built-in Rules
|
|
28
31
|
|
|
29
|
-
Migration Manager supports
|
|
32
|
+
Migration Manager supports the following three rules:
|
|
30
33
|
|
|
31
|
-
- **Schema-only:** Only
|
|
32
|
-
- **Overwrite:**
|
|
33
|
-
- **
|
|
34
|
-
- **Insert-ignore:** Inserts new records; skips existing ones.
|
|
35
|
-
- **Skip:** No changes to the table.
|
|
34
|
+
- **Schema-only:** Only synchronizes table structures. No data is inserted or updated.
|
|
35
|
+
- **Overwrite:** Clears existing table records, then inserts new data.
|
|
36
|
+
- **Skip:** Does nothing to the table.
|
|
36
37
|
|
|
37
|
-
**
|
|
38
|
-
-
|
|
39
|
-
-
|
|
38
|
+
**Notes:**
|
|
39
|
+
- Overwrite also synchronizes table-structure changes.
|
|
40
|
+
- User-defined business data tables usually use schema-only to avoid overwriting production business data.
|
|
40
41
|
|
|
41
42
|
### Detailed Design
|
|
42
43
|
|
|
@@ -46,6 +47,8 @@ Migration Manager supports five built-in rules:
|
|
|
46
47
|
|
|
47
48
|
Configure migration rules
|
|
48
49
|
|
|
50
|
+
For the tables behind default strategies, see: [Built-in tables for applications and major plugins](./built-in-tables.md).
|
|
51
|
+
|
|
49
52
|

|
|
50
53
|
|
|
51
54
|
Enable independent rules
|