feat(commands): new "document migrate" subcommand

Author: David-Guillot

django_opensearch_dsl/management/commands/opensearch.py

@@ -212,7 +212,11 @@ def _manage_document(
                 self.stderr.write(f"Error while filtering on '{model}' (from index '{index._name}'):\n{e}'")  # noqa
                 exit(1)
             else:
-                s += f"\n\t- {qs} {document.django.model.__name__}."
+                if action == OpensearchAction.MIGRATE:
+                    prefix = ""
+                else:
+                    prefix = f" {qs}"
+                s += f"\n\t- {prefix} {document.django.model.__name__}."
 
         # Display expected actions
         if verbosity or not force:
@@ -231,28 +235,34 @@ def _manage_document(
         result = "\n"
         for index, kwargs in zip(indices, kwargs_list):
             document = index._doc_types[0]()  # noqa
-            qs = document.get_indexing_queryset(stdout=self.stdout._out, verbose=verbosity, action=action, **kwargs)
-            success, errors = document.update(
-                qs, action,
-                parallel=parallel, index_suffix=index_suffix,
-                refresh=refresh, raise_on_error=False
-            )
-
-            success_str = self.style.SUCCESS(success) if success else success
-            errors_str = self.style.ERROR(len(errors)) if errors else len(errors)
             model = document.django.model.__name__
 
-            if verbosity == 1:
-                result += f"{success_str} {model} successfully {action.past}, {errors_str} errors:\n"
-                reasons = defaultdict(int)
-                for e in errors:  # Count occurrence of each error
-                    error = e.get(action, {"result": "unknown error"}).get("result", "unknown error")
-                    reasons[error] += 1
-                for reasons, total in reasons.items():
-                    result += f"    - {reasons} : {total}\n"
+            if action == OpensearchAction.MIGRATE:
+                document.migrate(index_suffix)
+                if verbosity >= 1:
+                    result += f"{model} successfully migrated to index {document.get_index_name(suffix=index_suffix)}\n"
+            else:
+                qs = document.get_indexing_queryset(stdout=self.stdout._out, verbose=verbosity, action=action, **kwargs)
+                success, errors = document.update(
+                    qs, action,
+                    parallel=parallel, index_suffix=index_suffix,
+                    refresh=refresh, raise_on_error=False
+                )
+
+                success_str = self.style.SUCCESS(success) if success else success
+                errors_str = self.style.ERROR(len(errors)) if errors else len(errors)
+
+                if verbosity == 1:
+                    result += f"{success_str} {model} successfully {action.past}, {errors_str} errors:\n"
+                    reasons = defaultdict(int)
+                    for e in errors:  # Count occurrence of each error
+                        error = e.get(action, {"result": "unknown error"}).get("result", "unknown error")
+                        reasons[error] += 1
+                    for reasons, total in reasons.items():
+                        result += f"    - {reasons} : {total}\n"
 
-            if verbosity > 1:
-                result += f"{success_str} {model} successfully {action}d, {errors_str} errors:\n {errors}\n"
+                if verbosity > 1:
+                    result += f"{success_str} {model} successfully {action}d, {errors_str} errors:\n {errors}\n"
 
         if verbosity:
             self.stdout.write(result + "\n")
@@ -308,11 +318,12 @@ def add_arguments(self, parser):
         subparser.add_argument(
             "action",
             type=str,
-            help="Whether you want to index, delete or update documents in indices.",
+            help="Whether you want to index, delete or update documents in indices. Or migrate from an index to another.",
             choices=[
                 OpensearchAction.INDEX.value,
                 OpensearchAction.DELETE.value,
                 OpensearchAction.UPDATE.value,
+                OpensearchAction.MIGRATE.value,
             ],
         )
         subparser.add_argument(
@@ -345,7 +356,7 @@ def add_arguments(self, parser):
             ),
         )
         subparser.add_argument("--force", action="store_true", default=False, help="Do not ask for confirmation.")
-        subparser.add_argument("--index-suffix", type=str, default=None, help="The suffix for the index name (if you don't provide one, the current index will be used).")
+        subparser.add_argument("--index-suffix", type=str, default=None, help="The suffix for the index name (if you don't provide one, the current index will be used). Required for `migrate` subcommand.")
         subparser.add_argument(
             "-i", "--indices", type=str, nargs="*", help="Only update documents on the given indices."
         )

django_opensearch_dsl/management/enums.py

@@ -7,6 +7,7 @@ class OpensearchAction(str, Enum):
     INDEX = ("index", "indexing", "indexed")
     UPDATE = ("update", "updating", "updated")
     CREATE = ("create", "creating", "created")
+    MIGRATE = ("migrate", "migrating", "migrated")
     LIST = ("list", "listing", "listed")
     DELETE = ("delete", "deleting", "deleted")
 

tests/tests/management/test_document.py

@@ -232,3 +232,11 @@ def test_index_not_refresh(self):
         self.assertEqual(ContinentDocument.search().count(), 3)
         self.assertEqual(CountryDocument.search().count(), 3)
         self.assertEqual(EventDocument.search().count(), 3)
+
+    def test_migrate(self):
+        self.call_command("opensearch", "index", "create", suffix="v1", force=True)
+        self.call_command("opensearch", "index", "create", suffix="v2", force=True)
+        self.assertEqual(CountryDocument.get_active_index()._name, "country--v1")
+
+        self.call_command("opensearch", "document", "migrate", index_suffix="v2", force=True)
+        self.assertEqual(CountryDocument.get_active_index()._name, "country--v2")