sequel 4.49.0 → 5.0.0

data/lib/sequel/dataset/features.rb

@@ -14,39 +14,38 @@ module Sequel
     end
     
     # Whether this dataset will provide accurate number of rows matched for
-    # delete and update statements.  Accurate in this case is the number of
+    # delete and update statements, true by default.  Accurate in this case is the number of
     # rows matched by the dataset's filter.
     def provides_accurate_rows_matched?
       true
     end
     
-    # Whether you must use a column alias list for recursive CTEs (false by
-    # default).
+    # Whether you must use a column alias list for recursive CTEs, false by default.
     def recursive_cte_requires_column_aliases?
       false
     end
 
-    # Whether the dataset requires SQL standard datetimes (false by default,
-    # as most allow strings with ISO 8601 format).
+    # Whether the dataset requires SQL standard datetimes. False by default,
+    # as most allow strings with ISO 8601 format.
     def requires_sql_standard_datetimes?
       false
     end
 
     # Whether type specifiers are required for prepared statement/bound
-    # variable argument placeholders (i.e. :bv__integer)
+    # variable argument placeholders (i.e. :bv__integer), false by default.
     def requires_placeholder_type_specifiers?
       false
     end
 
-    # Whether the dataset supports common table expressions (the WITH clause).
+    # Whether the dataset supports common table expressions, false by default.
     # If given, +type+ can be :select, :insert, :update, or :delete, in which case it
     # determines whether WITH is supported for the respective statement type.
     def supports_cte?(type=:select)
       false
     end
 
-    # Whether the dataset supports common table expressions (the WITH clause)
-    # in subqueries.  If false, applies the WITH clause to the main query, which can cause issues
+    # Whether the dataset supports common table expressions in subqueries, false by default.
+    # If false, applies the WITH clause to the main query, which can cause issues
     # if multiple WITH clauses use the same name.
     def supports_cte_in_subqueries?
       false
@@ -64,23 +63,23 @@ module Sequel
       false
     end
 
-    # Whether the dataset supports CUBE with GROUP BY.
+    # Whether the dataset supports CUBE with GROUP BY, false by default.
     def supports_group_cube?
       false
     end
 
-    # Whether the dataset supports ROLLUP with GROUP BY.
+    # Whether the dataset supports ROLLUP with GROUP BY, false by default.
     def supports_group_rollup?
       false
     end
 
-    # Whether the dataset supports GROUPING SETS with GROUP BY.
+    # Whether the dataset supports GROUPING SETS with GROUP BY, false by default.
     def supports_grouping_sets?
       false
     end
 
     # Whether this dataset supports the +insert_select+ method for returning all columns values
-    # directly from an insert query.
+    # directly from an insert query, false by default.
     def supports_insert_select?
       supports_returning?(:insert)
     end
@@ -95,33 +94,34 @@ module Sequel
       true
     end
 
-    # Whether the dataset supports the IS TRUE syntax.
+    # Whether the dataset supports the IS TRUE syntax, true by default.
     def supports_is_true?
       true
     end
     
-    # Whether the dataset supports the JOIN table USING (column1, ...) syntax.
+    # Whether the dataset supports the JOIN table USING (column1, ...) syntax, true by default.
+    # If false, support is emulated using JOIN table ON (table.column1 = other_table.column1).
     def supports_join_using?
       true
     end
     
-    # Whether the dataset supports LATERAL for subqueries in the FROM or JOIN clauses.
+    # Whether the dataset supports LATERAL for subqueries in the FROM or JOIN clauses, false by default.
     def supports_lateral_subqueries?
       false
     end
 
-    # Whether limits are supported in correlated subqueries.  True by default.
+    # Whether limits are supported in correlated subqueries, true by default.
     def supports_limits_in_correlated_subqueries?
       true
     end
     
-    # Whether modifying joined datasets is supported.
+    # Whether modifying joined datasets is supported, false by default.
     def supports_modifying_joins?
       false
     end
     
     # Whether the IN/NOT IN operators support multiple columns when an
-    # array of values is given.
+    # array of values is given, true by default.
     def supports_multiple_column_in?
       true
     end
@@ -132,12 +132,12 @@ module Sequel
     end
 
     # Whether the dataset supports or can fully emulate the DISTINCT ON clause,
-    # including respecting the ORDER BY clause, false by default
+    # including respecting the ORDER BY clause, false by default.
     def supports_ordered_distinct_on?
       supports_distinct_on?
     end
     
-    # Whether the dataset supports pattern matching by regular expressions.
+    # Whether the dataset supports pattern matching by regular expressions, false by default.
     def supports_regexp?
       false
     end
@@ -147,39 +147,39 @@ module Sequel
       false
     end
 
