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
- Remove placeholder dm1.py migration file that shouldn't be committed
- Update migrations.md to clarify migrate vs om migrate differences
- Document deprecation of standalone migrate command
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Copy file name to clipboardExpand all lines: docs/migrations.md
+23-5Lines changed: 23 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,15 +11,17 @@ Redis OM provides two CLI interfaces:
11
11
12
12
### Unified CLI (Recommended)
13
13
```bash
14
-
om migrate #Schema migrations
14
+
om migrate #File-based schema migrations with rollback support
15
15
om migrate-data # Data migrations
16
16
```
17
17
18
-
### Individual Commands (Backward Compatible)
18
+
### Legacy Command (Deprecated)
19
19
```bash
20
-
migrate #Schema migrations (original command still works)
20
+
migrate #Automatic schema migrations (deprecated - use om migrate)
21
21
```
22
22
23
+
⚠️ **Important**: The standalone `migrate` command uses automatic migrations (immediate DROP+CREATE) and is deprecated. Use `om migrate` for the new file-based migration system with rollback support.
24
+
23
25
## Schema Migrations
24
26
25
27
Schema migrations manage RediSearch index definitions. When you change field types, indexing options, or other schema properties, Redis OM automatically detects these changes and can update your indices accordingly.
@@ -51,9 +53,25 @@ om migrate run
51
53
om migrate run --migrations-dir myapp/schema-migrations
52
54
```
53
55
54
-
> **Note**: The original `migrate` command is still available for backward compatibility.
56
+
> **Note**: The legacy `migrate` command performs automatic migrations without file tracking and is deprecated. Use `om migrate` for production deployments.
57
+
58
+
### Migration Approaches
59
+
60
+
Redis OM provides two approaches to schema migrations:
0 commit comments