sequel 5.68.0 → 5.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e682467c455e044847fffb313b6d8a669e0dc89ca8ea330468841de642b84227
-  data.tar.gz: cd0687fd059a6b6d38cb31279d5cdacccd4a0a309f1155171f12551d43eacb0b
+  metadata.gz: dc06712b20f476b85d0a08a4d94d96a2c74e0a632053baeecefbecd4cd60d476
+  data.tar.gz: dd5fdc130ad5a4fb19579c45e426d2a2da6431b14af18dd87fd8785b45fb0684
 SHA512:
-  metadata.gz: 3c16f027251aa67e04cab0973a57da21682e083c7362f37bdbf84937266ca6878e200fb7c44a0583b8ac6fab62d1fd4b55744929760fc63a9d1f850452db5df6
-  data.tar.gz: 60eee01297c47ee9c18ae76b6974b6eb3e492e58c7f408ee9c32476f1ae0ae5848ffc47cb80889f7070b02088e7e66509b64e460a1ef61c90ffb5a59da6a3c09
+  metadata.gz: e0c1138064b489cbcdc7740f047095279e1f6e9a71e2ef1502359fbc440e8a2caed3009745d0aadbd51c7d2c13dbc6b971150f370bbe10a0f2e566e0cf219722
+  data.tar.gz: 364735d4186439b97d2d7e5a83c3ddd13fdcf5af433b97d1892898b3f04115191a4dc77fd5d711a7ad715e8a707c5389aac6bfb539840464cff53e6d3f04ff6f

data/CHANGELOG

