ductr-postgres 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b4bcb117297ac764d6502a16c53b8d19628b112c22cbe617e8e5caf2a8f173d
-  data.tar.gz: ebf1858ea1d46b63b10db3dfc8246c98e8dcff86fb776193e8062927a37a463b
+  metadata.gz: 6520956f9b414c8d7d5160d2372a918d3049eb6e2e77253ca452508873d2be53
+  data.tar.gz: ea1a31f688bac96edb6086979cb8971801d4627aee0f388ca446e7eba8146382
 SHA512:
-  metadata.gz: 6b73627f397c2407fae4295204ca5d5a1de413ad06249cb812593f1a4ca796dae5a6563764c815d2e63d99f6b2740236836205d5780e461abd2db2d19b1ac650
-  data.tar.gz: 8a2587f3ed3db58bafc84e9b0a3b26b569068d18a7048e945024d93a4544cf6e57ed23a963618cf6efa22abb0521ffaab9aeb0e5ff37af79c7ba929bcb18ac4a
+  metadata.gz: a266df884d476d6959462c84163db5b4845b2b2f6bb410f0b787a9c87c22fb4312c3d281a646adc3c6a806710d3b95869da037992a1a33224742ece1a7a7ea57
+  data.tar.gz: b378256691dec18c7bf1cf037f616e75335bbb1bbe0eb99d9e08cd180974b5fd85f508472078142eb0a3967e56d39e20923bd8b2bd45428657cdc8c07acc562c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ductr-postgres (0.2.1)
+    ductr-postgres (0.2.2)
       ductr (>= 0.2)
       pg (~> 1.5)
       sequel (~> 5.91)

data/lib/ductr/postgres/adapter.rb

@@ -31,12 +31,7 @@ module Ductr
       # @return [Sequel::Database] The database connection instance
       #
       def open!
-        @db = Sequel.postgres(**config)
-
-        @db.extension(:pg_streaming)
-        @db.stream_all_queries = true
-
-        @db
+        @db = new_connection
       end
 
       #
@@ -47,6 +42,20 @@ module Ductr
       def close!
         @db.disconnect
       end
+
+      #
+      # Open a new connection, ensure to close it with the #disconnect method.
+      #
+      # @return [Sequel::Database] The database connection instance
+      #
+      def new_connection
+        db = Sequel.postgres(**config)
+
+        db.extension(:pg_streaming)
+        db.stream_all_queries = true
+
+        db
+      end
     end
   end
 end

data/lib/ductr/postgres/basic_destination.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ductr
+  module Postgres
+    #
+    # A destination control that that writes rows one by one, registered as `:basic`:
+    #
+    #   destination :some_postgres_database, :basic
+    #   def select_some_stuff(db, row)
+    #     db[:items].where(id: row[:id]).update(**row)
+    #   end
+    #
+    class BasicDestination < Ductr::SequelBase::BasicDestination
+      Adapter.destination_registry.add(self, as: :basic)
+    end
+  end
+end

data/lib/ductr/postgres/version.rb

@@ -3,6 +3,6 @@
 module Ductr
   module Postgres
     # @return [String] VERSION Gem's version
-    VERSION = "0.2.1"
+    VERSION = "0.2.3"
   end
 end

data/sig/ductr/postgres.rbs

@@ -7,8 +7,7 @@ module Ductr
   # To get details about the database connection handling, checkout the {Ductr::Postgres::Adapter} class.
   # 
   # ### Sources
-  # - {Ductr::Postgres::BasicSource} Yields rows one by one.
-  # - {Ductr::Postgres::PaginatedSource} Allows to select a big number of rows by relying on pagination.
+  # - {Ductr::Postgres::BasicSource} Yields rows one by one using postgres streaming feature.
   # 
   # ### Lookups
   # - {Ductr::Postgres::BasicLookup} Executes one query per row and merge the looked up row with the current row.
