Merge pull request #153 from supabase/chore/helloworld-fdw-error

chore(helloworld_fdw): refactor error reporting
supabase · Sep 20, 2023 · b5c615c · b5c615c
2 parents 91c9d7f + 1099f5d
commit b5c615c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/supabase-wrappers/src/lib.rs b/supabase-wrappers/src/lib.rs
@@ -66,7 +66,7 @@
 //! use pgrx::PgSqlErrorCode;
 //! use supabase_wrappers::prelude::*;
 //! #[wrappers_fdw(
-//!    version = "0.1.0",
+//!    version = "0.1.1",
 //!    author = "Supabase",
 //!    website = "https://github.com/supabase/wrappers/tree/main/wrappers/src/fdw/helloworld_fdw",
 //!    error_type = "HelloWorldFdwError"
@@ -75,7 +75,7 @@
 //!     //row counter
 //!     row_cnt: i64,
 //!
-//!     // target column name list
+//!     // target column list
 //!     tgt_cols: Vec<Column>,
 //! }
 //!
@@ -87,8 +87,10 @@
 //!     }
 //! }
 //!
+//! type HelloWorldFdwResult<T> = Result<T, HelloWorldFdwError>;
+//!
 //! impl ForeignDataWrapper<HelloWorldFdwError> for HelloWorldFdw {
-//!     fn new(options: &HashMap<String, String>) -> Result<Self, HelloWorldFdwError> {
+//!     fn new(options: &HashMap<String, String>) -> HelloWorldFdwResult<Self> {
 //!         // 'options' is the key-value pairs defined in `CREATE SERVER` SQL, for example,
 //!         //
 //!         // create server my_helloworld_server
@@ -108,17 +110,17 @@
 //!         })
 //!     }
 //!
-//!     fn begin_scan(&mut self, quals: &[Qual], columns: &[Column], sorts: &[Sort], limit: &Option<Limit>, options: &HashMap<String, String>) -> Result<(), HelloWorldFdwError> {
+//!     fn begin_scan(&mut self, quals: &[Qual], columns: &[Column], sorts: &[Sort], limit: &Option<Limit>, options: &HashMap<String, String>) -> HelloWorldFdwResult<()> {
 //!         // Do any initilization
 //!         Ok(())
 //!     }
 //!
-//!     fn iter_scan(&mut self, row: &mut Row) -> Result<Option<()>, HelloWorldFdwError> {
+//!     fn iter_scan(&mut self, row: &mut Row) -> HelloWorldFdwResult<Option<()>> {
 //!         // Return None when done
 //!         Ok(None)
 //!     }
 //!
-//!     fn end_scan(&mut self) -> Result<(), HelloWorldFdwError> {
+//!     fn end_scan(&mut self) -> HelloWorldFdwResult<()> {
 //!         // Cleanup any resources
 //!         Ok(())
 //!     }

diff --git a/wrappers/src/fdw/helloworld_fdw/README.md b/wrappers/src/fdw/helloworld_fdw/README.md
@@ -62,4 +62,5 @@ wrappers=# select * from hello;
 
 | Version | Date       | Notes                                                |
 | ------- | ---------- | ---------------------------------------------------- |
+| 0.1.1   | 2023-09-20 | Error reporting refactoring                          |
 | 0.1.0   | 2022-11-30 | Initial version                                      |
diff --git a/wrappers/src/fdw/helloworld_fdw/helloworld_fdw.rs b/wrappers/src/fdw/helloworld_fdw/helloworld_fdw.rs
@@ -5,7 +5,7 @@ use supabase_wrappers::prelude::*;
 
 // A simple demo FDW
 #[wrappers_fdw(
-    version = "0.1.0",
+    version = "0.1.1",
     author = "Supabase",
     website = "https://github.com/supabase/wrappers/tree/main/wrappers/src/fdw/helloworld_fdw",
     error_type = "HelloWorldFdwError"
@@ -14,7 +14,7 @@ pub(crate) struct HelloWorldFdw {
     // row counter
     row_cnt: i64,
 
-    // target column name list
+    // target column list
     tgt_cols: Vec<Column>,
 }
 
@@ -26,6 +26,8 @@ impl From<HelloWorldFdwError> for ErrorReport {
     }
 }
 
+type HelloWorldFdwResult<T> = Result<T, HelloWorldFdwError>;
+
 impl ForeignDataWrapper<HelloWorldFdwError> for HelloWorldFdw {
     // 'options' is the key-value pairs defined in `CREATE SERVER` SQL, for example,
     //
@@ -40,7 +42,7 @@ impl ForeignDataWrapper<HelloWorldFdwError> for HelloWorldFdw {
     // You can do any initalization in this new() function, like saving connection
     // info or API url in an variable, but don't do any heavy works like making a
     // database connection or API call.
-    fn new(_options: &HashMap<String, String>) -> Result<Self, HelloWorldFdwError> {
+    fn new(_options: &HashMap<String, String>) -> HelloWorldFdwResult<Self> {
         Ok(Self {
             row_cnt: 0,
             tgt_cols: Vec::new(),
@@ -54,7 +56,7 @@ impl ForeignDataWrapper<HelloWorldFdwError> for HelloWorldFdw {
         _sorts: &[Sort],
         _limit: &Option<Limit>,
         _options: &HashMap<String, String>,
-    ) -> Result<(), HelloWorldFdwError> {
+    ) -> HelloWorldFdwResult<()> {
         // reset row counter
         self.row_cnt = 0;
 
@@ -64,7 +66,7 @@ impl ForeignDataWrapper<HelloWorldFdwError> for HelloWorldFdw {
         Ok(())
     }
 
-    fn iter_scan(&mut self, row: &mut Row) -> Result<Option<()>, HelloWorldFdwError> {
+    fn iter_scan(&mut self, row: &mut Row) -> HelloWorldFdwResult<Option<()>> {
         // this is called on each row and we only return one row here
         if self.row_cnt < 1 {
             // add values to row if they are in target column list
@@ -86,7 +88,7 @@ impl ForeignDataWrapper<HelloWorldFdwError> for HelloWorldFdw {
         Ok(None)
     }
 
-    fn end_scan(&mut self) -> Result<(), HelloWorldFdwError> {
+    fn end_scan(&mut self) -> HelloWorldFdwResult<()> {
         // we do nothing here, but you can do things like resource cleanup and etc.
         Ok(())
     }