ibm_db 1.0.1 → 1.0.2

data/CHANGES

@@ -1,5 +1,11 @@
 Change Log
 ==============
+2009/03/06 (IBM_DB adapter 1.0.2, driver 1.0.1) :
+  - Support for specifying connection timeout in adapter
+  - Fixed Bug [23317] --> Fixed assumption of id as the primary key while updation/insertion of lob fields
+  - Fixed Bug [23389] --> Provided proper exception handling.
+  - Fixed the insertion of incorrect value for lob objects in case of has_and_belongs_to_many associations.
+  
 2008/12/18 (IBM_DB adapter 1.0.1, driver 1.0.1) :
   - Support for datatype decfloat
   - Changes in installation process. Now user should set IBM_DB_INCLUDE env variable instead of IBM_DB_DIR

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006, 2007 IBM Corporation
+Copyright (c) 2006, 2007, 2008, 2009 IBM Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the "Software"),

data/README

@@ -1,5 +1,5 @@
 =====================================================================
-README for the IBM_DB Adapter (1.0.1) and Driver (1.0.1) (2008/12/18)
+README for the IBM_DB Adapter (1.0.2) and Driver (1.0.1) (2009/03/06)
 For ActiveRecord Version >= 1.15.5 (and Rails >= 1.2.5)
 =====================================================================
 

data/lib/active_record/connection_adapters/ibm_db_adapter.rb

@@ -1,7 +1,7 @@
 # +----------------------------------------------------------------------+
 # |  Licensed Materials - Property of IBM                                |
 # |                                                                      |
-# | (C) Copyright IBM Corporation 2006, 2007, 2008.                      |
+# | (C) Copyright IBM Corporation 2006, 2007, 2008, 2009                 |
 # +----------------------------------------------------------------------+
 # |  Authors: Antonio Cangiano <cangiano@ca.ibm.com>                     |
 # |         : Mario Ds Briggs  <mario.briggs@in.ibm.com>                 |
@@ -20,68 +20,73 @@ module ActiveRecord
     def handle_lobs()
       if connection.kind_of?(ConnectionAdapters::IBM_DBAdapter)
         # Checks that the insert or update had at least a BLOB, CLOB or XML field
-        if connection.sql =~ /BLOB\('(.*)'\)/i || 
-           connection.sql =~ /@@@IBMTEXT@@@/i || 
-           connection.sql =~ /@@@IBMXML@@@/i ||
-           connection.sql =~ /@@@IBMBINARY@@@/i 
-          update_query = "UPDATE #{self.class.table_name} SET ("
-          counter = 0
-          values = []
-          params = []
-          # Selects only binary, text and xml columns
-          self.class.columns.select{|col| col.type == :binary || 
-                                          col.type == :text || 
-                                          col.type == :xml}.each do |col|
-            # Adds the selected columns to the query
-            if counter == 0
-              update_query << "#{col.name}"
-            else
-              update_query << ",#{col.name}"
-            end
+        connection.sql.each do |clob_sql|
+          if clob_sql =~ /BLOB\('(.*)'\)/i || 
+             clob_sql =~ /@@@IBMTEXT@@@/i || 
+             clob_sql =~ /@@@IBMXML@@@/i ||
+             clob_sql =~ /@@@IBMBINARY@@@/i 
+            update_query = "UPDATE #{self.class.table_name} SET ("
+            counter = 0
+            values = []
+            params = []
+            # Selects only binary, text and xml columns
+            self.class.columns.select{|col| col.type == :binary || 
+                                            col.type == :text || 
+                                            col.type == :xml}.each do |col|
+              # Adds the selected columns to the query
+              if counter == 0
+                update_query << "#{col.name}"
+              else
+                update_query << ",#{col.name}"
+              end
 
