From b672b54d37019331b753881424488c39765eead4 Mon Sep 17 00:00:00 2001
From: Benson <benson@ganymede.bio>
Date: Sun, 1 Dec 2024 10:25:21 -0500
Subject: [PATCH] move ganymedeexception to sdk (#430)

* move ganymedeexception to sdk

* upd
---
 .wordlist.txt               |  5 ++++-
 docs/app/flows/FlowView.mdx |  8 ++------
 docs/sdk/DataValidation.mdx | 19 ++++++++++++++++++-
 3 files changed, 24 insertions(+), 8 deletions(-)

diff --git a/.wordlist.txt b/.wordlist.txt
index c24de2de..1709850e 100644
--- a/.wordlist.txt
+++ b/.wordlist.txt
@@ -398,4 +398,7 @@ AKTA
 Cytiva
 searchability
 SuggestedTags
-Palantir
\ No newline at end of file
+Palantir
+GanymedeException
+FlowView
+useBaseURL
\ No newline at end of file
diff --git a/docs/app/flows/FlowView.mdx b/docs/app/flows/FlowView.mdx
index 0d7f184b..9c949a23 100644
--- a/docs/app/flows/FlowView.mdx
+++ b/docs/app/flows/FlowView.mdx
@@ -119,7 +119,7 @@ Logs for each flow step can be accessed by clicking on the corresponding colored
 
 ### Error Attribution
 
-Developers using the platform can specify error types and messages associated with failed nodes. These are displayed on the status tag in the Run History table. Below is an example code snippet that would be placed within a node to raise an error:
+Developers using the platform can specify error types and messages associated with failed nodes using the GanymedeException class. These are displayed on the status tag in the Run History table. Below is an example code snippet that would be placed within a node to raise an error:
 
 ```python
 from ganymede_sdk.flow_runtime import GanymedeException
@@ -128,8 +128,4 @@ from ganymede_sdk.flow_runtime import GanymedeException
 raise GanymedeException(message=”Peaks not detected in results”, exception_type=”Function”)
 ```
 
-#### Categories of Errors
-
-- **Validation**: Schema validation errors. An example use case would be a Pandas DataFrame failing to validate against a Pandera schema.
-- **Connection**: Errors related to connecting to external services. Check for errors related to authentication, service availability, and access methods.
-- **Function**: Errors related to function logic. For example, a failed function call to a Python package would fall under this category.
+More detail on error types can be found in the [GanymedeException section of the Ganymede SDK documentation](../../sdk/DataValidation#class-ganymedeexception).
diff --git a/docs/sdk/DataValidation.mdx b/docs/sdk/DataValidation.mdx
index e7061d54..481f6779 100644
--- a/docs/sdk/DataValidation.mdx
+++ b/docs/sdk/DataValidation.mdx
@@ -100,12 +100,29 @@ query_sql = 'SELECT * FROM tbl WHERE flow_run_id = "{{flow_run_id}}";'
 result = g.retrieve_sql(query_sql)
 ```
 
+## `class` GanymedeException
+
+The **GanymedeException** class is a custom exception class that can be used to raise exceptions to attribute error type.
+
+```python
+from ganymede_sdk.flow_runtime import GanymedeException
+
+# available exception types are: Validation, Connection, Function
+raise GanymedeException('Only 1 replicate detected in sample; expected 3.', exception_type="Validation")
+```
+
+### Error Types
+
+- **Validation**: Schema validation errors. An example use case would be a Pandas DataFrame failing to validate against a Pandera schema.
+- **Connection**: Errors related to connecting to external services. Check for errors related to authentication, service availability, and access methods.
+- **Function**: Errors related to function logic. For example, a failed function call to a Python package would fall under this category.
+
 ## `function` compare_df_to_table
 
 *compare_df_to_table* allows users to compare the columns and schema on a Pandas DataFrame to a corresponding table in the Ganymede database.
 The function returns differences in column names and data types between the DataFrame and the table, and can be used to validate that the DataFrame matches the table schema before writing the DataFrame to the table.
 
-###  Parameters
+### Parameters
 - **ganymede_context** : `GanymedeContext`
     - Ganymede context to get run attributes
 - **df** : `pd.DataFrame`