exabel-data-sdk 4.5.0 (#150)

* Add KPI mappings to library search
* Expose --abort-threshold on CLI
* Add page-size argument to list_relationships script
* Don't convert iterator to list
* Support --replace-existing-time-series in time series import
* Upgrade gRPC libraries

Author: oyvindwe

Pipfile.lock

@@ -1 +1 @@
-4.4.0
+4.5.0

VERSION

@@ -28,10 +28,12 @@ class FolderItemType(Enum):
     TAG = ProtoFolderItemType.TAG
     # Screen.
     SCREEN = ProtoFolderItemType.SCREEN
-    # Financial Model
+    # Financial Model.
     FINANCIAL_MODEL = ProtoFolderItemType.FINANCIAL_MODEL
-    # Chart
+    # Chart.
     CHART = ProtoFolderItemType.CHART
+    # KPI mapping.
+    KPI_MAPPING = ProtoFolderItemType.KPI_MAPPING
 
 
 class FolderItem:

exabel_data_sdk/client/api/data_classes/folder_item.py

@@ -284,6 +284,7 @@ def import_time_series(
         allow_missing: bool = False,
         create_tag: bool = False,
         status_in_response: bool = False,
+        replace_existing_time_series: bool = False,
     ) -> Optional[Sequence[ResourceCreationResult]]:
         """
         Import multiple time series.
@@ -309,6 +310,13 @@ def import_time_series(
                             ResourceCreationResult.
                             If set to false, a failure for one time series will fail the entire
                             request, and a sample of the failures will be reported in the exception.
+            replace_existing_time_series:
+                            Set to true to first delete all data from existing time series. This
+                            means that all historical and point-in-time data for the time series
+                            will be destroyed and replaced with the data in this call.
+                            Use with care! For instance: If this flag is set, and an import job
+                            splits one time series over multiple calls, only the data in the last
+                            call will be kept.
         Returns:
             If status_in_response is set to true, a list of ResourceCreationResult will be returned.
             Otherwise, None is returned.
@@ -324,6 +332,7 @@ def import_time_series(
                 allow_missing=allow_missing,
                 create_tag=create_tag,
                 status_in_response=status_in_response,
+                replace_existing_time_series=replace_existing_time_series,
             ),
         )
 
@@ -424,6 +433,7 @@ def bulk_upsert_time_series(
         create_tag: bool = False,
         threads: int = DEFAULT_NUMBER_OF_THREADS_FOR_IMPORT,
         default_known_time: Optional[DefaultKnownTime] = None,
+        replace_existing_time_series: bool = False,
         retries: int = DEFAULT_NUMBER_OF_RETRIES,
         abort_threshold: Optional[float] = 0.5,
         # Deprecated arguments
@@ -450,6 +460,13 @@ def bulk_upsert_time_series(
                             the Known Time for data points where a specific known time timestamp
                             has not been given. If not provided, the Exabel API defaults to the
                             current time (upload time) as the Known Time.
+            replace_existing_time_series:
+                            Set to true to first delete all data from existing time series. This
+                            means that all historical and point-in-time data for the time series
+                            will be destroyed and replaced with the data in this call.
+                            Use with care! For instance: If this flag is set, and an import job
+                            splits one time series over multiple calls, only the data in the last
+                            call will be kept.
             retries:        Maximum number of retries to make for each failed request.
             abort_threshold:
                             The threshold for the proportion of failed requests that will cause the
@@ -467,6 +484,7 @@ def import_func(ts_sequence: Sequence[pd.Series]) -> Sequence[ResourceCreationRe
                 allow_missing=True,
                 create_tag=create_tag,
                 status_in_response=True,
+                replace_existing_time_series=replace_existing_time_series,
             )
             assert result is not None
             return result

exabel_data_sdk/client/api/time_series_api.py

@@ -35,6 +35,14 @@ def __init__(self, argv: Sequence[str], description: str):
             type=str,
             help="The resource name of the entity the relationships go to",
         )
+        self.parser.add_argument(
+            "--page-size",
+            required=False,
+            type=int,
+            default=1000,
+            help="The page size to use for retrieving all relationships"
+            " (not applicable when specifying an entity)",
+        )
 
     def run_script(self, client: ExabelClient, args: argparse.Namespace) -> None:
         if args.from_entity and args.to_entity:
@@ -49,20 +57,16 @@ def run_script(self, client: ExabelClient, args: argparse.Namespace) -> None:
                 return
         relationship_type = args.relationship_type
         if args.from_entity is not None:
-            all_relationships = list(
-                client.relationship_api.get_relationships_from_entity_iterator(
-                    relationship_type, entity
-                )
+            all_relationships = client.relationship_api.get_relationships_from_entity_iterator(
+                relationship_type, entity
             )
         elif args.to_entity is not None:
-            all_relationships = list(
-                client.relationship_api.get_relationships_to_entity_iterator(
-                    relationship_type, entity
-                )
+            all_relationships = client.relationship_api.get_relationships_to_entity_iterator(
+                relationship_type, entity
             )
         else:
-            all_relationships = list(
-                client.relationship_api.get_relationships_iterator(relationship_type)
+            all_relationships = client.relationship_api.get_relationships_iterator(
+                relationship_type, page_size=args.page_size
             )
 
         if not all_relationships:

exabel_data_sdk/scripts/list_relationships.py

@@ -129,6 +129,13 @@ def __init__(self, argv: Sequence[str]):
             "'known_time'. Take care to maintain correct casing in the file when using this "
             "option.",
         )
+        self.parser.add_argument(
+            "--replace-existing-time-series",
+            required=False,
+            action="store_true",
+            default=False,
+            help="Replace any existing time series when importing",
+        )
 
     def run_script(self, client: ExabelClient, args: argparse.Namespace) -> None:
         try:
@@ -150,6 +157,7 @@ def run_script(self, client: ExabelClient, args: argparse.Namespace) -> None:
                 skip_validation=args.skip_validation,
                 case_sensitive_signals=args.case_sensitive_signals,
                 abort_threshold=args.abort_threshold,
+                replace_existing_time_series=args.replace_existing_time_series,
             )
         except FileLoadingException as e:
             print(e)