-            # Add a '?' for the parameter or a NULL if the value is nil or empty 
-            # (except for a CLOB field where '' can be a value)
-            if self[col.name].nil? || 
-               self[col.name] == {} || 
-              (self[col.name] == '' && col.type != :text)
-              params << 'NULL'
+              # Add a '?' for the parameter or a NULL if the value is nil or empty 
+              # (except for a CLOB field where '' can be a value)
+              if self[col.name].nil? || 
+                 self[col.name] == {} || 
+                (self[col.name] == '' && col.type != :text)
+                params << 'NULL'
+              else
+                values << self[col.name]
+                params << '?'
+              end
+              counter += 1
+            end
+            # no subsequent update is required if no relevant columns are found
+            next if counter == 0
+
+            update_query << ") = "
+            # IBM_DB accepts 'SET (column) = NULL'  but not (NULL),
+            # therefore the sql needs to be changed for a single NULL field.
+            if params.size==1 && params[0] == 'NULL'
+              update_query << "NULL"
             else
-              values << self[col.name]
-              params << '?'
+              update_query << "(" + params.join(',') + ")"
             end
-            counter += 1
-          end
-          # no subsequent update is required if no relevant columns are found
-          return if counter == 0
-
-          update_query << ") = "
-          # IBM_DB accepts 'SET (column) = NULL'  but not (NULL),
-          # therefore the sql needs to be changed for a single NULL field.
-          if params.size==1 && params[0] == 'NULL'
-            update_query << "NULL"
-          else
-            update_query << "(" + params.join(',') + ")"
-          end
-          update_query << " WHERE #{self.class.primary_key} = #{id}"
+            
+            update_query << " WHERE #{self.class.primary_key} = '#{self[self.class.primary_key.downcase]}'"
+            
+            unless stmt = IBM_DB.prepare(connection.connection, update_query)
+              error_msg = IBM_DB.conn_errormsg 
+              error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
+              if error_msg && !error_msg.empty?
+                raise "Statement prepare for updating LOB/XML column failed : #{error_msg}"
+              else
+                raise StandardError.new('An unexpected error occurred during update of LOB/XML column')
+              end
+            end
+            connection.log_query(update_query,'update of LOB/XML field(s)in handle_lobs')
 
-          unless stmt = IBM_DB.prepare(connection.connection, update_query)
-            error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
-            if error_msg && !error_msg.empty?
-              raise "Failed to rename table due to error: #{error_msg}"
+            # rollback any failed LOB/XML field updates (and remove associated marker)
+            unless IBM_DB.execute(stmt, values)
+              connection.execute("ROLLBACK")
+              raise "Failed to insert/update LOB/XML field(s) due to: #{IBM_DB.stmt_errormsg(stmt)}"
             else
-              raise StandardError('Unexpected error during update')
+              IBM_DB.free_result stmt
             end
-          end
-          connection.log_query(update_query,'update of LOB/XML field(s)in handle_lobs')
-
-          # rollback any failed LOB/XML field updates (and remove associated marker)
-          unless IBM_DB.execute(stmt, values)
-            connection.execute("ROLLBACK")
-            raise "Failed to insert/update LOB/XML field(s) due to: #{IBM_DB.stmt_errormsg(stmt)}"
-          else
-            IBM_DB.free_result stmt
-          end
-        end # if connection.sql
+          end # if clob_sql
+        end #connection.sql.each
+        connection.sql = []
       end # if connection.kind_of?
     end # handle_lobs
     private :handle_lobs
@@ -112,8 +117,7 @@ module ActiveRecord
       # Retrieves database user credentials from the +config+ hash
       # or raises ArgumentError in case of failure.
       if !config.has_key?(:username) || !config.has_key?(:password)
-        raise ArgumentError, "Missing argument(s): Database configuration #{config} \
-requires credentials: username and password"
+        raise ArgumentError, "Missing argument(s): Username/Password for #{config[:database]} is not specified"
       else
         username = config[:username].to_s
         password = config[:password].to_s
@@ -149,7 +153,7 @@ requires credentials: username and password"
         host = config[:host]
         # A net address connection requires a port. If no port has been specified, 50000 is used by default
         port = config[:port] || 50000
-        # Connects to the database using the database, host, port, authentication type, username and password specified
+        # Connects to the database specified using the hostname, port, authentication type, username and password info
         # Starting with DB2 9.1FP5 secure connections using SSL are supported. 
         # On the client side using CLI this is supported from CLI version V95FP2 and onwards.
         # This feature is set by specifying SECURITY=SSL in the connection string.
