sequel-activerecord_connection 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4618dbde61b958267d7aa3b2e5e8c18d2dfd55207c8dcb9b3a0a9db4c8ca4b2b
-  data.tar.gz: 1c84a6e396817472d844739c24046df8cf83d6488a1a95f948677be228e05b13
+  metadata.gz: 5b1082cb22dfbf8b9bac60130ae0c37454433f3693fb8ddcb65b5c4acf947c66
+  data.tar.gz: 5bd9aeb196b39ac626e087f88442f42318b628e0d6890761fa071f69efb4b403
 SHA512:
-  metadata.gz: ae70b61b0f8b94d8eb6130c281515c490b9e80794d6081797a55a216f03296a5531d0993c09997603ac20d4eb7d448f5880e650f231f1968d159f9331ecd50d1
-  data.tar.gz: 1789fc025d079f5415d11f08590b00e7e9ff322587160c7ab9d123d1ceb598fd315ad730ed4642d99b51c80ba34fb386a5c507c0bf6d3c909ce0232bbc7e8852
+  metadata.gz: d9dd1bc2f3b5e2435e8bf5786955cf6c53ebe26d30d87a283b571fa3c2cb5ad1cef61b99997b3dc480d123636920681a7304d7e3a1a05f7d59cadf6ac56f9334
+  data.tar.gz: 4ce05904e61edb1a245ccdec85aa5bbc21c40af2b7c67d0d877c36d2f40bb9430e3b5a76c7a4f4b183d8a544f97b0fc132653d2d03623fef949fb7eb01beb783

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.8 (2022-02-28)
+
+* Support the pg_streaming database extension from the sequel_pg gem (@janko)
+
 ## 1.2.7 (2022-01-20)
 
 * Require Sequel 3.38+ (@janko)

data/README.md

@@ -1,18 +1,42 @@
 # sequel-activerecord_connection
 
-This is an extension for [Sequel] that allows it to reuse an existing
-ActiveRecord connection for database interaction.
+This is a database extension for [Sequel] that makes it to reuse an existing
+Active Record connection for database interaction.
 
-This can be useful if you're using a library that uses Sequel for database
-interaction (e.g. [Rodauth] or [rom-sql]), but you want to avoid creating a
-separate database connection. Or if you're transitioning from ActiveRecord to
-Sequel, and want the database connection to be shared.
+This can be useful if you want to use a library that uses Sequel (e.g.
+[Rodauth] or [rom-sql]), or you're transitioning from Active Record to Sequel,
+or if you just want to use Sequel for more complex queries, and you want to
+avoid creating new database connections.
 
 It works on ActiveRecord 4.2+ and fully supports PostgresSQL, MySQL and SQLite
-adapters, both the native ones and JDBC (JRuby). There is attempted suppport
-for [Oracle enhanced] and [SQL Server] Active Record adapters (`oracle` and
-`tinytds` in Sequel). Other adapters might work too, but their integration
-hasn't been tested.
+adapters, both native and JDBC (JRuby). There is attempted suppport for [Oracle
+enhanced] and [SQL Server] Active Record adapters (`oracle` and `tinytds` in
+Sequel). Other adapters might work too, but their integration hasn't been
+tested.
+
+## Why reuse the database connection?
+
+At first it might appear that, as long as you're fine with the performance
+impact of your database server having to maintain additional open connections,
+it would be fine if Sequel had its own database connection. However, there are
+additional caveats when you try to combine it with Active Record.
+
+If Sequel and Active Record each have their own connections, then it's not
+possible to combine their transactions. If we executed a Sequel query inside of
+an Active Record transaction, that query won't actually be executed inside a
+database transaction. This is because transactions are tied to the database
+connection; if one connection opens a transaction, this doesn't affect queries
+executed on a different connection, even if both connections are used in the
+same ruby process. With this library, transactions and queries can be
+seamlessly combined between Active Record and Sequel.
+
+In Rails context, there are additional considerations for a Sequel connection
+to play nicely. Connecting and disconnecting would have to go in lockstep with
+Active Record, to make commands such as `rails db:create` and `rails db:drop`
+work. You'd also need to find a way for system tests and the app running in the
+background to share the same database connection, which is something Sequel
+wasn't designed for. Reusing Active Record's connection means (dis)connecting
+and sharing between threads is all handled automatically.
 
 ## Installation
 
@@ -140,9 +164,8 @@ DB.transaction(auto_savepoint: true) do
 end
 #>> BEGIN
 #>> SAVEPOINT active_record_1
-#>> RELEASE SAVEPOINT active_record_1
+#>> ROLLBACK TO SAVEPOINT active_record_1
 #>> COMMIT
-#>> after commit
 ```
 
 In case of (a) adding a transaction hook while Active Record holds the
@@ -168,13 +191,13 @@ end
 # after a savepoint is released, if the enclosing transaction is not joinable.
 ActiveRecord::Base.transaction(joinable: false) do
   DB.transaction do
-    DB.after_commit { puts "after commit" }
+    DB.after_commit { puts "after savepoint release" }
   end
 end
 #>> BEGIN
 #>> SAVEPOINT active_record_1
 #>> RELEASE SAVEPOINT active_record_1
-#>> after commit
+#>> after savepoint release
 #>> COMMIT
 ```
 

data/lib/sequel/extensions/activerecord_connection/postgres.rb

@@ -10,6 +10,11 @@ module Sequel
 
           Utils.add_prepared_statements_cache(conn)
 
+          # compatibility for pg_streaming database extension from sequel_pg gem
+          if defined?(Sequel::Postgres::Streaming) && is_a?(Sequel::Postgres::Streaming)
+            conn.extend(Sequel::Postgres::Streaming::AdapterMethods)
+          end
+
           yield conn
         end
       end
@@ -70,11 +75,11 @@ module Sequel
         # yield the results, otherwise, return the number of changed rows.
         def execute(sql, args = nil)
           args   = args.map { |v| @db.bound_variable_arg(v, self) } if args
-          result = check_disconnect_errors { execute_query(sql, args) }
+          q = check_disconnect_errors { execute_query(sql, args) }
 
-          block_given? ? yield(result) : result.cmd_tuples
+          block_given? ? yield(q) : q.cmd_tuples
         ensure
-          result.clear if result
+          q.clear if q && q.respond_to?(:clear)
         end
 
         private

data/sequel-activerecord_connection.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "sequel-activerecord_connection"
-  spec.version       = "1.2.7"
+  spec.version       = "1.2.8"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 
@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.4"
 
   spec.add_dependency "sequel", "~> 5.38"
+  spec.add_dependency "sequel_pg" unless RUBY_ENGINE == "jruby"
   spec.add_dependency "activerecord", ">= 4.2", "< 8"
   spec.add_dependency "after_commit_everywhere", "~> 1.1"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-activerecord_connection
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.38'
+- !ruby/object:Gem::Dependency
+  name: sequel_pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Allows Sequel to use ActiveRecord connection for database interaction.