sequel 4.5.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab0c1f081253f4b43e1a46f2132e9b516e2a67ba
-  data.tar.gz: e6b2cd60d962bb23d4b6b03a5a1ef33f81762bd0
+  metadata.gz: 4da9d52fb246c1f0e83b88184dd82d4bf7b609cd
+  data.tar.gz: 041e624b4f998ebc9835898be941fadc12fda8c4
 SHA512:
-  metadata.gz: d31e482c17d09830fc9895d61d3b9bc3f1bc527fe8939ea7856c98ce4b077ad842e73f8e7982708276898e6353b769fe281bdbb8becd82863b3f8e5e6c58fd7a
-  data.tar.gz: 4c9791b19cab0084aead4cf4a57a5c822d937ad449208c5f10d4b64a8cc7f89c0effd799b1761f540fd1778fd4d8c399034d716dabd3141b6aae1551062df8ac
+  metadata.gz: d965c77370235e2ceee16aca1e1193b01d2eb259b179307a51f8218778dda40c4fb35cea667568ce7cfa4d5f95297396a2876ae744d3638d359b81dfa63a019a
+  data.tar.gz: 052c8d3db3bd66279b50cf455e6928eb9e753e49f273399f85d5d0e2fe238ecc33c97a1a95d1b56f5bca9cb670c1fedb9eeb95fdb68232ac032647eb370b7992

data/CHANGELOG

