sequel 3.21.0 → 3.41.0

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

@@ -0,0 +1,353 @@
+Sequel.require 'adapters/utils/emulate_offset_with_row_number'
+
+module Sequel
+  module DB2
+    @use_clob_as_blob = true
+
+    class << self
+      # Whether to use clob as the generic File type, true by default.
+      attr_accessor :use_clob_as_blob
+    end
+
+    module DatabaseMethods
+      AUTOINCREMENT = 'GENERATED ALWAYS AS IDENTITY'.freeze
+      NOT_NULL      = ' NOT NULL'.freeze
+      NULL          = ''.freeze
+
+      # DB2 always uses :db2 as it's database type
+      def database_type
+        :db2
+      end
+      
+      # Return the database version as a string.  Don't rely on this,
+      # it may return an integer in the future.
+      def db2_version
+        return @db2_version if @db2_version
+        @db2_version = metadata_dataset.with_sql("select service_level from sysibmadm.env_inst_info").first[:service_level]
+      end
+      alias_method :server_version, :db2_version
+
+      # Use SYSIBM.SYSCOLUMNS to get the information on the tables.
+      def schema_parse_table(table, opts = {})
+        m = output_identifier_meth(opts[:dataset])
+        im = input_identifier_meth(opts[:dataset])
+        metadata_dataset.with_sql("SELECT * FROM SYSIBM.SYSCOLUMNS WHERE TBNAME = #{literal(im.call(table))} ORDER BY COLNO").
+          collect do |column| 
+            column[:db_type]     = column.delete(:typename)
+            if column[:db_type]  == "DECIMAL"
+              column[:db_type] << "(#{column[:longlength]},#{column[:scale]})"
+            end
+            column[:allow_null]  = column.delete(:nulls) == 'Y'
+            column[:primary_key] = column.delete(:identity) == 'Y' || !column[:keyseq].nil?
+            column[:type]        = schema_column_type(column[:db_type])
+            [ m.call(column.delete(:name)), column]
+          end
+      end
+
+      # Use SYSCAT.TABLES to get the tables for the database
+      def tables
+        metadata_dataset.
+          with_sql("SELECT TABNAME FROM SYSCAT.TABLES WHERE TYPE='T' AND OWNER = #{literal(input_identifier_meth.call(opts[:user]))}").
+          all.map{|h| output_identifier_meth.call(h[:tabname]) }
+      end
+
+      # Use SYSCAT.TABLES to get the views for the database
+      def views
+        metadata_dataset.
+          with_sql("SELECT TABNAME FROM SYSCAT.TABLES WHERE TYPE='V' AND OWNER = #{literal(input_identifier_meth.call(opts[:user]))}").
+          all.map{|h| output_identifier_meth.call(h[:tabname]) }
+      end
+
+      # Use SYSCAT.INDEXES to get the indexes for the table
+      def indexes(table, opts = {})
+        m = output_identifier_meth
+        indexes = {}
+        metadata_dataset.
+         from(:syscat__indexes).
+         select(:indname, :uniquerule, :colnames).
+         where(:tabname=>input_identifier_meth.call(table), :system_required=>0).
+         each do |r|
+          indexes[m.call(r[:indname])] = {:unique=>(r[:uniquerule]=='U'), :columns=>r[:colnames][1..-1].split('+').map{|v| m.call(v)}}
+        end
+        indexes
+      end
+
+      private
+
+      # Handle DB2 specific alter table operations.
+      def alter_table_sql(table, op)
+        case op[:op]
+        when :add_column
+          if op[:primary_key] && op[:auto_increment] && op[:type] == Integer
+            [
+            "ALTER TABLE #{quote_schema_table(table)} ADD #{column_definition_sql(op.merge(:auto_increment=>false, :primary_key=>false, :default=>0, :null=>false))}",
+            "ALTER TABLE #{quote_schema_table(table)} ALTER COLUMN #{literal(op[:name])} DROP DEFAULT",
+            "ALTER TABLE #{quote_schema_table(table)} ALTER COLUMN #{literal(op[:name])} SET #{AUTOINCREMENT}"
+            ]
+          else
+            "ALTER TABLE #{quote_schema_table(table)} ADD #{column_definition_sql(op)}"
+          end
+        when :drop_column
+          "ALTER TABLE #{quote_schema_table(table)} DROP #{column_definition_sql(op)}"
+        when :rename_column       # renaming is only possible after db2 v9.7
+          "ALTER TABLE #{quote_schema_table(table)} RENAME COLUMN #{quote_identifier(op[:name])} TO #{quote_identifier(op[:new_name])}"
+        when :set_column_type
+          "ALTER TABLE #{quote_schema_table(table)} ALTER COLUMN #{quote_identifier(op[:name])} SET DATA TYPE #{type_literal(op)}"
+        when :set_column_default
+          "ALTER TABLE #{quote_schema_table(table)} ALTER COLUMN #{quote_identifier(op[:name])} SET DEFAULT #{literal(op[:default])}"
+        when :add_constraint
+          if op[:type] == :unique
+            sqls = op[:columns].map{|c| ["ALTER TABLE #{quote_schema_table(table)} ALTER COLUMN #{quote_identifier(c)} SET NOT NULL", reorg_sql(table)]}
+            sqls << super
+            sqls.flatten
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+
+      # DB2 uses an identity column for autoincrement.
+      def auto_increment_sql
+        AUTOINCREMENT
+      end
+
+      # Add null/not null SQL fragment to column creation SQL.
+      def column_definition_null_sql(sql, column)
+        null = column.fetch(:null, column[:allow_null]) 
+        null = false  if column[:primary_key]
+
+        sql << NOT_NULL if null == false
+        sql << NULL if null == true
+      end
+
+      # Supply columns with NOT NULL if they are part of a composite
+      # primary key or unique constraint
+      def column_list_sql(g)
+        ks = []
+        g.constraints.each{|c| ks = c[:columns] if [:primary_key, :unique].include?(c[:type])} 
+        g.columns.each{|c| c[:null] = false if ks.include?(c[:name]) }
+        super
+      end
+
+      # Insert data from the current table into the new table after
+      # creating the table, since it is not possible to do it in one step.
+      def create_table_as(name, sql, options)
+        super
+        from(name).insert(sql.is_a?(Dataset) ? sql : dataset.with_sql(sql))
+      end
+
+      # DB2 requires parens around the SELECT, and DEFINITION ONLY at the end.
+      def create_table_as_sql(name, sql, options)
+        "#{create_table_prefix_sql(name, options)} AS (#{sql}) DEFINITION ONLY"
+      end
+
+      # Here we use DGTT which has most backward compatibility, which uses
+      # DECLARE instead of CREATE. CGTT can only be used after version 9.7.
+      # http://www.ibm.com/developerworks/data/library/techarticle/dm-0912globaltemptable/
+      def create_table_prefix_sql(name, options)
+        if options[:temp]
+          "DECLARE GLOBAL TEMPORARY TABLE #{quote_identifier(name)}"
+        else
+          super
+        end
+      end
+
+      # DB2 has issues with quoted identifiers, so
+      # turn off database quoting by default.
+      def quote_identifiers_default
+        false
+      end
+
+      # DB2 uses RENAME TABLE to rename tables.
+      def rename_table_sql(name, new_name)
+        "RENAME TABLE #{quote_schema_table(name)} TO #{quote_schema_table(new_name)}"
+      end
+
+      # Run the REORG TABLE command for the table, necessary when
+      # the table has been altered.
+      def reorg(table)
+        synchronize(opts[:server]){|c| c.execute(reorg_sql(table))}
+      end
+
+      # The SQL to use for REORGing a table.
+      def reorg_sql(table)
+        "CALL ADMIN_CMD(#{literal("REORG TABLE #{table}")})"
+      end
+
+      # Treat clob as blob if use_clob_as_blob is true
+      def schema_column_type(db_type)
+        (::Sequel::DB2::use_clob_as_blob && db_type.downcase == 'clob') ? :blob : super
+      end
+
+      # We uses the clob type by default for Files.
+      # Note: if user select to use blob, then insert statement should use 
+      # use this for blob value:
+      #     cast(X'fffefdfcfbfa' as blob(2G))
+      def type_literal_generic_file(column)
+        ::Sequel::DB2::use_clob_as_blob ? :clob : :blob
+      end
+
+      # DB2 uses smallint to store booleans.
+      def type_literal_generic_trueclass(column)
+        :smallint
+      end
+      alias type_literal_generic_falseclass type_literal_generic_trueclass
+
+      # DB2 uses clob for text types.
+      def uses_clob_for_text?
+        true
+      end
+    end
+
+    module DatasetMethods
+      include EmulateOffsetWithRowNumber
+
+      PAREN_CLOSE = Dataset::PAREN_CLOSE
+      PAREN_OPEN = Dataset::PAREN_OPEN
+      BITWISE_METHOD_MAP = {:& =>:BITAND, :| => :BITOR, :^ => :BITXOR, :'B~'=>:BITNOT}
+      EMULATED_FUNCTION_MAP = {:char_length=>'length'.freeze}
+      BOOL_TRUE = '1'.freeze
+      BOOL_FALSE = '0'.freeze
+      CAST_STRING_OPEN = "RTRIM(CHAR(".freeze
+      CAST_STRING_CLOSE = "))".freeze
+      FETCH_FIRST_ROW_ONLY = " FETCH FIRST ROW ONLY".freeze
+      FETCH_FIRST = " FETCH FIRST ".freeze
+      ROWS_ONLY = " ROWS ONLY".freeze
+      EMPTY_FROM_TABLE = ' FROM "SYSIBM"."SYSDUMMY1"'.freeze
+
+      # DB2 casts strings using RTRIM and CHAR instead of VARCHAR.
+      def cast_sql_append(sql, expr, type)
+        if(type == String)
+          sql << CAST_STRING_OPEN
+          literal_append(sql, expr)
+          sql << CAST_STRING_CLOSE
+        else
+          super
+        end
+      end
+
+      # Handle DB2 specific LIKE and bitwise operator support, and
+      # emulate the extract method, which DB2 doesn't natively support.
+      def complex_expression_sql_append(sql, op, args)
+        case op
+        when :ILIKE
+          super(sql, :LIKE, [SQL::Function.new(:upper, args.at(0)), SQL::Function.new(:upper, args.at(1)) ])
+        when :"NOT ILIKE"
+          super(sql, :"NOT LIKE", [SQL::Function.new(:upper, args.at(0)), SQL::Function.new(:upper, args.at(1)) ])
+        when :&, :|, :^
+          # works with db2 v9.5 and after
+          op = BITWISE_METHOD_MAP[op]
+          sql << complex_expression_arg_pairs(args){|a, b| literal(SQL::Function.new(op, a, b))}
+        when :<<
+          sql << complex_expression_arg_pairs(args){|a, b| "(#{literal(a)} * POWER(2, #{literal(b)}))"}
+        when :>>
+          sql << complex_expression_arg_pairs(args){|a, b| "(#{literal(a)} / POWER(2, #{literal(b)}))"}
+        when :%
+          sql << complex_expression_arg_pairs(args){|a, b| "MOD(#{literal(a)}, #{literal(b)})"}
+        when :'B~'
+          literal_append(sql, SQL::Function.new(:BITNOT, *args))
+        when :extract
+          sql << args.at(0).to_s
+          sql << PAREN_OPEN
+          literal_append(sql, args.at(1))
+          sql << PAREN_CLOSE
+        else
+          super
+        end
+      end
+
+      # DB2 supports GROUP BY CUBE
+      def supports_group_cube?
+        true
+      end
+
+      # DB2 supports GROUP BY ROLLUP
+      def supports_group_rollup?
+        true
+      end
+
+      # DB2 does not support IS TRUE.
+      def supports_is_true?
+        false
+      end
+
+      # DB2 does not support multiple columns in IN.
+      def supports_multiple_column_in?
+        false
+      end
+
+      # DB2 only allows * in SELECT if it is the only thing being selected.
+      def supports_select_all_and_column?
+        false
+      end
+
+      # DB2 does not support fractional seconds in timestamps.
+      def supports_timestamp_usecs?
+        false
+      end
+
+      # DB2 supports window functions
+      def supports_window_functions?
+        true
+      end
+
+      # DB2 does not support WHERE 1.
+      def supports_where_true?
+        false
+      end
+
+      private
+
+      # DB2 needs the standard workaround to insert all default values into
+      # a table with more than one column.
+      def insert_supports_empty_values?
+        false
+      end
+
+      # Use 0 for false on DB2
+      def literal_false
+        BOOL_FALSE
+      end
+
+      # Use 1 for true on DB2
+      def literal_true
+        BOOL_TRUE
+      end
+
+      # Add a fallback table for empty from situation
+      def select_from_sql(sql)
+        @opts[:from] ? super : (sql << EMPTY_FROM_TABLE)
+      end
+
+      # Modify the sql to limit the number of rows returned
+      # Note: 
+      #
+      #     After db2 v9.7, MySQL flavored "LIMIT X OFFSET Y" can be enabled using
+      #
+      #     db2set DB2_COMPATIBILITY_VECTOR=MYSQL
+      #     db2stop
+      #     db2start
+      #
+      #     Support for this feature is not used in this adapter however.
+      def select_limit_sql(sql)
+        if l = @opts[:limit]
+          if l == 1
+            sql << FETCH_FIRST_ROW_ONLY
+          else
+            sql << FETCH_FIRST
+            literal_append(sql, l)
+            sql << ROWS_ONLY
+          end
+        end
+      end
+      
+      def _truncate_sql(table)
+        # "TRUNCATE #{table} IMMEDIATE" is only for newer version of db2, so we
+        # use the following one
+        "ALTER TABLE #{quote_schema_table(table)} ACTIVATE NOT LOGGED INITIALLY WITH EMPTY TABLE"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,231 @@
+module Sequel
+  module Firebird
+    module DatabaseMethods
+      AUTO_INCREMENT = ''.freeze
+      TEMPORARY = 'GLOBAL TEMPORARY '.freeze
+
+      def clear_primary_key(*tables)
+        tables.each{|t| @primary_keys.delete(dataset.send(:input_identifier, t))}
+      end
+
+      def create_trigger(*args)
+        self << create_trigger_sql(*args)
+      end
+
+      def database_type
+        :firebird
+      end
+
+      def drop_sequence(name)
+        self << drop_sequence_sql(name)
+      end
+
+      # Return primary key for the given table.
+      def primary_key(table)
+        t = dataset.send(:input_identifier, table)
+        @primary_keys.fetch(t) do
+          pk = fetch("SELECT RDB$FIELD_NAME FROM RDB$INDEX_SEGMENTS NATURAL JOIN RDB$RELATION_CONSTRAINTS WHERE RDB$CONSTRAINT_TYPE = 'PRIMARY KEY' AND RDB$RELATION_NAME = ?", t).single_value
+          @primary_keys[t] = dataset.send(:output_identifier, pk.rstrip) if pk
+        end
+      end
+
+      def restart_sequence(*args)
+        self << restart_sequence_sql(*args)
+      end
+
+      def sequences(opts={})
+        ds = self[:"rdb$generators"].server(opts[:server]).filter(:"rdb$system_flag" => 0).select(:"rdb$generator_name")
+        block_given? ? yield(ds) : ds.map{|r| ds.send(:output_identifier, r[:"rdb$generator_name"])}
+      end
+
+      def tables(opts={})
+        tables_or_views(0, opts)
+      end
+
+      def views(opts={})
+        tables_or_views(1, opts)
+      end
+
+      private
+
+      # Use Firebird specific syntax for add column
+      def alter_table_sql(table, op)
+        case op[:op]
+        when :add_column
+          "ALTER TABLE #{quote_schema_table(table)} ADD #{column_definition_sql(op)}"
+        when :drop_column
+          "ALTER TABLE #{quote_schema_table(table)} DROP #{column_definition_sql(op)}"
+        when :rename_column
+          "ALTER TABLE #{quote_schema_table(table)} ALTER #{quote_identifier(op[:name])} TO #{quote_identifier(op[:new_name])}"
+        when :set_column_type
+          "ALTER TABLE #{quote_schema_table(table)} ALTER #{quote_identifier(op[:name])} TYPE #{type_literal(op)}"
+        else
+          super(table, op)
+        end
+      end
+
+      def auto_increment_sql()
+        AUTO_INCREMENT
+      end
+      
+      def create_sequence_sql(name, opts={})
+        "CREATE SEQUENCE #{quote_identifier(name)}"
+      end
+
+      # Firebird gets an override because of the mess of creating a
+      # sequence and trigger for auto-incrementing primary keys.
+      def create_table_from_generator(name, generator, options)
+        drop_statement, create_statements = create_table_sql_list(name, generator, options)
+        (execute_ddl(drop_statement) rescue nil) if drop_statement
+        create_statements.each{|sql| execute_ddl(sql)}
+      end
+
+      def create_table_sql_list(name, generator, options={})
+        statements = [create_table_sql(name, generator, options)]
+        drop_seq_statement = nil
+        generator.columns.each do |c|
+          if c[:auto_increment]
+            c[:sequence_name] ||= "seq_#{name}_#{c[:name]}"
+            unless c[:create_sequence] == false
+              drop_seq_statement = drop_sequence_sql(c[:sequence_name])
+              statements << create_sequence_sql(c[:sequence_name])
+              statements << restart_sequence_sql(c[:sequence_name], {:restart_position => c[:sequence_start_position]}) if c[:sequence_start_position]
+            end
+            unless c[:create_trigger] == false
+              c[:trigger_name] ||= "BI_#{name}_#{c[:name]}"
+              c[:quoted_name] = quote_identifier(c[:name])
+              trigger_definition = <<-END
+              begin
+                if ((new.#{c[:quoted_name]} is null) or (new.#{c[:quoted_name]} = 0)) then
+                begin
+                  new.#{c[:quoted_name]} = next value for #{c[:sequence_name]};
+                end
+              end
+              END
+              statements << create_trigger_sql(name, c[:trigger_name], trigger_definition, {:events => [:insert]})
+            end
+          end
+        end
+        [drop_seq_statement, statements]
+      end
+
+      def create_trigger_sql(table, name, definition, opts={})
+        events = opts[:events] ? Array(opts[:events]) : [:insert, :update, :delete]
+        whence = opts[:after] ? 'AFTER' : 'BEFORE'
+        inactive = opts[:inactive] ? 'INACTIVE' : 'ACTIVE'
+        position = opts.fetch(:position, 0)
+        sql = <<-end_sql
+          CREATE TRIGGER #{quote_identifier(name)} for #{quote_identifier(table)}
+          #{inactive} #{whence} #{events.map{|e| e.to_s.upcase}.join(' OR ')} position #{position}
+          as #{definition}
+        end_sql
+        sql
+      end
+      
+      def drop_sequence_sql(name)
+        "DROP SEQUENCE #{quote_identifier(name)}"
+      end
+
+      def remove_cached_schema(table)
+        clear_primary_key(table)
+        super
+      end
+
+      def restart_sequence_sql(name, opts={})
+        seq_name = quote_identifier(name)
+        "ALTER SEQUENCE #{seq_name} RESTART WITH #{opts[:restart_position]}"
+      end
+
+      def tables_or_views(type, opts)
+        ds = self[:"rdb$relations"].server(opts[:server]).filter(:"rdb$relation_type" => type, Sequel::SQL::Function.new(:COALESCE, :"rdb$system_flag", 0) => 0).select(:"rdb$relation_name")
+        ds.map{|r| ds.send(:output_identifier, r[:"rdb$relation_name"].rstrip)}
+      end
+
+      def type_literal_generic_string(column)
+        column[:text] ? :"BLOB SUB_TYPE TEXT" : super
+      end
+    end
+
+    module DatasetMethods
+      BOOL_TRUE = '1'.freeze
+      BOOL_FALSE = '0'.freeze
+      NULL = LiteralString.new('NULL').freeze
+      SELECT_CLAUSE_METHODS = Dataset.clause_methods(:select, %w'with select distinct limit columns from join where group having compounds order')
+      INSERT_CLAUSE_METHODS = Dataset.clause_methods(:insert, %w'insert into columns values returning')
+      FIRST = " FIRST ".freeze
+      SKIP = " SKIP ".freeze
+      DEFAULT_FROM = " FROM RDB$DATABASE"
+      
+      # Insert given values into the database.
+      def insert(*values)
+        if @opts[:sql] || @opts[:returning]
+          super
+        else
+          returning(insert_pk).insert(*values){|r| return r.values.first}
+        end
+      end
+
+      # Insert a record returning the record inserted
+      def insert_select(*values)
+        returning.insert(*values){|r| return r}
+      end
+
+      def requires_sql_standard_datetimes?
+        true
+      end
+
+      def supports_insert_select?
+        true
+      end
+
+      # Firebird does not support INTERSECT or EXCEPT
+      def supports_intersect_except?
+        false
+      end
+
+      private
+
+      def insert_clause_methods
+        INSERT_CLAUSE_METHODS
+      end
+
+      def insert_pk(*values)
+        pk = db.primary_key(opts[:from].first)
+        pk ? Sequel::SQL::Identifier.new(pk) : NULL
+      end
+
+      def literal_false
+        BOOL_FALSE
+      end
+
+      def literal_true
+        BOOL_TRUE
+      end
+
+      # The order of clauses in the SELECT SQL statement
+      def select_clause_methods
+        SELECT_CLAUSE_METHODS
+      end
+      
+        # Use a default FROM table if the dataset does not contain a FROM table.
+        def select_from_sql(sql)
+          if @opts[:from]
+            super
+          else
+            sql << DEFAULT_FROM
+          end
+        end
+
+      def select_limit_sql(sql)
+        if l = @opts[:limit]
+          sql << FIRST
+          literal_append(sql, l)
+        end
+        if o = @opts[:offset]
+          sql << SKIP
+          literal_append(sql, o)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Sequel
+  module Informix
+    module DatabaseMethods
+      TEMPORARY = 'TEMP '.freeze
+
+      # Informix uses the :informix database type
+      def database_type
+        :informix
+      end
+
+      private
+
+      # Informix has issues with quoted identifiers, so
+      # turn off database quoting by default.
+      def quote_identifiers_default
+        false
+      end
+
+      # SQL fragment for showing a table is temporary
+      def temporary_table_sql
+        TEMPORARY
+      end
+    end
+    
+    module DatasetMethods
+      SELECT_CLAUSE_METHODS = Dataset.clause_methods(:select, %w'select limit distinct columns from join where having group compounds order')
+      FIRST = " FIRST ".freeze
+      SKIP = " SKIP ".freeze
+
+      private
+
+      # Informix does not support INTERSECT or EXCEPT
+      def supports_intersect_except?
+        false
+      end
+
+      def select_clause_methods
+        SELECT_CLAUSE_METHODS
+      end
+
+      def select_limit_sql(sql)
+        if o = @opts[:offset]
+          sql << SKIP
+          literal_append(sql, o)
+        end
+        if l = @opts[:limit]
+          sql << FIRST
+          literal_append(sql, l)
+        end
+      end
+    end
+  end
+end