feldera 0.101.0__py3-none-any.whl → 0.102.0__py3-none-any.whl

feldera/enums.py

@@ -276,3 +276,38 @@ class StorageStatus(Enum):
 
     def __eq__(self, other):
         return self.value == other.value
+
+
+class FaultToleranceModel(Enum):
+    """
+    The fault tolerance model.
+    """
+
+    AtLeastOnce = 1
+    """
+    Each record is output at least once.  Crashes may duplicate output, but
+    no input or output is dropped.
+    """
+
+    ExactlyOnce = 2
+    """
+    Each record is output exactly once.  Crashes do not drop or duplicate
+    input or output.
+    """
+
+    def __str__(self) -> str:
+        match self:
+            case FaultToleranceModel.AtLeastOnce:
+                return "at_least_once"
+            case FaultToleranceModel.ExactlyOnce:
+                return "exactly_once"
+
+    @staticmethod
+    def from_str(value):
+        for member in FaultToleranceModel:
+            if str(member) == value.lower():
+                return member
+
+        raise ValueError(
+            f"Unknown value '{value}' for enum {FaultToleranceModel.__name__}"
+        )

feldera/pipeline.py

@@ -145,7 +145,7 @@ class Pipeline:
         :param data: The JSON encoded data to be pushed to the pipeline. The data should be in the form:
             `{'col1': 'val1', 'col2': 'val2'}` or `[{'col1': 'val1', 'col2': 'val2'}, {'col1': 'val1', 'col2': 'val2'}]`
         :param update_format: The update format of the JSON data to be pushed to the pipeline. Must be one of:
-            "raw", "insert_delete". <https://docs.feldera.com/formats/json#the-insertdelete-format>
+            "raw", "insert_delete". https://docs.feldera.com/formats/json#the-insertdelete-format
         :param force: `True` to push data even if the pipeline is paused. `False` by default.
 
         :raises ValueError: If the update format is invalid.
@@ -180,7 +180,7 @@ class Pipeline:
         All connectors are RUNNING by default.
 
         Refer to the connector documentation for more information:
-        <https://docs.feldera.com/connectors/#input-connector-orchestration>
+            https://docs.feldera.com/connectors/#input-connector-orchestration
 
         :param table_name: The name of the table that the connector is attached to.
         :param connector_name: The name of the connector to pause.
@@ -199,7 +199,7 @@ class Pipeline:
         All connectors are RUNNING by default.
 
         Refer to the connector documentation for more information:
-        <https://docs.feldera.com/connectors/#input-connector-orchestration>
+            https://docs.feldera.com/connectors/#input-connector-orchestration
 
         :param table_name: The name of the table that the connector is attached to.
         :param connector_name: The name of the connector to resume.
@@ -533,15 +533,13 @@ metrics"""
 
     def checkpoint(self, wait: bool = False, timeout_s=300) -> int:
         """
-        Checkpoints this pipeline, if fault-tolerance is enabled.
-        Fault Tolerance in Feldera:
-        <https://docs.feldera.com/pipelines/fault-tolerance/>
+        Checkpoints this pipeline.
 
         :param wait: If true, will block until the checkpoint completes.
         :param timeout_s: The maximum time (in seconds) to wait for the
             checkpoint to complete.
 
-        :raises FelderaAPIError: If checkpointing is not enabled.
+        :raises FelderaAPIError: If enterprise features are not enabled.
         """
 
         seq = self.client.checkpoint_pipeline(self.name)

feldera/pipeline_builder.py

@@ -10,14 +10,16 @@ class PipelineBuilder:
     """
     A builder for creating a Feldera Pipeline.
 
-    :param client: The `.FelderaClient` instance
+    :param client: The :class:`.FelderaClient` instance
     :param name: The name of the pipeline
     :param description: The description of the pipeline
     :param sql: The SQL code of the pipeline
     :param udf_rust: Rust code for UDFs
     :param udf_toml: Rust dependencies required by UDFs (in the TOML format)
-    :param compilation_profile: The compilation profile to use
-    :param runtime_config: The runtime config to use
+    :param compilation_profile: The :class:`.CompilationProfile` to use
+    :param runtime_config: The :class:`.RuntimeConfig` to use. Enables
+        configuring the runtime behavior of the pipeline such as:
+        fault tolerance, storage and :class:`.Resources`
     """
 
     def __init__(

feldera/rest/feldera_client.py

@@ -404,7 +404,7 @@ Reason: The pipeline is in a STOPPED state due to the following error:
 
     def checkpoint_pipeline(self, pipeline_name: str) -> int:
         """
-        Checkpoint a fault-tolerant pipeline
+        Checkpoint a pipeline.
 
         :param pipeline_name: The name of the pipeline to checkpoint
         """

feldera/runtime_config.py

@@ -1,5 +1,6 @@
 import os
 from typing import Optional, Any, Mapping
+from feldera.enums import FaultToleranceModel
 
 
 class Resources:
@@ -59,6 +60,11 @@ class Storage:
 class RuntimeConfig:
     """
     Runtime configuration class to define the configuration for a pipeline.
+    To create runtime config from a dictionary, use
+    :meth:`.RuntimeConfig.from_dict`.
+
+    Documentation:
+        https://docs.feldera.com/pipelines/configuration/#runtime-configuration
     """
 
     def __init__(
@@ -74,6 +80,8 @@ class RuntimeConfig:
         provisioning_timeout_secs: Optional[int] = None,
         resources: Optional[Resources] = None,
         runtime_version: Optional[str] = None,
+        fault_tolerance_model: Optional[FaultToleranceModel] = None,
+        checkpoint_interval_secs: Optional[int] = None,
     ):
         self.workers = workers
         self.tracing = tracing
@@ -86,6 +94,11 @@ class RuntimeConfig:
         self.runtime_version = runtime_version or os.environ.get(
             "FELDERA_RUNTIME_VERSION"
         )
+        if fault_tolerance_model is not None:
+            self.fault_tolerance = {
+                "model": str(fault_tolerance_model),
+                "checkpoint_interval_secs": checkpoint_interval_secs,
+            }
         if resources is not None:
             self.resources = resources.__dict__
         if isinstance(storage, bool):
@@ -100,7 +113,7 @@ class RuntimeConfig:
     @classmethod
     def from_dict(cls, d: Mapping[str, Any]):
         """