@@ -1,3 +1,17 @@
+=== 4.6.0 (2014-01-02)
+
+* Add Database#call_mssql_sproc on MSSQL for calling stored procedures and handling output parameters (jrgns, jeremyevans) (#748)
+
+* Handle RuntimeErrors raised by oci8 in the oracle adapter (jeremyevans)
+
+* Support OFFSET/FETCH on Microsoft SQL Server 2012 (jeremyevans)
+
+* Support :server option for Database#{commit,rollback}_prepared_transaction on PostgreSQL, MySQL, and H2 (jeremyevans) (#743)
+
+* Do not attempt to eager load and raise an exception when doing Model.eager(...).naked.all (jeremyevans)
+
+* Recognize a couple additional disconnect errors in the jdbc/postgresql adapter (jeremyevans) (#742)
+
 === 4.5.0 (2013-12-02)
 
 * Support :on_commit=>(:drop|:delete_rows|:preserve_rows) options when creating temp tables on PostgreSQL (rosenfeld) (#737)

data/README.rdoc

@@ -19,7 +19,6 @@ toolkit for Ruby.
 == Resources
 
 * {Website}[http://sequel.jeremyevans.net]
-* {Blog}[http://sequel.heroku.com]
 * {Source code}[http://github.com/jeremyevans/sequel]
 * {Bug tracking}[http://github.com/jeremyevans/sequel/issues]
 * {Google group}[http://groups.google.com/group/sequel-talk]

data/doc/mssql_stored_procedures.rdoc

@@ -0,0 +1,43 @@
+= Stored Procedures in MSSQL
+
+This guide documents the workaround implemented to allow executing stored procedures
+in MSSQL, as well as getting the value of output variables.
+
+== Simple Execution
+
+The following stored procedure is used as an example:
+
+  CREATE PROCEDURE dbo.SequelTest(
+    @Input varchar(25),
+    @Output int OUTPUT
+  )
+  AS
+    SET @Output = LEN(@Input)
+    RETURN 0
+
+Execute it as follows:
+
+  DB.call_mssql_sproc(:SequelTest, {:args => ['Input String', :output]})
+
+Use the +:output+ symbol to denote an output variable. The result will contain a
+hash of the output variables, as well as the result code and number of affected rows:
+
+  {:result => 0, :numrows => 1, :var1 => "1"}
+
+Output variables will be strings by default. To specify their type, include the
+SQL type:
+
+  DB.call_mssql_sproc(:SequelTest, {:args => ['Input String', [:output, 'int']]})
+
+Result:
+
+  {:result => 0, :numrows => 1, :var1 => 1}
+
+Output variables will be named +var#{n}+ where n is their zero indexed position
+in the parameter list. To name the output variable, include their name:
+
+  DB.call_mssql_sproc(:SequelTest, {:args => ['Input String', [:output, nil, 'Output']]})
+
+Result:
+
+  {:result => 0, :numrows => 1, :output => "1"}

data/doc/release_notes/3.18.0.txt

@@ -52,9 +52,8 @@
   the graphviz dot program in order to create visualizations
   of the dataset's abstract syntax tree.  Examples:
 
-  * http://sequel.heroku.com/images/to_dot_simple.gif
-  * http://sequel.heroku.com/images/to_dot_complex.gif
-  * http://imgpaste.com/i/lxngy.gif
+  * http://sequel.jeremyevans.net/images/to_dot_simple.gif
+  * http://sequel.jeremyevans.net/images/to_dot_complex.gif
 
   Both the to_dot extension and reversible migrations support
   were inspired by Aaron Patterson's recent work on ActiveRecord

data/doc/release_notes/3.9.0.txt

@@ -230,4 +230,4 @@ Backwards Compatibility
 Other News
 ----------
 
-* Sequel now has an official blog at http://sequel.heroku.com.
+* Sequel now has an official blog at http://sequel.jeremyevans.net/blog.html.

data/doc/release_notes/4.6.0.txt

@@ -0,0 +1,30 @@
+= New Features
+
+* Database#call_mssql_sproc is now available for calling
+  stored procedures on Microsoft SQL Server, including the use
+  of output parameters.
+
+* The Database#{commit,rollback}_prepared_transaction methods now
+  support a :server option for the server on which to operate.
+
+= Other Improvements
+
+* On Microsoft SQL Server 2012, the native OFFSET/FETCH support
+  is now used for offsets, instead of emulating support via the
+  ROW_NUMBER window function.
+
+* Eager loading is now skipped when doing eager(...).naked.all on
+  a model dataset, instead of raising an error.  This can fix issues
+  when the eager_each plugin is used.
+
+* A couple additional disconnection errors are now detected in the
+  jdbc/postgresql adapter.
+
+* The tinytds adapter now handles returning rows when the fields
+  are not immediately available.
+
+* RuntimeErrors raised by oci8 are now handled correctly in the
+  oracle adapter.
+
+* Sequel's specs now work with RSpec 3, while still running
+  correctly on RSpec 1.3 and 2.

data/doc/security.rdoc

@@ -168,6 +168,13 @@ Instead, you should do:
 The Sequel::Dataset#lock_style method also treats an input string 
 as SQL code. This method should not be called with user input.
 
+==== SQL Type Names
+
+In general, most places where Sequel needs to use an SQL type that should
+be specified by the user, it allows you to use a ruby string, and that
+string is used verbatim as the SQL type.  You should not use user input
+for type strings.
+
 === SQL Identifier Injections
 
 Usually, Sequel treats ruby symbols as SQL identifiers, and ruby

data/lib/sequel/adapters/jdbc/h2.rb

@@ -9,8 +9,8 @@ module Sequel
       
         # Commit an existing prepared transaction with the given transaction
         # identifier string.
-        def commit_prepared_transaction(transaction_id)
-          run("COMMIT TRANSACTION #{transaction_id}")
+        def commit_prepared_transaction(transaction_id, opts=OPTS)
+          run("COMMIT TRANSACTION #{transaction_id}", opts)
         end
 
         # H2 uses the :h2 database type.
@@ -20,8 +20,8 @@ module Sequel
 
         # Rollback an existing prepared transaction with the given transaction
         # identifier string.
-        def rollback_prepared_transaction(transaction_id)
-          run("ROLLBACK TRANSACTION #{transaction_id}")
+        def rollback_prepared_transaction(transaction_id, opts=OPTS)
+          run("ROLLBACK TRANSACTION #{transaction_id}", opts)
         end
 
         # H2 uses an IDENTITY type

data/lib/sequel/adapters/jdbc/postgresql.rb

@@ -83,6 +83,10 @@ module Sequel
 
         private
         
+        def disconnect_error?(exception, opts)
+          super || exception.message =~ /\AThis connection has been closed\.\z|\AFATAL: terminating connection due to administrator command\z/
+        end
+
         # Use setNull for nil arguments as the default behavior of setString
         # with nil doesn't appear to work correctly on PostgreSQL.
         def set_ps_arg_nil(cps, i)

data/lib/sequel/adapters/oracle.rb

@@ -143,6 +143,7 @@ module Sequel
       end
 
       def database_specific_error_class(exception, opts)
+        return super unless exception.respond_to?(:code)
         case exception.code
         when 1400, 1407
           NotNullConstraintViolation

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

@@ -34,6 +34,51 @@ module Sequel
       # to :integer.
       DECIMAL_TYPE_RE = /number|numeric|decimal/io
 
+      # Execute the given stored procedure with the given name.
+      #
+      # Options:
+      # :args :: Array of arguments to stored procedure.  Output parameters to
+      #          the function are specified using :output.  You can also name
+      #          output parameters and provide a type by using an array containing
+      #          :output, the type name, and the parameter name.
+      # :server :: The server/shard on which to execute the procedure.
+      #
+      # Examples:
+      #
+      #     DB.call_mssql_sproc(:SequelTest, {:args => ['input arg', :output]})
+      #     DB.call_mssql_sproc(:SequelTest, {:args => ['input arg', [:output, 'int', 'varname']]})
+      def call_mssql_sproc(name, opts=OPTS)
+        args = opts[:args] || []
+        names = ['@RC AS RESULT', '@@ROWCOUNT AS NUMROWS']
+        declarations = ['@RC int']
+        values = []
+
+        args.each_with_index do |v, i|
+          if v.is_a?(Array)
+            v, type, select = v
+          else
+            type = select = nil
+          end
+
+          if v == :output
+            type = "nvarchar(max)" unless type
+            varname = "var#{i}" unless varname
+            select ||= varname
+            names << "@#{varname} AS #{quote_identifier(select)}"
+            declarations << "@#{varname} #{type}"
+            values << "@#{varname} OUTPUT"
+          else
+            values << literal(v)
+          end
+        end
+
+        sql = "DECLARE #{declarations.join(', ')}; EXECUTE @RC = #{name} #{values.join(', ')}; SELECT #{names.join(', ')}"
+
+        ds = dataset.with_sql(sql)
+        ds = ds.server(opts[:server]) if opts[:server]
+        ds.first
+      end
+
       # Microsoft SQL Server uses the :mssql type.
       def database_type
         :mssql
@@ -457,6 +502,10 @@ module Sequel
       FORMAT_DATE = "'%Y%m%d'".freeze
       CROSS_APPLY = 'CROSS APPLY'.freeze
       OUTER_APPLY = 'OUTER APPLY'.freeze
+      OFFSET = " OFFSET ".freeze
+      ROWS = " ROWS".freeze
+      ROWS_ONLY = " ROWS ONLY".freeze
+      FETCH_NEXT = " FETCH NEXT ".freeze
 
       Sequel::Dataset.def_mutation_method(:disable_insert_output, :output, :module=>self)
 
@@ -607,6 +656,18 @@ module Sequel
         sql << BRACKET_OPEN << name.to_s.gsub(/\]/, DOUBLE_BRACKET_CLOSE) << BRACKET_CLOSE
       end
       
+      # On MSSQL 2012+ add a default order to the current dataset if an offset is used.
+      # The default offset emulation using a subquery would be used in the unordered
+      # case by default, and that also adds a default order, so it's better to just
+      # avoid the subquery.
+      def select_sql
+        if @opts[:offset] && !@opts[:order] && is_2012_or_later?
+          order(1).select_sql
+        else
+          super
+        end
+      end
+
       # The version of the database server.
       def server_version
         db.server_version(@opts[:server])
@@ -703,6 +764,11 @@ module Sequel
         server_version >= 10000000
       end
 
+      # Whether we are using SQL Server 2012 or later.
+      def is_2012_or_later?
+        server_version >= 11000000
+      end
+
       # Use strict ISO-8601 format with T between date and time,
       # since that is the format that is multilanguage and not
       # DATEFORMAT dependent.
@@ -730,6 +796,11 @@ module Sequel
         end
       end
       alias update_from_sql delete_from2_sql
+
+      # Microsoft SQL Server 2012 has native support for offsets, but only for ordered datasets.
+      def emulate_offset_with_row_number?
+        super && !(is_2012_or_later? && @opts[:order])
+      end
       
       # Return the first primary key for the current table.  If this table has
       # multiple primary keys, this will only return one of them.  Used by #_import.
@@ -800,7 +871,8 @@ module Sequel
         BOOL_TRUE
       end
       
-      # MSSQL adds the limit before the columns
+      # MSSQL adds the limit before the columns, except on 2012+ when using
+      # offsets on ordered queries.
       def select_clause_methods
         SELECT_CLAUSE_METHODS
       end
@@ -816,6 +888,8 @@ module Sequel
       # to allow the limit to be a bound variable.
       def select_limit_sql(sql)
         if l = @opts[:limit]
+          return if is_2012_or_later? && @opts[:order] && @opts[:offset]
+
           if is_2005_or_later?
             sql << TOP_PAREN
             literal_append(sql, l)
@@ -840,6 +914,25 @@ module Sequel
         end
       end
 
+      # On 2012+ when there is an order with an offset, append the offset (and possible
+      # limit) at the end of the order clause.
+      def select_order_sql(sql)
+        super
+        if is_2012_or_later? && @opts[:order]
+          if o = @opts[:offset]
+            sql << OFFSET
+            literal_append(sql, o)
+            sql << ROWS
+
+            if l = @opts[:limit]
+              sql << FETCH_NEXT
+              literal_append(sql, l)
+              sql << ROWS_ONLY
+            end
+          end
+        end
+      end
+
       # SQL fragment for MSSQL's OUTPUT clause.
       def output_sql(sql)
         return unless supports_output_clause?

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

@@ -50,8 +50,8 @@ module Sequel
 
       # Commit an existing prepared transaction with the given transaction
       # identifier string.
-      def commit_prepared_transaction(transaction_id)
-        run("XA COMMIT #{literal(transaction_id)}")
+      def commit_prepared_transaction(transaction_id, opts=OPTS)
+        run("XA COMMIT #{literal(transaction_id)}", opts)
       end
 
       # MySQL uses the :mysql database type
@@ -112,8 +112,8 @@ module Sequel
 
       # Rollback an existing prepared transaction with the given transaction
       # identifier string.
-      def rollback_prepared_transaction(transaction_id)
-        run("XA ROLLBACK #{literal(transaction_id)}")
+      def rollback_prepared_transaction(transaction_id, opts=OPTS)
+        run("XA ROLLBACK #{literal(transaction_id)}", opts)
       end
 
       # Get version of MySQL server, used for determined capabilities.

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

@@ -156,8 +156,8 @@ module Sequel
 
       # Commit an existing prepared transaction with the given transaction
       # identifier string.
-      def commit_prepared_transaction(transaction_id)
-        run("COMMIT PREPARED #{literal(transaction_id)}")
+      def commit_prepared_transaction(transaction_id, opts=OPTS)
+        run("COMMIT PREPARED #{literal(transaction_id)}", opts)
       end
 
       # Creates the function in the database.  Arguments:
@@ -426,8 +426,8 @@ module Sequel
 
       # Rollback an existing prepared transaction with the given transaction
       # identifier string.
-      def rollback_prepared_transaction(transaction_id)
-        run("ROLLBACK PREPARED #{literal(transaction_id)}")
+      def rollback_prepared_transaction(transaction_id, opts=OPTS)
+        run("ROLLBACK PREPARED #{literal(transaction_id)}", opts)
       end
 
       # PostgreSQL uses SERIAL psuedo-type instead of AUTOINCREMENT for

data/lib/sequel/adapters/tinytds.rb

@@ -230,11 +230,29 @@ module Sequel
       # various cases.
       def fetch_rows(sql)
         execute(sql) do |result|
-          @columns = result.fields.map!{|c| output_identifier(c)}
-          if db.timezone == :utc
-            result.each(:timezone=>:utc){|r| yield r}
+          columns = result.fields.map!{|c| output_identifier(c)}
+          if columns.empty?
+            args = []
+            args << {:timezone=>:utc} if db.timezone == :utc
+            cols = nil
+            result.each(*args) do |r|
+              unless cols
+                cols = result.fields.map{|c| [c, output_identifier(c)]}
+                @columns = columns = cols.map{|c| c.last}
+              end
+              h = {}
+              cols.each do |s, sym|
+                h[sym] = r[s]
+              end
+              yield h
+            end
           else
-            result.each{|r| yield r}
+            @columns = columns
+            if db.timezone == :utc
+              result.each(:timezone=>:utc){|r| yield r}
+            else
+              result.each{|r| yield r}
+            end
           end
         end
         self

data/lib/sequel/adapters/utils/emulate_offset_with_row_number.rb

@@ -9,8 +9,9 @@ module Sequel
     # If offset is used, an order must be provided, because the use of ROW_NUMBER
     # requires an order.
     def select_sql
-      return super unless o = @opts[:offset]
+      return super unless emulate_offset_with_row_number?
 
+      offset = @opts[:offset]
       order = @opts[:order]
       if require_offset_order?
         order ||= default_offset_order
@@ -29,7 +30,7 @@ module Sequel
         from_self(:alias=>dsa1).
         select(*columns).
         limit(@opts[:limit]).
-        where(SQL::Identifier.new(rn) > o).
+        where(SQL::Identifier.new(rn) > offset).
         order(rn))
       sql
     end
@@ -46,5 +47,10 @@ module Sequel
     def require_offset_order?
       true
     end
+
+    # Whether to use ROW_NUMBER to emulate offsets
+    def emulate_offset_with_row_number?
+      @opts[:offset]
+    end
   end
 end