get bulk by vol

Author: EugeneSukharev1988

montycat/store_classes/kv.py

@@ -205,7 +205,8 @@ async def delete_bulk(cls, bulk_keys: list = [], bulk_custom_keys: list = []):
         return await cls._run_query(query)
 
     @classmethod
-    async def get_bulk(cls, bulk_keys: list = [], bulk_custom_keys: list = [], limit: list = [], with_pointers: bool = False, key_included: bool = False, pointers_metadata: bool = False):
+    async def get_bulk(
+        cls, bulk_keys: list = [], bulk_custom_keys: list = [], limit: list = [], with_pointers: bool = False, key_included: bool = False, pointers_metadata: bool = False, volumes: list[str] = [], latest_volume: bool = False):
         """
         Retrieve multiple keys in bulk. Custom keys can be converted and added to the bulk retrieval list.
         Additionally, a limit on the number of records to retrieve can be applied, and whether to include pointers
@@ -220,13 +221,19 @@ async def get_bulk(cls, bulk_keys: list = [], bulk_custom_keys: list = [], limit
                                      no limit is applied.
             with_pointers (bool, optional): If True, the query will include pointer information with the results.
                                             Default is False.
+            key_included (bool, optional): If True, the query will include the keys in the results.
+                                           Default is False.
+            pointers_metadata (bool, optional): If True, the query will include metadata about pointers in the results.
+                                                Default is False.
+            volumes (list[str], optional): A list of volumes to retrieve. Default is an empty list.
+            latest_volume (bool, optional): If True, the query will retrieve the latest volume. Default is False.
 
         Returns:
             dict | str: Returns a dictionary of keys and their associated values if successful, or a string
                         message if the retrieval fails or there is an error.
 
         Raises:
-            ValueError: If both `bulk_keys` and `bulk_custom_keys` are empty.
+            ValueError: If both `bulk_keys` and `bulk_custom_keys` are empty and neither `volumes` nor `latest_volume` is specified.
             ValueError: If both `pointers_metadata` and `with_pointers` are True.
         """
 
@@ -237,12 +244,18 @@ async def get_bulk(cls, bulk_keys: list = [], bulk_custom_keys: list = [], limit
             bulk_custom_keys = convert_custom_keys(bulk_custom_keys)
             bulk_keys += bulk_custom_keys
 
-        if not bulk_keys:
-            raise ValueError("No keys provided for retrieval.")
+        selected_options = sum([
+            bool(bulk_keys),
+            bool(volumes),
+            bool(latest_volume)
+        ])
+
+        if selected_options != 1:
+            raise ValueError("Multiple conflicting options provided. Please provide exactly one of the following: keys, volumes, or latest volume.")
 
         cls.command = "get_bulk"
         cls.limit_output = handle_limit(limit)
-        query = convert_to_binary_query(cls, bulk_keys=bulk_keys, with_pointers=with_pointers, key_included=key_included, pointers_metadata=pointers_metadata)
+        query = convert_to_binary_query(cls, bulk_keys=bulk_keys, with_pointers=with_pointers, key_included=key_included, pointers_metadata=pointers_metadata, volumes=volumes, latest_volume=latest_volume)
         return await cls._run_query(query)
 
     @classmethod

montycat/store_classes/persistent.py

@@ -99,10 +99,10 @@ async def update_value(cls, key: Union[str, None] = None, custom_key: Union[str,
         it will be converted to the appropriate format before updating.
 
         Args:
-            key (int | str, optional): The key whose associated value needs to be updated. 
+            key (int | str, optional): The key whose associated value needs to be updated.
                                        This can either be an integer or a string. Default is an empty string,
                                        which will be ignored if custom_key is provided.
-            custom_key (str, optional): The custom key whose associated value needs to be updated. 
+            custom_key (str, optional): The custom key whose associated value needs to be updated.
                                         Default is an empty string.
             filters (dict): A dictionary of field-value pairs that need to be updated in the store.
 
@@ -142,11 +142,13 @@ async def insert_bulk(cls, bulk_values: list):
         return await cls._run_query(query)
 
     @classmethod
-    async def get_keys(cls, limit: Union[list, int] = [], volumes: list = [], latest_volume: bool = False):
+    async def get_keys(cls, limit: Union[list, int] = [], volumes: list[str] = [], latest_volume: bool = False):
         """
         Args:
             Limit: A list of two integers that determine the range of keys to retrieve.
             Example: limit = [10, 20] will retrieve keys 10 to 20.
+            volumes (list[str], optional): A list of volumes to retrieve. Default is an empty list.
+            latest_volume (bool, optional): Whether to retrieve keys from the latest volume. Default is False.
         Returns:
             A list of keys in the store. Class 'str' if the get operation failed.
         """
@@ -162,7 +164,14 @@ async def get_keys(cls, limit: Union[list, int] = [], volumes: list = [], latest
 
     @classmethod
     async def create_keyspace(cls):
-
+        """
+        Creates a new keyspace in the store with the specified settings for persistence, distribution, caching, and
+        compression.
+        Returns:
+            bool: True if the keyspace was created successfully, False otherwise.
+        Raises:
+            ValueError: If the keyspace is not set to be persistent.
+        """
         query = orjson.dumps({
             "raw": [
                 "create-keyspace",