-        Create a `.RuntimeConfig` object from a dictionary.
+        Create a :class:`.RuntimeConfig` object from a dictionary.
         """
 
         conf = cls()

{feldera-0.101.0.dist-info → feldera-0.102.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: feldera
-Version: 0.101.0
+Version: 0.102.0
 Summary: The feldera python client
 Author-email: Feldera Team <dev@feldera.com>
 License: MIT

{feldera-0.101.0.dist-info → feldera-0.102.0.dist-info}/RECORD

@@ -1,23 +1,23 @@
 feldera/__init__.py,sha256=EiY3bTj_mnfNhCGrZo6J__brfovIJ-YYAdy77PyaEoo,378
 feldera/_callback_runner.py,sha256=GNOg3TrKJg9zJU0HvpWxCHqzjMUX8ORiHhtiEEdVQzE,4758
 feldera/_helpers.py,sha256=rN0WuGSCCQlXWFMimZUQrgs-LJAfUo074d79sLElncQ,3023
-feldera/enums.py,sha256=AWx7wldY2vBbrJMAwFabGQ8C_ZTKZreiqRvuGlrC9Ks,8702
+feldera/enums.py,sha256=MTHBojVANsdRnjbrzCyIOniDIUaH8nTYRfxB7QvajEE,9570
 feldera/output_handler.py,sha256=64J3ljhOaKIhxdjOKYi-BUz_HnMwROfmN8eE-btYygU,1930
-feldera/pipeline.py,sha256=Wc9yfnEXkVQ_WQSYuENisN6VSzANVJbsSuQGt1K0E_k,34407
-feldera/pipeline_builder.py,sha256=rImmAkYgpCGxZyH317mUMvChLuGF0rH8gvEOVcTYN4M,3924
-feldera/runtime_config.py,sha256=jeVuv2B6H0IDSmkyQgsuSOv1B656jvJIL9re4Sv4Rjw,3781
+feldera/pipeline.py,sha256=edNcJ28PnVPabCALSwg_30-IVrCR42zqPj8QPJn0JZI,34287
+feldera/pipeline_builder.py,sha256=pK8t93PIyM3zHzVTNg2jAafI7g2ZThNQyZER-_6e3G0,4081
+feldera/runtime_config.py,sha256=rPO1abLSJmozR4z1QwI93kt1rZMkFq-CBdqqmpKCSMU,4369
 feldera/stats.py,sha256=XBhkRsV7FXErwWuPP0i3q9W77mzkMo-oThPVEZy5y3U,5028
 feldera/rest/__init__.py,sha256=Eg-EKUU3RSTDcdxTR_7wNDnCly8VpXEzsZCQUmf-y2M,308
 feldera/rest/_helpers.py,sha256=q7jWInKp9IiIli8N5o31lDG3hNUbcsJqufZXYHG04ps,222
 feldera/rest/_httprequests.py,sha256=e22YbpzOzy7MGo7hk9MOU7ZRTj3F314grY0Ygr-_goI,6636
 feldera/rest/config.py,sha256=DYzZKngDEhouTEwqVFd-rDrBN9tWqsU07Jl_BTT4mXs,1008
 feldera/rest/errors.py,sha256=b4i2JjrbSmej7jdko_FL8UeXklLKenSipwMT80jowaM,1720
-feldera/rest/feldera_client.py,sha256=E0_cqpIaavVeapBLc5egZIl5KVsKWliDzWqXk6_r0nY,25289
+feldera/rest/feldera_client.py,sha256=Aic8PvBMG_aP_7d1qKx2C3RZ44rwLXN-OjvtV-a_dE8,25275
 feldera/rest/feldera_config.py,sha256=1pnGbLFMSLvp7Qh_OlPLALSKCSHIktNWKvx6gYU00U4,1374
 feldera/rest/pipeline.py,sha256=-dGGUdtHMABKrQEclaeuwGI_FOCrQOk6p2aCFV0FdU8,2890
 feldera/rest/sql_table.py,sha256=qrw-YwMzx5T81zDefNO1KOx7EyypFz1vPwGBzSUB7kc,652
 feldera/rest/sql_view.py,sha256=hN12mPM0mvwLCIPYywpb12s9Hd2Ws31IlTMXPriMisw,644
-feldera-0.101.0.dist-info/METADATA,sha256=6H0v0BPG56ovszTNICNFycsdWM26sDt3Mdsyp4dQ3_4,4101
-feldera-0.101.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-feldera-0.101.0.dist-info/top_level.txt,sha256=fB6yTqrQiO6RCbY1xP2T_mpPoTjDFtJvkJJodiee7d0,8
-feldera-0.101.0.dist-info/RECORD,,
+feldera-0.102.0.dist-info/METADATA,sha256=vxgcnxIFUUAaG8yPqmTgXG2_vGXSudRPwuUwrVDh3PQ,4101
+feldera-0.102.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+feldera-0.102.0.dist-info/top_level.txt,sha256=fB6yTqrQiO6RCbY1xP2T_mpPoTjDFtJvkJJodiee7d0,8
+feldera-0.102.0.dist-info/RECORD,,