@@ -163,6 +167,8 @@ requires credentials: username and password"
                        PWD=#{password};"
         conn_string << "SECURITY=#{config[:security]};" if config.has_key?(:security)
         conn_string << "AUTHENTICATION=#{config[:authentication]};" if config.has_key?(:authentication)
+        conn_string << "CONNECTTIMEOUT=#{config[:timeout]};" if config.has_key?(:timeout)
+        
         connection = IBM_DB.connect conn_string, '', '', conn_options
       else
         # No host implies a local catalog-based connection: +database+ represents catalog alias
@@ -176,7 +182,7 @@ requires credentials: username and password"
         ConnectionAdapters::IBM_DBAdapter.new(connection, logger, config, conn_options)
       else
         # If the connection failed, it raises a Runtime error
-        raise "Failed to connect to the [#{database}] due to: #{IBM_DB.conn_errormsg}"
+        raise "Failed to connect to [#{database}] due to: #{IBM_DB.conn_errormsg}"
       end
     end # method self.ibm_db_connection
   end # class Base
@@ -387,6 +393,8 @@ requires credentials: username and password"
     #                                    // - Available only from CLI version V95fp2 and above
     #   authentication:  'SERVER'        // AUTHENTICATION type which the client uses - 
     #                                    // - to connect to the database server. By default value is SERVER
+    #   timeout:         10              // Specifies the time in seconds (0 - 32767) to wait for a reply from server -
+    #                                    //- when trying to establish a connection before generating a timeout
     # 
     # When schema is not specified, the username value is used instead.
     # 
@@ -414,12 +422,15 @@ requires credentials: username and password"
         @schema           = config[:schema]
         @security         = config[:security] || nil
         @authentication   = config[:authentication] || nil
+        @timeout          = config[:timeout] || 0  # default timeout value is 0
         
         # Caching database connection options (auditing and billing support)
         @app_user         = conn_options[:app_user]     if conn_options.has_key?(:app_user)
         @account          = conn_options[:account]      if conn_options.has_key?(:account)
         @application      = conn_options[:application]  if conn_options.has_key?(:application)
         @workstation      = conn_options[:workstation]  if conn_options.has_key?(:workstation)
+        
+        @sql = []
 
         # Calls the parent class +ConnectionAdapters+' initializer
         # which sets @connection, @logger, @runtime and @last_verification
@@ -544,6 +555,7 @@ requires credentials: username and password"
                           PWD=#{@password};"
           @conn_string << "SECURITY=#{@security};" if @security
           @conn_string << "AUTHENTICATION=#{@authentication};" if @authentication
+          @conn_string << "CONNECTTIMEOUT=#{@timeout};"
           # Connects and assigns the resulting IBM_DB.Connection to the +@connection+ instance variable
           @connection = IBM_DB.connect(@conn_string, '', '', @conn_options)
         else
@@ -688,11 +700,12 @@ requires credentials: username and password"
     
         insert_query << " VALUES ("+ params.join(',') + ")"
         unless stmt = IBM_DB.prepare(@connection, insert_query)
-           error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+           error_msg = IBM_DB.conn_errormsg 
+           error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
            if error_msg && !error_msg.empty?
              raise "Failed to prepare statement due to : #{error_msg}"
            else
-             raise StandardError('Unexpected error during insert')
+             raise StandardError.new('An unexpected error occurred during insert')
            end
         end
     
@@ -712,7 +725,7 @@ requires credentials: username and password"
       def insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
         if stmt = execute(sql, name)
           begin
-            @sql = sql
+            @sql << sql
             return id_value || @servertype.last_generated_id(stmt)
             # Ensures to free the resources associated with the statement
           ensure
@@ -743,7 +756,7 @@ requires credentials: username and password"
         # Logs and execute the given sql query.
         if stmt = execute(sql, name)
           begin
-            @sql = sql
+            @sql << sql
             # Retrieves the number of affected rows
             IBM_DB.num_rows(stmt)
             # Ensures to free the resources associated with the statement