@@ -41,7 +40,7 @@ module Ductr
     #   General sequel options
     # @see https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-postgres
     #   PostgreSQL specific options
-    class Adapter < Ductr::Adapter
+    class Adapter < Ductr::SequelBase::Adapter
       # sord warn - Sequel::Database wasn't able to be resolved to a constant in this project
       # Opens the database connection with the adapter's configuration.
       # 
@@ -52,8 +51,10 @@ module Ductr
       def close!: () -> void
 
       # sord warn - Sequel::Database wasn't able to be resolved to a constant in this project
+      # Open a new connection, ensure to close it with the #disconnect method.
+      # 
       # _@return_ — The database connection instance
-      attr_reader db: Sequel::Database?
+      def new_connection: () -> Sequel::Database
     end
 
     # 
@@ -69,13 +70,19 @@ module Ductr
     # ensure that column names are different or they will be overwritten.
     # 
     # If the lookup returns a falsy value, nothing won't be merged with the current row.
-    class BasicLookup < Ductr::ETL::Transform
-      # Calls the job's method to merge its result with the current row.
-      # 
-      # _@param_ `row` — The current row, preferably a Hash
-      # 
-      # _@return_ — The row merged with looked up row or the untouched row if nothing was found
-      def process: (::Hash[Symbol, Object] row) -> ::Hash[Symbol, Object]
+    class BasicLookup < Ductr::SequelBase::BasicLookup
+    end
+
+    # 
+    # A source control that yields rows usnig the PostgreSQL streaming feature, registered as `:basic`:
+    # 
+    #   source :some_postgres_database, :basic
+    #   def select_some_stuff(db)
+    #     db[:items].limit(42)
+    #   end
+    # 
+    # You can select a large number of rows, without worrying about pagination handling or memory usage.
+    class BasicSource < Ductr::SequelBase::BasicSource
     end
 
     # 
@@ -93,32 +100,7 @@ module Ductr
     #   def merge_with_stuff(db, ids)
     #     db[:items_bis].where(item: ids)
     #   end
-    class MatchLookup < Ductr::ETL::BufferedTransform
-      # The looked up row key to match.
-      # 
-      # _@return_ — The column name
-      def from_key: () -> Symbol
-
-      # The buffer row key to match.
-      # 
-      # _@return_ — The column name
-      def to_key: () -> Symbol
-
-      # Opens the database if needed, calls the job's method and merges
-      # the looked up rows with corresponding buffer rows.
-      def on_flush: () ?{ (::Hash[Symbol, Object] row) -> void } -> void
-
-      # Find the corresponding row into the buffer.
-      # 
-      # _@param_ `row` — The looked up row
-      # 
-      # _@return_ — the matching row if exists
-      def buffer_find: (::Hash[Symbol, Object] row) -> ::Hash[Symbol, Object]?
-
-      # Maps the buffer keys into an array.
-      # 
-      # _@return_ — The keys array
-      def buffer_keys: () -> ::Array[(Integer | String)]
+    class MatchLookup < Ductr::SequelBase::MatchLookup
     end
 
     # 
@@ -137,26 +119,7 @@ module Ductr
     #       yield(row.merge match)
     #     end
     #   end
-    class BufferedLookup < Ductr::ETL::BufferedTransform
-      # Opens the database if needed, calls the job's method and pass the each block to it.
-      def on_flush: () -> void
-    end
-
-    # 
-    # The rufus-scheduler handler class.
-    # @see https://github.com/jmettraux/rufus-scheduler#scheduling-handler-instances
-    #   For further information
-    class PollingHandler
-      # sord warn - Ductr::Adapter wasn't able to be resolved to a constant in this project
-      # Creates the handler based on the given scheduler, its method name and the trigger's adapter instance.
-      # 
-      # _@param_ `method` — The scheduler's method
-      # 
-      # _@param_ `adapter` — The trigger's adapter
-      def initialize: (Method method, Ductr::Adapter adapter) -> void
-
-      # The callable method used by the trigger, actually calls the scheduler's method.
-      def call: () -> void
+    class BufferedLookup < Ductr::SequelBase::BufferedLookup
     end
 
     # 
