You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: MIGRATION_GUIDE.md
+40-4Lines changed: 40 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,48 @@
1
1
# Migration Guide
2
2
3
+
## [v0.4.0]
4
+
5
+
This guide provides instructions to perform a database migration that adds a `version` column and `object` attribute to all gen_config in all action tables. (Migration from owl version earlier than v0.4.0).
6
+
7
+
### Prerequisites
8
+
9
+
1. Ensure **owl/jamaibase** has been updated to at least **v0.4.0**.
10
+
11
+
### Steps to Perform the Migration
12
+
13
+
1. Navigate to the **JamAIBase** repository directory (with `./db` and `./scripts` in it).
14
+
15
+
```bash
16
+
cd<JamAIBase repository directory>
17
+
```
18
+
19
+
2. Run the migration script (ensure the current Python environment is the one with **owl** installed):
20
+
```bash
21
+
python scripts/migration_v040.py
22
+
```
23
+
24
+
### Expected Output
25
+
26
+
- The script will print messages indicating whether the `file` column was renamed to `image` column.
27
+
- The script will print messages indicating whether the `Page` column was added to knowledge table or if it already exist.
28
+
- If any errors occur, they will be printed to the console.
29
+
30
+
### Troubleshooting
31
+
32
+
- Ensure that the migration script is run in the **JamAIBase** repository directory (`./db` and `./scripts` directories should be in this working directory).
33
+
- Ensure the Python environment is the one with **owl** installed.
34
+
- Check the script's error messages for any issues encountered during the migration process.
35
+
- Contact us for further assistance.
36
+
37
+
## [v0.3.0]
38
+
3
39
This guide provides instructions to perform a database migration that adds a `version` column and `object` attribute to all gen_config in all action tables. (Migration from owl version earlier than v0.3.0).
4
40
5
-
## Prerequisites
41
+
###Prerequisites
6
42
7
43
1. Ensure **owl/jamaibase** has been updated to at least **v0.3.0**.
8
44
9
-
## Steps to Perform the Migration
45
+
###Steps to Perform the Migration
10
46
11
47
1. Navigate to the **JamAIBase** repository directory (with `./db` and `./scripts` in it).
12
48
@@ -19,13 +55,13 @@ This guide provides instructions to perform a database migration that adds a `ve
19
55
python scripts/migration_v030.py
20
56
```
21
57
22
-
## Expected Output
58
+
###Expected Output
23
59
24
60
- The script will print messages indicating whether the `version` column was added or if it already exists in each database.
25
61
- The script will print messages indicating whether the `object` attribute was added into each `gen_config`.
26
62
- If any errors occur, they will be printed to the console.
27
63
28
-
## Troubleshooting
64
+
###Troubleshooting
29
65
30
66
- Ensure that the migration script is run in the **JamAIBase** repository directory (`./db` and `./scripts` directories should be in this working directory).
31
67
- Ensure the Python environment is the one with **owl** installed.
0 commit comments