-    # Whether the RETURNING clause is supported for the given type of query.
+    # Whether the RETURNING clause is supported for the given type of query, false by default.
     # +type+ can be :insert, :update, or :delete.
     def supports_returning?(type)
       false
     end
 
-    # Whether the dataset supports skipping locked rows when returning data.
+    # Whether the dataset supports skipping locked rows when returning data, false by default.
     def supports_skip_locked?
       false
     end
 
-    # Whether the database supports SELECT *, column FROM table
+    # Whether the database supports <tt>SELECT *, column FROM table</tt>, true by default.
     def supports_select_all_and_column?
       true
     end
 
-    # Whether the dataset supports timezones in literal timestamps
+    # Whether the dataset supports timezones in literal timestamps, false by default.
     def supports_timestamp_timezones?
       false
     end
     
-    # Whether the dataset supports fractional seconds in literal timestamps
+    # Whether the dataset supports fractional seconds in literal timestamps, true by default.
     def supports_timestamp_usecs?
       true
     end
     
-    # Whether the dataset supports window functions.
+    # Whether the dataset supports window functions, false by default.
     def supports_window_functions?
       false
     end
     
     # Whether the dataset supports WHERE TRUE (or WHERE 1 for databases that
-    # that use 1 for true).
+    # that use 1 for true), true by default.
     def supports_where_true?
       true
     end
@@ -187,12 +187,12 @@ module Sequel
     private
 
     # Whether insert(nil) or insert({}) must be emulated by
-    # using at least one value, false by default.
+    # using at least one value.
     def insert_supports_empty_values?
       true
     end
 
-    # Whether the database supports quoting function names, false by default.
+    # Whether the database supports quoting function names.
     def supports_quoted_function_names?
       false
     end

data/lib/sequel/dataset/graph.rb

@@ -13,19 +13,15 @@ module Sequel
     # unlike +set_graph_aliases+, which replaces the list (the equivalent
     # of +select_append+ when graphing).  See +set_graph_aliases+.
     #
-    #   DB[:table].add_graph_aliases(:some_alias=>[:table, :column])
+    #   DB[:table].add_graph_aliases(some_alias: [:table, :column])
     #   # SELECT ..., table.column AS some_alias
     def add_graph_aliases(graph_aliases)
       graph = opts[:graph]
-      unless (ga = opts[:graph_aliases]) || (graph && (ga = graph[:column_aliases])) # SEQUEL5: Remove graph_aliases support
+      unless (graph && (ga = graph[:column_aliases]))
         raise Error, "cannot call add_graph_aliases on a dataset that has not been called with graph or set_graph_aliases"
       end
       columns, graph_aliases = graph_alias_columns(graph_aliases)
-      if opts[:graph_aliases]
-        select_append(*columns).clone(:graph_aliases => Hash[ga].merge!(graph_aliases).freeze) # SEQUEL5: Remove
-      else
-        select_append(*columns).clone(:graph => Hash[graph].merge!(:column_aliases=>Hash[ga].merge!(graph_aliases).freeze).freeze)
-      end
+      select_append(*columns).clone(:graph => Hash[graph].merge!(:column_aliases=>Hash[ga].merge!(graph_aliases).freeze).freeze)
     end
 
     # Similar to Dataset#join_table, but uses unambiguous aliases for selected
@@ -64,7 +60,7 @@ module Sequel
       case dataset
       when Symbol
         # let alias be the same as the table name (sans any optional schema)
-        # unless alias explicitly given in the symbol using ___ notation
+        # unless alias explicitly given in the symbol using ___ notation and symbol splitting is enabled
         table_alias ||= split_symbol(table).compact.last
       when Dataset
         if dataset.simple_select_all?
@@ -118,8 +114,6 @@ module Sequel
 
       # Whether to include the table in the result set
       add_table = options[:select] == false ? false : true
-      # Whether to add the columns to the list of column aliases
-      add_columns = !ds.opts.include?(:graph_aliases) # SEQUEL5: Remove graph_aliases support
 
       if graph = opts[:graph]
         graph = graph.dup
@@ -146,27 +140,25 @@ module Sequel
         # All columns in the master table are never
         # aliased, but are not included if set_graph_aliases
         # has been used.
