chore: Bump to v0.8.0

Author: qcoumes

django_opensearch_dsl/__init__.py

@@ -3,7 +3,7 @@
 from .documents import Document  # noqa
 from .fields import *  # noqa
 
-__version__ = "0.7.0"
+__version__ = "0.8.0"
 
 
 def autodiscover() -> None:

django_opensearch_dsl/management/commands/opensearch.py

@@ -274,6 +274,7 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
         )
         subparser.set_defaults(func=self.__list_index)
         subparser.add_argument(
+            "-u",
             "--using",
             type=connection,
             default=connection("default"),
@@ -288,6 +289,7 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
         )
         subparser.set_defaults(func=self._manage_index)
         subparser.add_argument(
+            "-u",
             "--using",
             type=connection,
             default=connection("default"),
@@ -338,6 +340,7 @@ def add_arguments(self, parser: argparse.ArgumentParser) -> None:
             ],
         )
         subparser.add_argument(
+            "-u",
             "--using",
             type=connection,
             default=connection("default"),

docs/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+### 0.8.0 (2025-11-24)
+
+* Add `--using` and `--database` options to the CLI to respectively specify which
+  OpenSearch and database connection to use [#87](https://github.com/Codoc-os/django-opensearch-dsl/pull/87)).
+
+**BREAKING CHANGES**:
+
+* `django_opensearch_dsl.documents.Document.get_queryset` now take an optional `alias` argument to specify which
+  database connection to use.
+* `django_opensearch_dsl.documents.Document.get_indexing_queryset` now take an optional `alias` argument to specify
+  which database connection to use.
+
 ### 0.7.0 (2025-04-11)
 
 * `--refresh` and `--parallel` options of the CLI now default to the respective value of `OPENSEARCH_DSL_AUTO_REFRESH`

docs/document.md

@@ -139,11 +139,12 @@ class EventDocument(Document):
 
 ---
 
-* `def get_indexing_queryset(self, filter_=None, exclude=None, count=None, verbose=False, action=CommandAction.INDEX, stdout=sys.stdout)`
+* `def get_indexing_queryset(self, filter_=None, exclude=None, alias=None, count=None, verbose=False, action=CommandAction.INDEX, stdout=sys.stdout)`
 
     * `filter_` (`Optional[Q]`) - Given to `get_queryset()`.
     * `exclude` (`Optional[Q]`) - Given to `get_queryset()`.
     * `count` (`Optional[int]`) - Given to `get_queryset()`.
+    * `alias` (`Optional[str]`) - Given to `get_queryset()`.
     * `verbose` (`bool`) - If set to `True`, will display the progression of the action on standard output.
     * `action` (`CommandAction`) - Used by the verbose.
     * `stdout` (`io.FileIO`) - Standard output used when verbose is `True` (default to `stdout`).
@@ -165,9 +166,9 @@ class EventDocument(Document):
     class Django:
         model = Event
 
-    def get_indexing_queryset(self):
+    def get_indexing_queryset(self, filter_=None, exclude=None, alias=None, count=None, verbose=False, action=CommandAction.INDEX, stdout=sys.stdout):
         """Use iterator to chunk the queryset, discarding any verbose."""
-        qs = self.get_queryset()
+        qs = self.get_queryset(filter_=filter_, exclude=exclude, count=count).using(alias)
         return qs.iterator()
 ```
 

docs/management.md

@@ -60,9 +60,10 @@ positional arguments:
   INDEX                 Only manage the given indices.
 
 optional arguments:
-  -h, --help            show this help message and exit
-  --force               Do not ask for confirmation.
-  --ignore-error        Do not stop on error.
+  -h, --help                 show this help message and exit
+  -u USING, --using USING    Alias of the OpenSearch connection to use. Default to 'default'.
+  --force                    Do not ask for confirmation.
+  --ignore-error             Do not stop on error.
 ```
 
 ### Description
@@ -80,11 +81,15 @@ created/deleted. If no index is provided, the action is applied to all indices.
 Use the `--force` options to bypass the confirmation step, and use the `--ignore-error` option to not stop on error (such as
 trying to create an already created index).
 
+You can specify which Opensearch connection to use with the `--using` option.
+
 ## `list` Subcommand
 
 The `list` subcommand displays a summary of each index, indicated whether they are created or not, and the number of
 document indexed.
 
+You can specify which Opensearch connection to use with the `--using` option.
+
 Sample output :
 
 ```text
@@ -110,32 +115,33 @@ positional arguments:
   {index,delete,update}
                         Whether you want to create, delete or rebuild the indices.
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
-  -f [FILTERS [FILTERS ...]], --filters [FILTERS [FILTERS ...]]
-                        Filter object in the queryset. Argument must be formatted as 
-                        '[lookup]=[value]', e.g. 'document_date__gte=2020-05-21. The accepted
-                        value type are:
-                            - 'None' ('[lookup]=')
-                            - 'float' ('[lookup]=1.12')
-                            - 'int' ('[lookup]=23')
-                            - 'datetime.date' ('[lookup]=2020-10-08')
-                            - 'list' ('[lookup]=1,2,3,4') Value between comma ',' can be of any
-                              other accepted value type
-                            - 'str' ('[lookup]=week')
-                        Values that didn't match any type above will be interpreted as a str.
-                        The list of lookup function can be found here:
-                        https://docs.djangoproject.com/en/dev/ref/models/querysets/#field-lookups
-  -e [EXCLUDES [EXCLUDES ...]], --excludes [EXCLUDES [EXCLUDES ...]]
-                        Exclude objects from the queryset. Argument must be formatted as
-                        '[lookup]=[value]', see '--filters' for more information.
+  -u USING, --using USING
+                        Alias of the OpenSearch connection to use. Default to 'default'.
+  -d DATABASE, --database DATABASE
+                        Nominates a database.
+  -f [FILTERS ...], --filters [FILTERS ...]
+                        Filter object in the queryset. Argument must be formatted as '[lookup]=[value]', e.g. 'document_date__gte=2020-05-21.
+                        The accepted value type are:
+                          - 'None' ('[lookup]=')
+                          - 'float' ('[lookup]=1.12')
+                          - 'int' ('[lookup]=23')
+                          - 'datetime.date' ('[lookup]=2020-10-08')
+                          - 'list' ('[lookup]=1,2,3,4') Value between comma ',' can be of any other accepted value type
+                          - 'str' ('[lookup]=week') Value that didn't match any type above will be interpreted as a str
+                        The list of lookup function can be found here: https://docs.djangoproject.com/en/dev/ref/models/querysets/#field-lookups
+  -e [EXCLUDES ...], --excludes [EXCLUDES ...]
+                        Exclude objects from the queryset. Argument must be formatted as '[lookup]=[value]', see '--filters' for more information
   --force               Do not ask for confirmation.
-  -i [INDICES [INDICES ...]], --indices [INDICES [INDICES ...]]
+  -i [INDICES ...], --indices [INDICES ...]
                         Only update documents on the given indices.
   -c COUNT, --count COUNT
                         Update at most COUNT objects (0 to index everything).
-  -p, --parallel        Parallelize the communication with Opensearch.
-  -r, --refresh         Make operations performed on the indices immediately available for search.
+  -r, --refresh         Whether the operations performed on the indices are immediately available for search. Default to `OPENSEARCH_DSL_AUTO_REFRESH` (which default to `False`)
+  --no-refresh
+  -p, --parallel        Whether to run bulk operations in parallel. Default to `OPENSEARCH_DSL_PARALLEL` (which default to `False`)
+  --no-parallel
   -m, --missing         When used with 'index' action, only index documents not indexed yet.
 ```
 

setup.py

@@ -38,7 +38,7 @@
 
 setup(
     name='django-opensearch-dsl',
-    version='0.7.0',
+    version='0.8.0',
     description="""Wrapper around opensearch-py for django models""",
     long_description=LONG_DESCRIPTION,
     long_description_content_type='text/markdown',