Skip to content

Commit 5671e6f

Browse files
committed
chore: mark index migrator as experimental across docs, CLI, and module docstring
1 parent a9b3972 commit 5671e6f

5 files changed

Lines changed: 32 additions & 0 deletions

File tree

docs/api/cli.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,10 @@ The command returns the following metrics:
446446
rvl migrate
447447
-----------
448448

449+
.. warning::
450+
451+
The index migrator is an **experimental** feature. APIs, CLI commands, and on-disk formats (plans, checkpoints, backups) may change in future releases. Review migration plans carefully before applying to production indexes.
452+
449453
Manage document-preserving index migrations. This command group provides subcommands for planning, executing, and validating schema migrations that preserve existing data.
450454

451455
**Syntax**

docs/concepts/index-migrations.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ myst:
77

88
# Index Migrations
99

10+
```{warning}
11+
The index migrator is an **experimental** feature. APIs, CLI commands, and on-disk formats (plans, checkpoints, backups) may change in future releases. Review migration plans carefully before applying to production indexes.
12+
```
13+
1014
Redis Search indexes are immutable. To change an index schema, you must drop the existing index and create a new one. RedisVL provides a migration workflow that automates this process while preserving your data.
1115

1216
This page explains how migrations work and which changes are supported. For step by step instructions, see the [migration guide](../user_guide/how_to_guides/migrate-indexes.md).

docs/user_guide/how_to_guides/migrate-indexes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ myst:
77

88
# Migrate an Index
99

10+
```{warning}
11+
The index migrator is an **experimental** feature. APIs, CLI commands, and on-disk formats (plans, checkpoints, backups) may change in future releases. Review migration plans carefully before applying to production indexes.
12+
```
13+
1014
This guide shows how to safely change your index schema using the RedisVL migrator.
1115

1216
## Quick Start

redisvl/cli/migrate.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,13 @@ class Migrate:
5050
]
5151
)
5252

53+
_EXPERIMENTAL_BANNER = (
54+
"NOTE: The index migrator is an experimental feature. "
55+
"APIs, CLI commands, and on-disk formats (plans, checkpoints, backups) "
56+
"may change in future releases. "
57+
"Review migration plans carefully before applying to production indexes."
58+
)
59+
5360
def __init__(self):
5461
parser = argparse.ArgumentParser(usage=self.usage)
5562
parser.add_argument("command", help="Subcommand to run")
@@ -61,6 +68,8 @@ def __init__(self):
6168
parser.print_help()
6269
sys.exit(1)
6370

71+
print(f"\n⚠️ {self._EXPERIMENTAL_BANNER}\n")
72+
6473
try:
6574
getattr(self, command)()
6675
except Exception as e:

redisvl/migration/__init__.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
"""Experimental index migration module.
2+
3+
.. warning::
4+
5+
This module is **experimental** and may change or be removed in future
6+
releases. APIs, CLI commands, and on-disk formats (plans, checkpoints,
7+
backups) are not yet covered by semantic-versioning guarantees.
8+
Review the migration plan carefully before applying it to
9+
production indexes.
10+
"""
11+
112
from redisvl.migration.async_executor import AsyncMigrationExecutor
213
from redisvl.migration.async_planner import AsyncMigrationPlanner
314
from redisvl.migration.async_validation import AsyncMigrationValidator

0 commit comments

Comments
 (0)