-        if add_columns
-          if (select = @opts[:select]) && !select.empty? && !(select.length == 1 && (select.first.is_a?(SQL::ColumnAll)))
-            select = select.map do |sel|
-              raise Error, "can't figure out alias to use for graphing for #{sel.inspect}" unless column = _hash_key_symbol(sel)
-              column_aliases[column] = [master, column]
-              if from_selfed
-                # Initial dataset was wrapped in subselect, selected all
-                # columns in the subselect, qualified by the subselect alias.
-                Sequel.qualify(qualifier, Sequel.identifier(column))
-              else
-                # Initial dataset not wrapped in subslect, just make
-                # sure columns are qualified in some way.
-                qualified_expression(sel, qualifier)
-              end
-            end
-          else
-            select = columns.map do |column|
-              column_aliases[column] = [master, column]
-              SQL::QualifiedIdentifier.new(qualifier, column)
+        if (select = @opts[:select]) && !select.empty? && !(select.length == 1 && (select.first.is_a?(SQL::ColumnAll)))
+          select = select.map do |sel|
+            raise Error, "can't figure out alias to use for graphing for #{sel.inspect}" unless column = _hash_key_symbol(sel)
+            column_aliases[column] = [master, column]
+            if from_selfed
+              # Initial dataset was wrapped in subselect, selected all
+              # columns in the subselect, qualified by the subselect alias.
+              Sequel.qualify(qualifier, Sequel.identifier(column))
+            else
+              # Initial dataset not wrapped in subslect, just make
+              # sure columns are qualified in some way.
+              qualified_expression(sel, qualifier)
             end
           end
+        else
+          select = columns.map do |column|
+            column_aliases[column] = [master, column]
+            SQL::QualifiedIdentifier.new(qualifier, column)
+          end
         end
       end
 
@@ -178,7 +170,7 @@ module Sequel
       table_aliases[table_alias] = add_table ? dataset : nil
 
       # Add the columns to the selection unless we are ignoring them
-      if add_table && add_columns
+      if add_table
         column_aliases = graph[:column_aliases]
         ca_num = graph[:column_alias_num]
         # Which columns to add to the result set
@@ -207,7 +199,7 @@ module Sequel
       end
       [:column_aliases, :table_aliases, :column_alias_num].each{|k| graph[k].freeze}
       ds = ds.clone(:graph=>graph.freeze)
-      add_columns ? ds.select(*select) : ds
+      ds.select(*select)
     end
 
     # This allows you to manually specify the graph aliases to use
@@ -217,42 +209,41 @@ module Sequel
     # graphed dataset, and must be used instead of +select+ whenever
     # graphing is used.
     #
-    # graph_aliases :: Should be a hash with keys being symbols of
-    #                  column aliases, and values being either symbols or arrays with one to three elements.
-    #                  If the value is a symbol, it is assumed to be the same as a one element
-    #                  array containing that symbol.
-    #                  The first element of the array should be the table alias symbol.
-    #                  The second should be the actual column name symbol.  If the array only
-    #                  has a single element the column name symbol will be assumed to be the
-    #                  same as the corresponding hash key. If the array
-    #                  has a third element, it is used as the value returned, instead of
-    #                  table_alias.column_name.
+    # graph_aliases should be a hash with keys being symbols of
+    # column aliases, and values being either symbols or arrays with one to three elements.
+    # If the value is a symbol, it is assumed to be the same as a one element
+    # array containing that symbol.
+    # The first element of the array should be the table alias symbol.
+    # The second should be the actual column name symbol.  If the array only
+    # has a single element the column name symbol will be assumed to be the
+    # same as the corresponding hash key. If the array
+    # has a third element, it is used as the value returned, instead of
+    # table_alias.column_name.
     #
-    #   DB[:artists].graph(:albums, :artist_id=>:id).
-    #     set_graph_aliases(:name=>:artists,
-    #                       :album_name=>[:albums, :name],
-    #                       :forty_two=>[:albums, :fourtwo, 42]).first
+    #   DB[:artists].graph(:albums, :artist_id: :id).
+    #     set_graph_aliases(name: :artists,
+    #                       album_name: [:albums, :name],
+    #                       forty_two: [:albums, :fourtwo, 42]).first
     #   # SELECT artists.name, albums.name AS album_name, 42 AS forty_two ...
     def set_graph_aliases(graph_aliases)
       columns, graph_aliases = graph_alias_columns(graph_aliases)
       if graph = opts[:graph]
         select(*columns).clone(:graph => Hash[graph].merge!(:column_aliases=>graph_aliases.freeze).freeze)
       else
-        Sequel::Deprecation.deprecate("Calling Dataset#set_graph_aliases before Dataset#graph", "Call Dataset#set_graph_aliases after Dataset#graph now")
-        select(*columns).clone(:graph_aliases=>graph_aliases.freeze) # SEQUEL5: Remove
+        raise Error, "cannot call #set_graph_aliases on an ungraphed dataset"
       end
     end
 
     # Remove the splitting of results into subhashes, and all metadata
     # related to the current graph (if any).
     def ungraphed
-      clone(:graph=>nil, :graph_aliases=>nil) # SEQUEL5: Remove :graph_aliases
+      clone(:graph=>nil)
     end
 
     private
 
     # Wrap the alias symbol in an SQL::Identifier if the identifier on which is based
