Add support for --refresh to search_index command

Currently when updating or rebuilding an index, the `refresh` parameter
is never set, regardless if settings.ELASTICSEARCH_DSL_AUTO_REFRESH is
set or if auto_refresh is set on the Document class.

This commit adds the ability to pass `--refresh` to the `search_index`
management command, to force a refresh when the index is updated.

This can be useful, for example, if you want to programmatically call
that command from some Django tests that fill an index, and then
immediately run tests against that index. Without setting
`refresh=True`, there's no guarantee that the refreshed index will be
available to search.

Author: chosak

django_elasticsearch_dsl/management/commands/search_index.py

@@ -64,6 +64,13 @@ def add_arguments(self, parser):
             help='Run populate/rebuild update single threaded'
         )
         parser.set_defaults(parallel=getattr(settings, 'ELASTICSEARCH_DSL_PARALLEL', False))
+        parser.add_argument(
+            '--refresh',
+            action='store_true',
+            dest='refresh',
+            default=None,
+            help='Refresh indices after populate/rebuild'
+        )
         parser.add_argument(
             '--no-count',
             action='store_false',
@@ -114,7 +121,7 @@ def _populate(self, models, options):
                 "(parallel)" if parallel else "")
             )
             qs = doc().get_indexing_queryset()
-            doc().update(qs, parallel=parallel)
+            doc().update(qs, parallel=parallel, refresh=options['refresh'])
 
     def _delete(self, models, options):
         index_names = [index._name for index in registry.get_indices(models)]

docs/source/management.rst

@@ -18,11 +18,11 @@ Populate the Elasticsearch mappings with the django models data (index need to b
 
 ::
 
-    $ search_index --populate [--models [app[.model] app[.model] ...]] [--parallel]
+    $ search_index --populate [--models [app[.model] app[.model] ...]] [--parallel] [--refresh]
 
 Recreate and repopulate the indices:
 
 ::
 
-    $ search_index --rebuild [-f] [--models [app[.model] app[.model] ...]] [--parallel]
+    $ search_index --rebuild [-f] [--models [app[.model] app[.model] ...]] [--parallel] [--refresh]
 

tests/test_commands.py

@@ -112,15 +112,24 @@ def test_create_all_indices(self):
 
     def test_populate_all_doc_type(self):
         call_command('search_index', stdout=self.out, action='populate')
+        expected_kwargs = {'parallel': False, 'refresh': None}
         # One call for "Indexing NNN documents", one for indexing itself (via get_index_queryset).
         assert self.doc_a1.get_queryset.call_count == 2
-        self.doc_a1.update.assert_called_once_with(self.doc_a1_qs.iterator(), parallel=False)
+        self.doc_a1.update.assert_called_once_with(self.doc_a1_qs.iterator(), **expected_kwargs)
         assert self.doc_a2.get_queryset.call_count == 2
-        self.doc_a2.update.assert_called_once_with(self.doc_a2_qs.iterator(), parallel=False)
+        self.doc_a2.update.assert_called_once_with(self.doc_a2_qs.iterator(), **expected_kwargs)
         assert self.doc_b1.get_queryset.call_count == 2
-        self.doc_b1.update.assert_called_once_with(self.doc_b1_qs.iterator(), parallel=False)
+        self.doc_b1.update.assert_called_once_with(self.doc_b1_qs.iterator(), **expected_kwargs)
         assert self.doc_c1.get_queryset.call_count == 2
-        self.doc_c1.update.assert_called_once_with(self.doc_c1_qs.iterator(), parallel=False)
+        self.doc_c1.update.assert_called_once_with(self.doc_c1_qs.iterator(), **expected_kwargs)
+
+    def test_populate_all_doc_type_refresh(self):
+        call_command('search_index', stdout=self.out, action='populate', refresh=True)
+        expected_kwargs = {'parallel': False, 'refresh': True}
+        self.doc_a1.update.assert_called_once_with(self.doc_a1_qs.iterator(), **expected_kwargs)
+        self.doc_a2.update.assert_called_once_with(self.doc_a2_qs.iterator(), **expected_kwargs)
+        self.doc_b1.update.assert_called_once_with(self.doc_b1_qs.iterator(), **expected_kwargs)
+        self.doc_c1.update.assert_called_once_with(self.doc_c1_qs.iterator(), **expected_kwargs)
 
     def test_rebuild_indices(self):