@@ -170,35 +133,17 @@ module Ductr
     # 
     #     MyJob.perform_later
     #   end
-    class PollingTrigger < Ductr::RufusTrigger
-      # Closes the connection if the scheduler is stopped.
-      def stop: () -> void
-
-      # sord duck - #call looks like a duck type, replacing with untyped
-      # Returns a callable object, allowing rufus-scheduler to call it.
-      # 
-      # _@param_ `scheduler` — The scheduler instance
-      # 
-      # _@param_ `method` — The scheduler's method
-      # 
-      # _@param_ `**` — The option passed to the trigger annotation
-      # 
-      # _@return_ — A callable object
-      def callable: (Method method) -> untyped
+    class PollingTrigger < Ductr::SequelBase::PollingTrigger
     end
 
     # 
-    # A source control that yields rows usnig the PostgreSQL streaming feature, registered as `:streamed`:
+    # A destination control that that writes rows one by one, registered as `:basic`:
     # 
-    #   source :some_postgres_database, :streamed
-    #   def select_some_stuff(db)
-    #     db[:items].limit(42)
+    #   destination :some_postgres_database, :basic
+    #   def select_some_stuff(db, row)
+    #     db[:items].where(id: row[:id]).update(**row)
     #   end
-    # 
-    # You can select a large number of rows, without worrying about pagination handling or memory usage.
-    class StreamedSource < Ductr::ETL::Source
-      # Opens the database, calls the job's method and iterate over the query results.
-      def each: () -> void
+    class BasicDestination < Ductr::SequelBase::BasicDestination
     end
 
     # 
@@ -211,9 +156,7 @@ module Ductr
     #   end
     # 
     # @see more Ductr::ETL::BufferedDestination
-    class BufferedDestination < Ductr::ETL::BufferedDestination
-      # Open the database if needed and call the job's method to run the query.
-      def on_flush: () -> void
+    class BufferedDestination < Ductr::SequelBase::BufferedDestination
     end
 
     # 
@@ -221,24 +164,12 @@ module Ductr
     # Accept the `:buffer_size` option, default value is 10 000:
     # 
     #   destination :some_postgres_database, :buffered_upsert, buffer_size: 42
-    #   def my_destination(buffer, excluded, db)
+    #   def my_destination(db, excluded, buffer)
     #     db[:items].insert_conflict(target: :id, update: excluded).multi_insert(buffer)
     #   end
     # 
     # @see more Ductr::ETL::BufferedDestination
-    class BufferedUpsertDestination < Ductr::ETL::BufferedDestination
-      # Open the database if needed and call the job's method to run the query.
-      def on_flush: () -> void
-
-      # sord warn - Sequel::SQL::QualifiedIdentifier wasn't able to be resolved to a constant in this project
-      # Generate the excluded keys hash e.g.
-      # 
-      # ```ruby
-      # {a: Sequel[:excluded][:a]}
-      # ```
-      # 
-      # _@return_ — The excluded keys hash
-      def excluded: () -> ::Hash[Symbol, Sequel::SQL::QualifiedIdentifier]
+    class BufferedUpsertDestination < Ductr::SequelBase::BufferedUpsertDestination
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ductr-postgres
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Mathieu Morel
@@ -225,6 +225,7 @@ files:
 - ductr-postgres.gemspec
 - lib/ductr/postgres.rb
 - lib/ductr/postgres/adapter.rb
+- lib/ductr/postgres/basic_destination.rb
 - lib/ductr/postgres/basic_lookup.rb
 - lib/ductr/postgres/basic_source.rb
 - lib/ductr/postgres/buffered_destination.rb