@@ -985,11 +998,12 @@ requires credentials: username and password"
             IBM_DB.free_result(stmt)  # Free resources associated with the statement
           end
         else # Handle driver execution errors
-          error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+          error_msg = IBM_DB.conn_errormsg 
+          error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
           if error_msg && !error_msg.empty?
             raise "Failed to retrieve tables metadata due to error: #{error_msg}"
           else
-            raise StandardError('Unexpected error during table metadata retrieval')
+            raise StandardError.new('An unexpected error occurred during retrieval of table metadata')
           end
         end
         # Returns the tables array
@@ -1032,11 +1046,12 @@ requires credentials: username and password"
             IBM_DB.free_result(stmt) if stmt
           end
         else  # Handle driver execution errors
-          error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+          error_msg = IBM_DB.conn_errormsg 
+          error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
           if error_msg && !error_msg.empty?
             raise "Failed to retrieve primary key metadata due to error: #{error_msg}"
           else
-            raise StandardError('Unexpected error during primary key retrieval')
+            raise StandardError.new('An unexpected error occurred during primary key retrieval')
           end
         end
         
@@ -1077,12 +1092,13 @@ requires credentials: username and password"
           IBM_DB.free_result(stmt) if stmt
         end
         else  # Handle driver execution errors
-            error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
-            if error_msg && !error_msg.empty?
-              raise "Failed to retrieve index metadata due to error: #{error_msg}"
-            else
-              raise StandardError('Unexpected error during index retrieval')
-            end
+          error_msg = IBM_DB.conn_errormsg 
+          error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
+          if error_msg && !error_msg.empty?
+            raise "Failed to retrieve index metadata due to error: #{error_msg}"
+          else
+            raise StandardError.new('An unexpected error occurred during index retrieval')
+          end
         end
     
         # remove the primary key index entry.... should not be dumped by the dumper
@@ -1153,21 +1169,23 @@ requires credentials: username and password"
               end
             end
           rescue StandardError  # Handle driver fetch errors
-            error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+            error_msg = IBM_DB.conn_errormsg 
+            error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
             if error_msg && !error_msg.empty?
               raise "Failed to retrieve column metadata during fetch: #{error_msg}"
             else
-              raise
+              raise "An unexpected error occurred during retrieval of metadata"
             end
           ensure  # Free resources associated with the statement
             IBM_DB.free_result(stmt)
           end
         else  # Handle driver execution errors
-          error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+          error_msg = IBM_DB.conn_errormsg 
+          error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
           if error_msg && !error_msg.empty?
             raise "Failed to retrieve column metadata due to error: #{error_msg}"
           else
-            raise StandardError('Unexpected error during columns metadata retrieval')
+            raise StandardError.new('An unexpected error occurred during retrieval of columns metadata')
           end
         end
         # Returns the columns array
@@ -1303,7 +1321,7 @@ requires credentials: username and password"
                   "A column that is part of a table containing an XML column cannot be dropped. \
 To remove the column, the table must be dropped and recreated without the #{column_name} column: #{exec_err}"
           else
-            raise
+            raise "#{exec_err}"
           end
         end
       end
@@ -1336,10 +1354,10 @@ To remove the column, the table must be dropped and recreated without the #{colu
             raise StatementInvalid, IBM_DB.stmt_errormsg
           end
         rescue StandardError
-          error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+          error_msg = IBM_DB.conn_errormsg
           if error_msg && !error_msg.empty?
-            raise "Failed to execute statement due to error: #{error_msg}"
-          else
+            raise "Failed to execute statement due to communication error: #{error_msg}"
+          else 
             raise
           end
         end
@@ -1405,11 +1423,12 @@ To remove the column, the table must be dropped and recreated without the #{colu
             IBM_DB.free_result stmt
           end
         else
-          error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+          error_msg = IBM_DB.conn_errormsg 
+          error_msg = IBM_DB.stmt_errormsg if error_msg.empty?
           if error_msg && !error_msg.empty?
             raise "Failed to retrieve last generated id due to error: #{error_msg}"
           else
-            raise StandardError('Unexpected error during last generated id retrieval')
+            raise StandardError.new('An unexpected error occurred during retrieval of last generated id')
           end
         end
       end
