sequel 5.38.0 → 5.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1a5546546a02086c315afdb93e50fb2df1f12ee665f048cd36589bff6da6cd
-  data.tar.gz: f42f5a4ec65f1ed13de8f01f8091673688346be075fee60507adc13473e8528f
+  metadata.gz: b995589f8bb51611b490ae4cd1d84c2ecfbb5889cb4f940dd786a841fe9ecf9f
+  data.tar.gz: afa86ae9dfc39cd21138aff35955fb4194c359a1ea56c9a80026f04b85b79a4a
 SHA512:
-  metadata.gz: 5838cb5c5a9b24ba5646967a88bc4d487b99e760f8112ab455f0fb19dcfbd63cf884e1032bc31055eaeb0d1a89ab7d61b0865f89bfa35587b13ef4060fc8348c
-  data.tar.gz: d113cbddf7ccc677e0b43dd919fccdf3461d3f2157374b37cf89cfb1ce5f3156d43aab2bfcd9498ff99500bcd5fcd350fb8424894141a02cd648be128f36d0fc
+  metadata.gz: 553d5c2b92a49d079503c9e8e0f8dfecef1a4abf2ed2fe242c8aec19d53c918912de4f5d1453626a05c1b654c5582c508199df10aa7540ec590331b3ecb355da
+  data.tar.gz: f0fc7bceadccc74651573f82ed957ab91061ecb05f5f30050d0814a0142b915a79175d146b3bcac6f7269cd4f3b3b69eb58a92a4df439a944c081b45f1deaa2c

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 5.39.0 (2020-12-01)
+
+* Support :clustered option for primary key and unique constraints on Microsoft SQL Server (jeremyevans)
+
+* Do not modify the size of binary columns when using set_column_allow_null on Microsoft SQL Server (jeremyevans) (#1736)
+
+* Add a fork safety guide with more detail on how to use Sequel with libraries that fork (janko) (#1733)
+
+* Make the roots_dataset method in the tree plugin work with queries using joins (jeremyevans) (#1731)
+
+* Make Database#tables return partitioned tables on PostgreSQL 10+ (epoberezhny) (#1729, #1730)
+
 === 5.38.0 (2020-11-01)
 
 * Do not add new Database instances to Sequel::DATABASES if the test connection fails (jeremyevans) (#1727)

data/README.rdoc

@@ -883,7 +883,7 @@ raise an error by default:
 == Sequel Release Policy
 
 New major versions of Sequel do not have a defined release policy, but historically have
-occurred once ever few years.
+occurred once every few years.
 
 New minor versions of Sequel are released around once a month near the start of the month.
 

data/doc/cheat_sheet.rdoc

@@ -95,18 +95,18 @@ Without a filename argument, the sqlite adapter will setup a new sqlite database
 
 === AND/OR/NOT
 
-  DB[:items].where{(x > 5) & (y > 10)}.sql 
+  DB[:items].where{(x > 5) & (y > 10)} 
   # SELECT * FROM items WHERE ((x > 5) AND (y > 10))
 
-  DB[:items].where(Sequel.or(x: 1, y: 2) & Sequel.~(z: 3)).sql 
+  DB[:items].where(Sequel.or(x: 1, y: 2) & Sequel.~(z: 3)) 
   # SELECT * FROM items WHERE (((x = 1) OR (y = 2)) AND (z != 3))
 
 === Mathematical operators
 
-  DB[:items].where{x + y > z}.sql 
+  DB[:items].where{x + y > z} 
   # SELECT * FROM items WHERE ((x + y) > z)
 
-  DB[:items].where{price - 100 < avg(price)}.sql 
+  DB[:items].where{price - 100 < avg(price)} 
   # SELECT * FROM items WHERE ((price - 100) < avg(price))
 
 === Raw SQL Fragments
@@ -130,7 +130,7 @@ Without a filename argument, the sqlite adapter will setup a new sqlite database
 
 == Joins
 
-  DB[:items].left_outer_join(:categories, id: :category_id).sql 
+  DB[:items].left_outer_join(:categories, id: :category_id) 
   # SELECT * FROM items
   # LEFT OUTER JOIN categories ON categories.id = items.category_id
 

data/doc/code_order.rdoc

@@ -100,15 +100,3 @@ and freezing them can easily be achieved through the plugin:
   # ... setup models
   # Now finalize associations & freeze models by calling the plugin:
   Sequel::Model.freeze_descendents
-
-== Disconnect If Using Forking Webserver with Code Preloading
-
-If you are using a forking webserver such as unicorn or passenger, with
-a feature that loads your Sequel code before forking connections (code
-preloading), then you must disconnect your database connections before
-forking.  If you don't do this, you can end up with child processes
-sharing database connections and all sorts of weird behavior.  Sequel
-will automatically reconnect on an as needed basis in the child
-processes, so you only need to do the following in the parent process:
-
-  DB.disconnect

data/doc/fork_safety.rdoc

@@ -0,0 +1,84 @@
+= Fork Safety
+
+If you are forking or using a library that forks after you have created a
+Sequel::Database instance, then you must disconnect database connections before forking. If you
+don't do this, you can end up with child processes sharing database connections
+and all sorts of weird behavior, including crashes.  Sequel will automatically create new
+connections on an as needed basis in the child processes, so you only need to do the following in
+the parent process:
+
+  DB.disconnect
+
+Or if you have connections to multiple databases:
+
+  Sequel::DATABASES.each(&:disconnect)
+
+== Puma
+
+When using the Puma web server in clustered mode (which is the default behavior in Puma 5+ when
+using multiple processes), you should disconnect inside the +before_fork+ hook in your
+Puma config:
+
+  before_fork do
+    Sequel::DATABASES.each(&:disconnect)
+  end
+
+== Unicorn
+
+When using the Unicorn web server and preloading the application (+preload_app true+ in the Unicorn
+config), you should disconnect inside the +before_fork+ hook in the Unicorn config:
+
+  before_fork do
+    Sequel::DATABASES.each(&:disconnect)
+  end
+
+== Passenger
+
+In Passenger web server, you should disconnect inside the
++starting_worker_process+ event hook:
+
+  if defined?(PhusionPassenger)
+    PhusionPassenger.on_event(:starting_worker_process) do |forked|
+      Sequel::DATABASES.each(&:disconnect) if forked
+    end
+  end
+
+Note that this disconnects after forking instead of before forking.  Passenger does not
+offer a before fork hook.
+
+== Spring
+
+In Spring application preloader, you should disconnect inside the +after_fork+ hook:
+
+  if defined?(Spring)
+    Spring.after_fork do
+      Sequel::DATABASES.each(&:disconnect)
+    end
+  end
+
+As the method indicates, this disconnects after forking instead of before forking.
+Spring does not offer a before fork hook.
+
+== Resque
+
+In Resque, you should disconnect inside the +before_fork+ hook:
+
+  Resque.before_fork do |job|
+    Sequel::DATABASES.each(&:disconnect)
+  end
+
+== Parallel
+
+If you're using the Parallel gem with processes, you should disconnect before
+calling it:
+
+  Sequel::DATABASES.each(&:disconnect)
+  Parallel.map(['a','b','c'], in_processes: 3) { |one_letter| }
+
+== Other Libraries Calling fork
+
+For any other library that calls fork, you should disconnect before calling
+a method that forks:
+
+  Sequel::DATABASES.each(&:disconnect)
+  SomeLibrary.method_that_forks

data/doc/postgresql.rdoc

@@ -213,7 +213,7 @@ other tables.  Support may be added in the future.
 === Creating Unlogged Tables
 
 PostgreSQL allows users to create unlogged tables, which are faster but not crash safe.  Sequel
-allows you do create an unlogged table by specifying the <tt>unlogged: true</tt> option to +create_table+:
+allows you to create an unlogged table by specifying the <tt>unlogged: true</tt> option to +create_table+:
 
   DB.create_table(:table, unlogged: true){Integer :i}
   # CREATE UNLOGGED TABLE "table" ("i" integer)

data/doc/querying.rdoc

@@ -746,7 +746,7 @@ shortcuts for all common (and most uncommon) join types. For example
 
   Album.join(:artists, id: :artist_id)
   # SELECT * FROM albums
-  # INNER JOIN artists ON (artists.id = albums.artist_id))))
+  # INNER JOIN artists ON (artists.id = albums.artist_id)
 
 And +left_join+ does a LEFT JOIN:
 
@@ -870,14 +870,14 @@ In this case, you don't even need to specify any conditions.
 ==== Join Blocks
 
 You can provide a block to any of the join methods that accept
-conditions.  This block should accept 3 arguments, the table alias
+conditions.  This block should accept 3 arguments: the table alias
 for the table currently being joined, the table alias for the last
 table joined (or first table), and an array of previous
 <tt>Sequel::SQL::JoinClause</tt>s.
 
 This allows you to qualify columns similar to how the implicit
 qualification works, without worrying about the specific aliases
-being used.  For example, lets say you wanted to join the albums
+being used.  For example, let's say you wanted to join the albums
 and artists tables, but only want albums where the artist's name
 comes before the album's name.
 

data/doc/release_notes/5.39.0.txt

@@ -0,0 +1,19 @@
+= New Features
+
+* On Microsoft SQL Server, the :clustered option is now supported
+  for primary key and unique constraints.  You can use a true value
+  for CLUSTERED and a false value for NONCLUSTERED.
+
+= Other Improvements
+
+* Partitioned tables are now included in the result of
+  Database#tables on PostgreSQL.
+
+* alter_table set_column_allow_null no longer drops the size of
+  binary columns on Microsoft SQL Server.
+
+* In the tree plugin, the roots_dataset method now works correctly
+  with queries using joins by qualifying the parent column.
+
+* A fork safety guide has been added, discussing fork safety issues
+  when using Sequel.

data/lib/sequel/adapters/shared/mssql.rb

@@ -244,6 +244,16 @@ module Sequel
       
       private
       
+      # Add CLUSTERED or NONCLUSTERED as needed
+      def add_clustered_sql_fragment(sql, opts)
+        clustered = opts[:clustered]
+        unless clustered.nil?
+          sql += " #{'NON' unless clustered}CLUSTERED"
+        end
+
+        sql
+      end
+    
       # Add dropping of the default constraint to the list of SQL queries.
       # This is necessary before dropping the column or changing its type.
       def add_drop_default_constraint_sql(sqls, table, column)
@@ -284,7 +294,7 @@ module Sequel
         when :set_column_null
           sch = schema(table).find{|k,v| k.to_s == op[:name].to_s}.last
           type = sch[:db_type]
-          if [:string, :decimal].include?(sch[:type]) && !["text", "ntext"].include?(type) && (size = (sch[:max_chars] || sch[:column_size]))
+          if [:string, :decimal, :blob].include?(sch[:type]) && !["text", "ntext"].include?(type) && (size = (sch[:max_chars] || sch[:column_size]))
             size = "MAX" if size == -1
             type += "(#{size}#{", #{sch[:scale]}" if sch[:scale] && sch[:scale].to_i > 0})"
           end
@@ -396,6 +406,11 @@ module Sequel
         super.with_quote_identifiers(true)
       end
       
+      # Handle clustered and nonclustered primary keys
+      def primary_key_constraint_sql_fragment(opts)
+        add_clustered_sql_fragment(super, opts)
+      end
+      
       # Use sp_rename to rename the table
       def rename_table_sql(name, new_name)
         "sp_rename #{literal(quote_schema_table(name))}, #{quote_identifier(schema_and_table(new_name).pop)}"
@@ -492,6 +507,11 @@ module Sequel
         :'varbinary(max)'
       end
       
+      # Handle clustered and nonclustered unique constraints
+      def unique_constraint_sql_fragment(opts)
+        add_clustered_sql_fragment(super, opts)
+      end
+
       # MSSQL supports views with check option, but not local.
       def view_with_check_option_support
         true

data/lib/sequel/adapters/shared/postgres.rb

@@ -846,7 +846,7 @@ module Sequel
       # :schema :: The schema to search
       # :server :: The server to use
       def tables(opts=OPTS, &block)
-        pg_class_relname('r', opts, &block)
+        pg_class_relname(['r', 'p'], opts, &block)
       end
 
       # Check whether the given type name string/symbol (e.g. :hstore) is supported by

data/lib/sequel/database/schema_generator.rb

@@ -143,8 +143,14 @@ module Sequel
       # :identity :: Create an identity column.
       #
       # MySQL specific options:
+      #
       # :generated_type :: Set the type of column when using :generated_always_as,
       #                    should be :virtual or :stored to force a type.
+      #
+      # Microsoft SQL Server specific options:
+      #
+      # :clustered :: When using :primary_key or :unique, marks the primary key or unique
+      #               constraint as CLUSTERED (if true), or NONCLUSTERED (if false).
       def column(name, type, opts = OPTS)
         columns << {:name => name, :type => type}.merge!(opts)
         if index_opts = opts[:index]

data/lib/sequel/database/schema_methods.rb

@@ -580,14 +580,14 @@ module Sequel
         sql << ' NULL'
       end
     end
-    
+
     # Add primary key SQL fragment to column creation SQL.
     def column_definition_primary_key_sql(sql, column)
       if column[:primary_key]
         if name = column[:primary_key_constraint_name]
           sql << " CONSTRAINT #{quote_identifier(name)}"
         end
-        sql << ' PRIMARY KEY'
+        sql << " " << primary_key_constraint_sql_fragment(column)
         constraint_deferrable_sql_append(sql, column[:primary_key_deferrable])
       end
     end
@@ -608,7 +608,7 @@ module Sequel
         if name = column[:unique_constraint_name]
           sql << " CONSTRAINT #{quote_identifier(name)}"
         end
-        sql << ' UNIQUE'
+        sql << ' ' << unique_constraint_sql_fragment(column)
         constraint_deferrable_sql_append(sql, column[:unique_deferrable])
       end
     end
@@ -656,11 +656,11 @@ module Sequel
         check = "(#{check})" unless check[0..0] == '(' && check[-1..-1] == ')'
         sql << "CHECK #{check}"
       when :primary_key
-        sql << "PRIMARY KEY #{literal(constraint[:columns])}"
+        sql << "#{primary_key_constraint_sql_fragment(constraint)} #{literal(constraint[:columns])}"
       when :foreign_key
         sql << column_references_table_constraint_sql(constraint.merge(:deferrable=>nil))
       when :unique
-        sql << "UNIQUE #{literal(constraint[:columns])}"
+        sql << "#{unique_constraint_sql_fragment(constraint)} #{literal(constraint[:columns])}"
       else
         raise Error, "Invalid constraint type #{constraint[:type]}, should be :check, :primary_key, :foreign_key, or :unique"
       end
@@ -892,6 +892,11 @@ module Sequel
       on_delete_clause(action)
     end
     
+    # Add fragment for primary key specification, separated for easier overridding.
+    def primary_key_constraint_sql_fragment(_)
+      'PRIMARY KEY'
+    end
+    
     # Proxy the quote_schema_table method to the dataset
     def quote_schema_table(table)
       schema_utility_dataset.quote_schema_table(table)
@@ -1047,6 +1052,11 @@ module Sequel
       "#{type}#{literal(Array(elements)) if elements}#{' UNSIGNED' if column[:unsigned]}"
     end
 
+    # Add fragment for unique specification, separated for easier overridding.
+    def unique_constraint_sql_fragment(_)
+      'UNIQUE'
+    end
+    
     # Whether clob should be used for String text: true columns.
     def uses_clob_for_text?
       false

data/lib/sequel/database/transactions.rb

@@ -82,7 +82,7 @@ module Sequel
     # :server :: The server/shard the transaction is being executed on.
     def rollback_on_exit(opts=OPTS)
       synchronize(opts[:server]) do |conn|
-        raise Error, "Cannot call Sequel:: Database#rollback_on_exit! unless inside a transaction" unless h = _trans(conn)
+        raise Error, "Cannot call Sequel:: Database#rollback_on_exit unless inside a transaction" unless h = _trans(conn)
         rollback = !opts[:cancel]
 
         if supports_savepoints?

data/lib/sequel/plugins/single_table_inheritance.rb

@@ -251,6 +251,8 @@ module Sequel
           super
         end
 
+        private
+
         # Don't allow use of prepared statements.
         def use_prepared_statements_for?(type)
           false

data/lib/sequel/plugins/tree.rb

@@ -45,6 +45,7 @@ module Sequel
 
         model.instance_exec do
           @parent_column = opts[:key]
+          @qualified_parent_column = Sequel.deep_qualify(table_name, opts[:key])
           @tree_order = opts[:order]
           @parent_association_name = parent
           @children_association_name = children
@@ -59,17 +60,21 @@ module Sequel
         # The column symbol or array of column symbols on which to order the tree.
         attr_accessor :tree_order
         
-        # The symbol for the column containing the value pointing to the
-        # parent of the leaf.
+        # The symbol or array of symbols for the column containing the value pointing to the
+        # parent of the node.
         attr_accessor :parent_column
 
+        # The qualified identifier or array of qualified identifiers for the column
+        # containing the value pointing to the parent of the node.
+        attr_accessor :qualified_parent_column
+
         # The association name for the parent association
         attr_reader :parent_association_name
 
         # The association name for the children association
         attr_reader :children_association_name
 
-        Plugins.inherited_instance_variables(self, :@parent_column=>nil, :@tree_order=>nil, :@parent_association_name=>nil, :@children_association_name=>nil)
+        Plugins.inherited_instance_variables(self, :@parent_column=>nil, :@qualified_parent_column=>nil, :@tree_order=>nil, :@parent_association_name=>nil, :@children_association_name=>nil)
         Plugins.def_dataset_methods(self, [:roots, :roots_dataset])
 
         # Should freeze tree order if it is an array when freezing the model class.
@@ -151,7 +156,7 @@ module Sequel
         #
         #   TreeClass.roots_dataset # => Sequel::Dataset instance
         def roots_dataset
-          ds = where(Sequel.or(Array(model.parent_column).zip([])))
+          ds = where(Sequel.or(Array(model.qualified_parent_column).zip([])))
           ds = ds.order(*model.tree_order) if model.tree_order
           ds
         end

data/lib/sequel/timezones.rb

@@ -10,9 +10,14 @@ module Sequel
   Timezones = SequelMethods
   Deprecation.deprecate_constant(self, :Timezones)
   
-  # Sequel doesn't pay much attention to timezones by default, but you can set it
-  # handle timezones if you want.  There are three separate timezone settings, application_timezone,
-  # database_timezone, and typecast_timezone.  All three timezones have getter and setter methods.
+  # Sequel doesn't pay much attention to timezones by default, but you can set it to
+  # handle timezones if you want.  There are three separate timezone settings:
+  #
+  # * application_timezone
+  # * database_timezone
+  # * typecast_timezone
+  #
+  # All three timezones have getter and setter methods.
   # You can set all three timezones to the same value at once via <tt>Sequel.default_timezone=</tt>.
   #
   # The only timezone values that are supported by default are <tt>:utc</tt> (convert to UTC),

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 = 38
+  MINOR = 39
 
   # 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.38.0
+  version: 5.39.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-01 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -147,6 +147,7 @@ extra_rdoc_files:
 - doc/testing.rdoc
 - doc/validations.rdoc
 - doc/transactions.rdoc
+- doc/fork_safety.rdoc
 - doc/release_notes/5.5.0.txt
 - doc/release_notes/5.6.0.txt
 - doc/release_notes/5.0.0.txt
@@ -186,6 +187,7 @@ extra_rdoc_files:
 - doc/release_notes/5.36.0.txt
 - doc/release_notes/5.37.0.txt
 - doc/release_notes/5.38.0.txt
+- doc/release_notes/5.39.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -200,6 +202,7 @@ files:
 - doc/dataset_basics.rdoc
 - doc/dataset_filtering.rdoc
 - doc/extensions.rdoc
+- doc/fork_safety.rdoc
 - doc/mass_assignment.rdoc
 - doc/migration.rdoc
 - doc/model_dataset_method_design.rdoc
@@ -245,6 +248,7 @@ files:
 - doc/release_notes/5.36.0.txt
 - doc/release_notes/5.37.0.txt
 - doc/release_notes/5.38.0.txt
+- doc/release_notes/5.39.0.txt
 - doc/release_notes/5.4.0.txt
 - doc/release_notes/5.5.0.txt
 - doc/release_notes/5.6.0.txt