feat(rdb): add skip_size_retrieval option to ListDatabases endpoint (#1291)

Author: scaleway-bot

scaleway-async/scaleway_async/rdb/v1/api.py

@@ -2450,6 +2450,7 @@ async def list_databases(
         self,
         *,
         instance_id: str,
+        skip_size_retrieval: bool,
         region: Optional[ScwRegion] = None,
         name: Optional[str] = None,
         managed: Optional[bool] = None,
@@ -2462,6 +2463,7 @@ async def list_databases(
         List databases in a Database Instance.
         List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
         :param instance_id: UUID of the Database Instance to list the databases of.
+        :param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the database.
         :param managed: Defines whether or not the database is managed.
@@ -2476,6 +2478,7 @@ async def list_databases(
 
             result = await api.list_databases(
                 instance_id="example",
+                skip_size_retrieval=False,
             )
         """
 
@@ -2494,6 +2497,7 @@ async def list_databases(
                 "owner": owner,
                 "page": page,
                 "page_size": page_size or self.client.default_page_size,
+                "skip_size_retrieval": skip_size_retrieval,
             },
         )
 
@@ -2504,6 +2508,7 @@ async def list_databases_all(
         self,
         *,
         instance_id: str,
+        skip_size_retrieval: bool,
         region: Optional[ScwRegion] = None,
         name: Optional[str] = None,
         managed: Optional[bool] = None,
@@ -2516,6 +2521,7 @@ async def list_databases_all(
         List databases in a Database Instance.
         List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
         :param instance_id: UUID of the Database Instance to list the databases of.
+        :param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the database.
         :param managed: Defines whether or not the database is managed.
@@ -2530,6 +2536,7 @@ async def list_databases_all(
 
             result = await api.list_databases_all(
                 instance_id="example",
+                skip_size_retrieval=False,
             )
         """
 
@@ -2539,6 +2546,7 @@ async def list_databases_all(
             fetcher=self.list_databases,
             args={
                 "instance_id": instance_id,
+                "skip_size_retrieval": skip_size_retrieval,
                 "region": region,
                 "name": name,
                 "managed": managed,

scaleway-async/scaleway_async/rdb/v1/types.py

@@ -798,7 +798,7 @@ class Database:
 
     size: int
     """
-    Size of the database.
+    Size of the database. Set to 0 if the size retrieval is too time-consuming or `skip_size_retrieval` is set to true.
     """
 
 
@@ -1883,6 +1883,11 @@ class ListDatabasesRequest:
     UUID of the Database Instance to list the databases of.
     """
 
+    skip_size_retrieval: bool
+    """
+    Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
+    """
+
     region: Optional[ScwRegion] = None
     """
     Region to target. If none is passed will use default region from the config.

scaleway/scaleway/rdb/v1/api.py

@@ -2442,6 +2442,7 @@ def list_databases(
         self,
         *,
         instance_id: str,
+        skip_size_retrieval: bool,
         region: Optional[ScwRegion] = None,
         name: Optional[str] = None,
         managed: Optional[bool] = None,
@@ -2454,6 +2455,7 @@ def list_databases(
         List databases in a Database Instance.
         List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
         :param instance_id: UUID of the Database Instance to list the databases of.
+        :param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the database.
         :param managed: Defines whether or not the database is managed.
@@ -2468,6 +2470,7 @@ def list_databases(
 
             result = api.list_databases(
                 instance_id="example",
+                skip_size_retrieval=False,
             )
         """
 
@@ -2486,6 +2489,7 @@ def list_databases(
                 "owner": owner,
                 "page": page,
                 "page_size": page_size or self.client.default_page_size,
+                "skip_size_retrieval": skip_size_retrieval,
             },
         )
 
@@ -2496,6 +2500,7 @@ def list_databases_all(
         self,
         *,
         instance_id: str,
+        skip_size_retrieval: bool,
         region: Optional[ScwRegion] = None,
         name: Optional[str] = None,
         managed: Optional[bool] = None,
@@ -2508,6 +2513,7 @@ def list_databases_all(
         List databases in a Database Instance.
         List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`.
         :param instance_id: UUID of the Database Instance to list the databases of.
+        :param skip_size_retrieval: Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
         :param region: Region to target. If none is passed will use default region from the config.
         :param name: Name of the database.
         :param managed: Defines whether or not the database is managed.
@@ -2522,6 +2528,7 @@ def list_databases_all(
 
             result = api.list_databases_all(
                 instance_id="example",
+                skip_size_retrieval=False,
             )
         """
 
@@ -2531,6 +2538,7 @@ def list_databases_all(
             fetcher=self.list_databases,
             args={
                 "instance_id": instance_id,
+                "skip_size_retrieval": skip_size_retrieval,
                 "region": region,
                 "name": name,
                 "managed": managed,

scaleway/scaleway/rdb/v1/types.py

@@ -798,7 +798,7 @@ class Database:
 
     size: int
     """
-    Size of the database.
+    Size of the database. Set to 0 if the size retrieval is too time-consuming or `skip_size_retrieval` is set to true.
     """
 
 
@@ -1883,6 +1883,11 @@ class ListDatabasesRequest:
     UUID of the Database Instance to list the databases of.
     """
 
+    skip_size_retrieval: bool
+    """
+    Whether to skip the retrieval of each database size. If true, the size of each returned database will be set to 0.
+    """
+
     region: Optional[ScwRegion] = None
     """
     Region to target. If none is passed will use default region from the config.