omnata-plugin-runtime 0.10.0a225__tar.gz → 0.10.1__tar.gz

{omnata_plugin_runtime-0.10.0a225 → omnata_plugin_runtime-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: omnata-plugin-runtime
-Version: 0.10.0a225
+Version: 0.10.1
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.10.0a225 → omnata_plugin_runtime-0.10.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "omnata-plugin-runtime"
-version = "0.10.0-a225"
+version = "0.10.1"
 description = "Classes and common runtime components for building and running Omnata Plugins"
 authors = ["James Weakley <james.weakley@omnata.com>"]
 readme = "README.md"

{omnata_plugin_runtime-0.10.0a225 → omnata_plugin_runtime-0.10.1}/src/omnata_plugin_runtime/configuration.py

@@ -583,6 +583,30 @@ class NgrokTunnelSettings(SubscriptableBaseModel):
         description="The ngrok client key, in PEM format",
     )
 
+class OutboundRecordTransformationParameters(SubscriptableBaseModel):
+    """
+    Allows the plugin author to determine how records are transformed before being sent to the target app.
+    Since conversion to objects causes a loss of some data types (e.g. timestamps and dates become strings),
+    and different Snowflake accounts may have different timestamp output formats, specifying the format allows
+    for a consistent result in the transformed records.
+    """
+    timestamp_tz_format: str = Field(
+        default="YYYY-MM-DD HH24:MI:SS.FF3 TZHTZM",
+        title="The format to use when converting TIMESTAMP_TZ values to strings in the transformed record."
+    )
+    timestamp_ntz_format: str = Field(
+        default="YYYY-MM-DD HH24:MI:SS.FF3",
+        title="The format to use when converting TIMESTAMP_NTZ values to strings in the transformed record."
+    )
+    timestamp_ltz_format: str = Field(
+        default="YYYY-MM-DD HH24:MI:SS.FF3 TZHTZM",
+        title="The format to use when converting TIMESTAMP_LTZ values to strings in the transformed record."
+    )
+    date_format: str = Field(
+        default="YYYY-MM-DD",
+        title="YYYY-MM-DD"
+    )
+
 class ConnectionConfigurationParameters(SubscriptableBaseModel):
     """
     Contains user-provided information completed during connection configuration.

{omnata_plugin_runtime-0.10.0a225 → omnata_plugin_runtime-0.10.1}/src/omnata_plugin_runtime/omnata_plugin.py

@@ -77,6 +77,7 @@ from .configuration import (
     get_secrets,
     ConnectivityOption,
     OutboundTargetType,
+    OutboundRecordTransformationParameters
 )
 from .forms import (
     ConnectionMethod,
@@ -105,6 +106,12 @@ class PluginManifest(SubscriptableBaseModel):
         :param bool supports_inbound: A flag to indicate whether or not the plugin supports inbound sync. Support for inbound sync behaviours (full/incremental) is defined per inbound stream.
         :param List[OutboundSyncStrategy] supported_outbound_strategies: A list of sync strategies that the plugin can support, e.g. create,upsert.
         :param List[ConnectivityOption] supported_connectivity_options: A list of connectivity options that the plugin can support, e.g. direct,ngrok,privatelink
+        :param str timestamp_tz_format: The format to use when converting TIMESTAMP_TZ values to strings in the transformed record.
+        :param str timestamp_ntz_format: The format to use when converting TIMESTAMP_NTZ values to strings in the transformed record.
+        :param str timestamp_ltz_format: The format to use when converting TIMESTAMP_LTZ values to strings in the transformed record.
+        For each of the above three formats, you can include "{{precision}}" to substitute the precision of the timestamp, if that matters.
+        For example, "YYYY-MM-DDTHH24:MI:SS.FF{{precision}}TZHTZM" would be a valid format string.
+        :param str date_format: The format to use when converting DATE values to strings in the transformed record.
     """
 
     plugin_id: str
@@ -123,6 +130,10 @@ class PluginManifest(SubscriptableBaseModel):
         default=None,
         title="An optional list of target types that the plugin can support."
     )
+    outbound_target_transformation_parameters: OutboundRecordTransformationParameters = Field(
+        default_factory=lambda: OutboundRecordTransformationParameters(),
+        title="The parameters for transforming records for various Snowflake data types"
+    )
 
 class SnowflakeFunctionParameter(BaseModel):
     """