@@ -1,3 +1,13 @@
+=== 5.69.0 (2023-06-01)
+
+* Avoid unsupported flag warning when using the mysql adapter with ruby-mysql 3+ (jeremyevans)
+
+* Make mysql adapter work with ruby-mysql 4+ (jeremyevans)
+
+* Add Model::DatasetModule#model accessor (davekaro) (#2040)
+
+* Add trilogy adapter (jeremyevans)
+
 === 5.68.0 (2023-05-01)
 
 * Add validation_helpers_generic_type_messages plugin for more useful type validation failure messages (jeremyevans) (#2028)

data/README.rdoc

@@ -13,7 +13,7 @@ toolkit for Ruby.
   database sharding.
 * Sequel currently has adapters for ADO, Amalgalite, 
   IBM_DB, JDBC, MySQL, Mysql2, ODBC, Oracle,
-  PostgreSQL, SQLAnywhere, SQLite3, and TinyTDS.
+  PostgreSQL, SQLAnywhere, SQLite3, TinyTDS, and Trilogy.
 
 == Resources
 

data/doc/opening_databases.rdoc

@@ -279,7 +279,7 @@ if either the :sslca or :sslkey option is given.
 
 === mysql2
 
-This is a newer MySQL adapter that does typecasting in C, so it is often faster than the
+This is a MySQL adapter that does typecasting in C, so it is often faster than the
 mysql adapter.  The options given are passed to Mysql2::Client.new, see the mysql2 documentation
 for details on what options are supported. The :timeout, :auto_is_null, :sql_mode, and :disable_split_materialized
 options supported by the mysql adapter are also supported for mysql2 adapter (and any other adapters connecting to
@@ -423,3 +423,10 @@ Other Sequel specific options:
              This should be specified as an integer.  If you plan on setting large
              text or blob values via tinytds, you should use this option or modify
              your freetds.conf file.
+
+=== trilogy
+
+This is a MySQL adapter that does typecasting in C, and does not require any mysql client libraries installed.
+The options given are passed to Trilogy.new, see the trilogy documentation for details on what options are
+supported. The :timeout, :auto_is_null, :sql_mode, and :disable_split_materialized
+options supported by the mysql adapter are also supported for trilogy adapter.

data/doc/release_notes/5.69.0.txt

@@ -0,0 +1,26 @@
+= New Features
+
+* An adapter has been added for the trilogy MySQL driver. One large
+  advantage over mysql2 is that trilogy does not require any MySQL
+  client libraries installed on the machine. The trilogy adapter
+  has basically the same issues/skipped specs as the mysql2 adapter,
+  but it also does not support an application_timezone different
+  than the database_timezone.
+
+* Model dataset modules now have a model accessor, allowing for
+  code such as:
+
+    class Foo < Sequel::Model
+      dataset_module do
+        where :kept, Sequel[model.table_name][:discarded_at] => nil
+      end
+    end
+
+= Improvements
+
+* The mysql adapter now works with ruby-mysql 4 (the pure-ruby
+  MySQL driver).  Note that multi-results support does not work
+  with ruby-mysql 4 (it doesn't work with mysql2, trilogy, or
+  other Sequel adapters in general).
+
+* Warnings for unsupported flags are now avoided on ruby-mysql 3.

data/doc/sharding.rdoc

@@ -39,7 +39,9 @@ is the simplest configuration:
     servers: {read_only: {host: 'replica_server'}})
 
 This will use the replica_server for SELECT queries and primary_server for
-other queries.
+other queries. The :read_only key in the :servers hash is special in that
+it sets the default database for Dataset methods that use SELECT queries
+(which are generally read queries that do not modify the database).
 
 If you want to ensure your queries are going to a specific database, you
 can force this for a given query by using the .server method and passing 

data/lib/sequel/adapters/mysql.rb

@@ -29,6 +29,21 @@ module Sequel
     end
     MYSQL_TYPES.freeze
 
+    RUBY_MYSQL_3 = !Mysql.respond_to?(:init)
+    RUBY_MYSQL_4 = RUBY_MYSQL_3 && ::Mysql::VERSION.to_i >= 4
+
+    if RUBY_MYSQL_3
+      class Adapter < ::Mysql
+        alias real_connect connect
+        alias use_result store_result
+        if RUBY_MYSQL_4
+          def initialize(**opts)
+            super(**opts.merge(:cast=>false))
+          end
+        end
+      end
+    end
+
     class Database < Sequel::Database
       include Sequel::MySQL::DatabaseMethods
       include Sequel::MySQL::MysqlMysql2::DatabaseMethods
@@ -72,7 +87,7 @@ module Sequel
       def connect(server)
         opts = server_opts(server)
 
-        if Mysql.respond_to?(:init)
+        if !RUBY_MYSQL_3
           conn = Mysql.init
           conn.options(Mysql::READ_DEFAULT_GROUP, opts[:config_default_group] || "client")
           conn.options(Mysql::OPT_LOCAL_INFILE, opts[:config_local_infile]) if opts.has_key?(:config_local_infile)
@@ -88,8 +103,8 @@ module Sequel
             conn.options(Mysql::OPT_CONNECT_TIMEOUT, connect_timeout)
           end
         else
-          # ruby-mysql 3 API
-          conn = Mysql.new
+          # ruby-mysql 3+ API
+          conn = Adapter.new
           # no support for default group
           conn.local_infile = opts[:config_local_infile] if opts.has_key?(:config_local_infile)
           if encoding = opts[:encoding] || opts[:charset]
@@ -101,10 +116,7 @@ module Sequel
           if connect_timeout = opts[:connect_timeout]
             conn.connect_timeout = connect_timeout
           end
-          conn.singleton_class.class_eval do
-            alias real_connect connect
-            alias use_result store_result
-          end
+          opts[:compress] = false
         end
 
         conn.ssl_set(opts[:sslkey], opts[:sslcert], opts[:sslca], opts[:sslcapath], opts[:sslcipher]) if opts[:sslca] || opts[:sslkey]

data/lib/sequel/adapters/trilogy.rb

@@ -0,0 +1,117 @@
+# frozen-string-literal: true
+
+require 'trilogy'
+require_relative 'shared/mysql'
+
+module Sequel
+  module Trilogy
+    class Database < Sequel::Database
+      include Sequel::MySQL::DatabaseMethods
+
+      QUERY_FLAGS = ::Trilogy::QUERY_FLAGS_CAST | ::Trilogy::QUERY_FLAGS_CAST_BOOLEANS
+      LOCAL_TIME_QUERY_FLAGS = QUERY_FLAGS | ::Trilogy::QUERY_FLAGS_LOCAL_TIMEZONE
+
+      set_adapter_scheme :trilogy
+      
+      # Connect to the database.  See Trilogy documentation for options.
+      def connect(server)
+        opts = server_opts(server)
+        opts[:username] ||= opts.delete(:user)
+        opts[:found_rows] = true
+        conn = ::Trilogy.new(opts)
+        mysql_connection_setting_sqls.each{|sql| log_connection_yield(sql, conn){conn.query(sql)}}
+        conn
+      end
+
+      def disconnect_connection(c)
+        c.discard!
+      rescue ::Trilogy::Error
+        nil
+      end
+
+      # Execute the given SQL on the given connection and yield the result.
+      def execute(sql, opts)
+        r = synchronize(opts[:server]) do |conn|
+          log_connection_yield((log_sql = opts[:log_sql]) ? sql + log_sql : sql, conn) do
+            conn.query_with_flags(sql, timezone.nil? || timezone == :local ? LOCAL_TIME_QUERY_FLAGS : QUERY_FLAGS)
+          end
+        end
+        yield r
+      rescue ::Trilogy::Error => e
+        raise_error(e)
+      end
+
+      def execute_dui(sql, opts=OPTS)
+        execute(sql, opts, &:affected_rows)
+      end
+
+      def execute_insert(sql, opts=OPTS)
+        execute(sql, opts, &:last_insert_id)
+      end
+
+      def freeze
+        server_version
+        super
+      end
+
+      # Return the version of the MySQL server to which we are connecting.
+      def server_version(_server=nil)
+        @server_version ||= super()
+      end
+
+      private
+
+      def database_specific_error_class(exception, opts)
+        case exception.message
+        when /1205 - Lock wait timeout exceeded; try restarting transaction\z/
+          DatabaseLockTimeout
+        else
+          super
+        end
+      end
+
+      def connection_execute_method
+        :query
+      end
+
+      def database_error_classes
+        [::Trilogy::Error]
+      end
+
+      def dataset_class_default
+        Dataset
+      end
+
+      # Convert tinyint(1) type to boolean if convert_tinyint_to_bool is true
+      def schema_column_type(db_type)
+        db_type =~ /\Atinyint\(1\)/ ? :boolean : super
+      end
+    end
+
+    class Dataset < Sequel::Dataset
+      include Sequel::MySQL::DatasetMethods
+
+      def fetch_rows(sql)
+        execute(sql) do |r|
+          self.columns = r.fields.map!{|c| output_identifier(c.to_s)}
+          r.each_hash{|h| yield h}
+        end
+        self
+      end
+      
+      private
+
+      def execute(sql, opts=OPTS)
+        opts = Hash[opts]
+        opts[:type] = :select
+        super
+      end
+
+      # Handle correct quoting of strings using ::Trilogy#escape.
+      def literal_string_append(sql, v)
+        sql << "'" << db.synchronize(@opts[:server]){|c| c.escape(v)} << "'"
+      end
+    end
+  end
+end
+

data/lib/sequel/database/connecting.rb

@@ -8,7 +8,7 @@ module Sequel
     # ---------------------
 
     # Array of supported database adapters
-    ADAPTERS = %w'ado amalgalite ibmdb jdbc mock mysql mysql2 odbc oracle postgres sqlanywhere sqlite tinytds'.map(&:to_sym)
+    ADAPTERS = %w'ado amalgalite ibmdb jdbc mock mysql mysql2 odbc oracle postgres sqlanywhere sqlite tinytds trilogy'.map(&:to_sym)
 
     # The Database subclass for the given adapter scheme.
     # Raises Sequel::AdapterNotFound if the adapter

data/lib/sequel/model/dataset_module.rb

@@ -8,6 +8,9 @@ module Sequel
     # automatically creates class methods for public dataset
     # methods.
     class DatasetModule < Dataset::DatasetModule
+      # The model class related to this dataset module.
+      attr_reader :model
+
       # Store the model related to this dataset module.
       def initialize(model)
         @model = model

data/lib/sequel/version.rb

@@ -6,7 +6,7 @@ module Sequel
 
   # The minor version of Sequel.  Bumped for every non-patch level
   # release, generally around once a month.
-  MINOR = 68
+  MINOR = 69
 
   # The tiny version of Sequel.  Usually 0, only bumped for bugfix
   # releases that fix regressions from previous versions.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel
 version: !ruby/object:Gem::Version
-  version: 5.68.0
+  version: 5.69.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -200,6 +200,7 @@ extra_rdoc_files:
 - doc/release_notes/5.66.0.txt
 - doc/release_notes/5.67.0.txt
 - doc/release_notes/5.68.0.txt
+- doc/release_notes/5.69.0.txt
 - doc/release_notes/5.7.0.txt
 - doc/release_notes/5.8.0.txt
 - doc/release_notes/5.9.0.txt
@@ -296,6 +297,7 @@ files:
 - doc/release_notes/5.66.0.txt
 - doc/release_notes/5.67.0.txt
 - doc/release_notes/5.68.0.txt
+- doc/release_notes/5.69.0.txt
 - doc/release_notes/5.7.0.txt
 - doc/release_notes/5.8.0.txt
 - doc/release_notes/5.9.0.txt
@@ -349,6 +351,7 @@ files:
 - lib/sequel/adapters/sqlanywhere.rb
 - lib/sequel/adapters/sqlite.rb
 - lib/sequel/adapters/tinytds.rb
+- lib/sequel/adapters/trilogy.rb
 - lib/sequel/adapters/utils/columns_limit_1.rb
 - lib/sequel/adapters/utils/emulate_offset_with_reverse_and_count.rb
 - lib/sequel/adapters/utils/emulate_offset_with_row_number.rb