-    # is an SQL::Identifier.  This works around cases where the alias symbol contains
+    # is an SQL::Identifier.  This works around cases where symbol splitting is enabled and the alias symbol contains
     # double embedded underscores which would be considered an implicit qualified identifier
     # if not wrapped in an SQL::Identifier.
     def qualifier_from_alias_symbol(aliaz, identifier)

data/lib/sequel/dataset/misc.rb

@@ -7,15 +7,6 @@ module Sequel
     # These methods don't fit cleanly into another section.
     # ---------------------
     
-    NOTIMPL_MSG = "This method must be overridden in Sequel adapters".freeze
-    Sequel::Deprecation.deprecate_constant(self, :NOTIMPL_MSG)
-    ARRAY_ACCESS_ERROR_MSG = 'You cannot call Dataset#[] with an integer or with no arguments.'.freeze
-    Sequel::Deprecation.deprecate_constant(self, :ARRAY_ACCESS_ERROR_MSG)
-    ARG_BLOCK_ERROR_MSG = 'Must use either an argument or a block, not both'.freeze
-    Sequel::Deprecation.deprecate_constant(self, :ARG_BLOCK_ERROR_MSG)
-    IMPORT_ERROR_MSG = 'Using Sequel::Dataset#import an empty column array is not allowed'.freeze
-    Sequel::Deprecation.deprecate_constant(self, :IMPORT_ERROR_MSG)
-    
     # The database related to this dataset.  This is the Database instance that
     # will execute all of this dataset's queries.
     attr_reader :db
@@ -33,9 +24,9 @@ module Sequel
     # the Database#dataset method return an instance of that subclass.
     def initialize(db)
       @db = db
-      @opts = {} # OPTS # SEQUEL5
+      @opts = OPTS
       @cache = {}
-      # freeze # SEQUEL5
+      freeze
     end
 
     # Define a hash value such that datasets with the same class, DB, and opts
@@ -55,30 +46,16 @@ module Sequel
       self == o
     end
 
-    # SEQUEL5: Remove other dup methods
-    # def dup
-    #   self
-    # end
-    if TRUE_FREEZE
-      # Similar to #clone, but returns an unfrozen clone if the receiver is frozen.
-      def dup
-        _clone(:freeze=>false)
-      end
-    else
-      # :nocov:
-      def dup
-        c = clone
-        c.instance_variable_set(:@opts, Hash[c.opts])
-        c
-      end
-      # :nocov:
+    # Return self, as datasets are always frozen.
+    def dup
+      self
     end
     
     # Yield a dataset for each server in the connection pool that is tied to that server.
     # Intended for use in sharded environments where all servers need to be modified
     # with the same data:
     #
-    #   DB[:configs].where(:key=>'setting').each_server{|ds| ds.update(:value=>'new_value')}
+    #   DB[:configs].where(key: 'setting').each_server{|ds| ds.update(value: 'new_value')}
     def each_server
       db.servers.each{|s| yield server(s)}
     end
@@ -101,12 +78,11 @@ module Sequel
     else
       # :nocov:
       def freeze # :nodoc:
-        @opts.freeze # SEQUEL5: remove
         self
       end
 
       def frozen?  # :nodoc:
-        @opts.frozen? # SEQUEL5: true
+        true
       end
       # :nocov:
     end
@@ -122,7 +98,7 @@ module Sequel
     #   DB[:table].first_source_alias
     #   # => :table
     #
-    #   DB[:table___t].first_source_alias
+    #   DB[Sequel[:table].as(:t)].first_source_alias
     #   # => :t
     def first_source_alias
       source = @opts[:from]
@@ -147,7 +123,7 @@ module Sequel
     #   DB[:table].first_source_table
     #   # => :table
     #
-    #   DB[:table___t].first_source_table
+    #   DB[Sequel[:table].as(:t)].first_source_table
     #   # => :table
     def first_source_table
       source = @opts[:from]
@@ -215,7 +191,7 @@ module Sequel
     # SQL identifier that represents the unqualified column for the given value.
     # The given value should be a Symbol, SQL::Identifier, SQL::QualifiedIdentifier,
     # or SQL::AliasedExpression containing one of those.  In other cases, this
-    # returns nil
+    # returns nil.
     def unqualified_column_for(v)
       unless v.is_a?(String)
         _unqualified_column_for(v)
@@ -299,12 +275,11 @@ module Sequel
     private
 
     # Check the cache for the given key, returning the value.
-    # Otherwise, yield to get the dataset, and if the current dataset
-    # is frozen, cache the dataset under the given key.
+    # Otherwise, yield to get the dataset and cache the dataset under the given key.
     def cached_dataset(key)
       unless ds = cache_get(key)
         ds = yield
-        cache_set(key, ds) if frozen? # SEQUEL5: Remove if frozen?
+        cache_set(key, ds)
       end
 
       ds