@@ -1424,7 +1443,7 @@ To remove the column, the table must be dropped and recreated without the #{colu
             "Please consult documentation for compatible data types while changing column datatype. \
 The column datatype change to [#{data_type}] is not supported by this data server: #{exec_err}"
           else
-            raise
+            raise "#{exec_err}"
           end
         end
         reorg_table(table_name)
@@ -1613,9 +1632,9 @@ SET WITH DEFAULT #{@adapter.quote(default)}"
               raise StatementInvalid, IBM_DB.stmt_errormsg
             end
           rescue StandardError
-            error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+            error_msg = IBM_DB.conn_errormsg
             if error_msg && !error_msg.empty?
-              raise "Failed to execute statement due to error: #{error_msg}"
+              raise "Failed to execute statement due to communication error: #{error_msg}"
             else
               raise
             end
@@ -1628,9 +1647,9 @@ SET WITH DEFAULT #{@adapter.quote(default)}"
               raise StatementInvalid, IBM_DB.stmt_errormsg
             end
           rescue StandardError
-            error_msg = IBM_DB.conn_errormsg ? IBM_DB.conn_errormsg : IBM_DB.stmt_errormsg
+            error_msg = IBM_DB.conn_errormsg
             if error_msg && !error_msg.empty?
-              raise "Failed to execute statement due to error: #{error_msg}"
+              raise "Failed to execute statement due to communication error: #{error_msg}"
             else
               raise
             end

data/test/cases/associations/has_and_belongs_to_many_associations_test.rb

@@ -78,6 +78,21 @@ class DeveloperWithCounterSQL < ActiveRecord::Base
     :counter_sql => 'SELECT COUNT(*) AS count_all FROM projects INNER JOIN developers_projects ON projects.id = developers_projects.project_id WHERE developers_projects.developer_id =#{id}'
 end
 
+if current_adapter?(:IBM_DBAdapter)
+  class Novel < ActiveRecord::Base
+    has_and_belongs_to_many :writers
+  end
+  
+  class Writer < ActiveRecord::Base
+    has_and_belongs_to_many :novels
+  end
+  
+  class NovelsWriter < ActiveRecord::Base
+    belongs_to :writers
+    belongs_to :novels
+  end
+end
+
 class HasAndBelongsToManyAssociationsTest < ActiveRecord::TestCase
   fixtures :accounts, :companies, :categories, :posts, :categories_posts, :developers, :projects, :developers_projects,
            :parrots, :pirates, :treasures, :price_estimates, :tags, :taggings
@@ -269,6 +284,39 @@ class HasAndBelongsToManyAssociationsTest < ActiveRecord::TestCase
     assert_equal Developer.find(1).projects.sort_by(&:id).last, proj  # prove join table is updated
   end
 
+  if current_adapter?(:IBM_DBAdapter)
+    def test_lob_handling
+      assert_nothing_raised do
+        Novel.connection.create_table 'novels' do |t|
+          t.text :story
+          t.string :title
+        end
+        Writer.connection.create_table 'writers' do |t|
+          t.string :name
+        end
+        NovelsWriter.connection.create_table 'novels_writers' do |t|
+          t.belongs_to :novels
+          t.belongs_to :writers
+        end
+      end
+    
+      w = Writer.new :name => 'Praveen'
+      w.save!
+    
+      novel_story = "This is a short and sweet story"
+    
+      novel = Novel.new :story => novel_story,:title => "Cool isn't it"
+      novel.writers << w
+      novel.save!
+    
+      assert_equal novel_story,Novel.find(novel.id).story
+    ensure
+      Novel.connection.drop_table 'novels' rescue nil
+      Writer.connection.drop_table 'writers' rescue nil
+      NovelsWriter.connection.drop_table 'novels_writers' rescue nil    
+    end  
+  end
+  
   def test_create_by_new_record
     devel = Developer.new(:name => "Marcel", :salary => 75000)
     proj1 = devel.projects.build(:name => "Make bed")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ibm_db
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - IBM
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-18 00:00:00 +05:30
+date: 2009-03-06 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency