jdbc-helper 0.4.2 → 0.4.3

data/README.rdoc

@@ -85,6 +85,7 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
      else
          tx.rollback
      end
+     # You never reach here.
  end
 
 === Using batch interface
@@ -155,8 +156,8 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
   table.where(:c => 3).delete
 
   # Truncate or drop table (Cannot be undone)
-  table.truncate_table!
-  table.drop_table!
+  table.truncate!
+  table.drop!
 
 === Using function wrappers (since 0.2.2)
   conn.function(:mod).call 5, 3
@@ -166,58 +167,15 @@ Add JDBC driver of the DBMS you're willing to use to your CLASSPATH
   # Working with IN/INOUT/OUT parameteres
   # Bind by ordinal number
   conn.procedure(:update_and_fetch_something).call(
-		  100, ["value", String], Fixnum)
+		  100,                 # Input parameter 
+		  ["value", String],   # Input/Output parameter
+		  Fixnum               # Output parameter
+  )
 
   # Bind by parameter name
   conn.procedure(:update_and_fetch_something).call(
 		  :a => 100, :b => ["value", String], :c => Fixnum)
 
-== Notes on vendor-independence
-
-jdbc-helper tries to be a vendor-independent library, so that it behaves the same on any RDBMS,
-and that is why it's built on JDBC in the first place which can be used to minimize the amount of vendor-specific code.
-(Ideally, one codebase for all RDBMSs.)
-So far so good, but not great. It has small amount of code that is vendor-specific, non-standard JDBC.
-And it has been confirmed to work the same for both MySQL and Oracle, except for stored procedures.
-MySQL and Oracle implement parameter binding of CallableStatement differently.
-See the following example.
-  # Let's say we have a stored procedure named my_procedure
-  # which takes 3 parameters, param1, param2, and param3.
-
-  # Creates a CallableStatemet
-  cstmt = conn.prepare_call("{call my_procedure(?, ?, ?)}")
-
-  cstmt.call(10, "ten", Fixnum)
-    # OK for both MySQL and Oracle. Filling paramters sequentially.
-
-  cstmt.call(:param1 => 10, :param2 => "ten", :param3 => Fixnum)
-    # MySQL automatically binds values by the parameter names in the original procedure definition.
-    # Oracle fails to do so.
-  cstmt.close
-
-  # For Oracle, if you prepare as follows,
-  cstmt = conn.prepare_call("{call my_procedure(:p1, :p2, :p3)}")
-
-  # Then you can do this. 
-  cstmt.call(:p1 => 10, :p2 => "ten", :p3 => Fixnum)
-    # However, p1, p2, p3 have nothing to do with the original
-    # parameter names (param1, param2, param3) in the procedure definition.
-    # They're just aliases for ordinal positions.
-    # So, it's semantically different from the first example.
-
-  cstmt.close
-
-There's no way to find out the original parameter names and their ordinal positions without looking up the metadata of the database,
-which requires having to write vendor-specific code branches, and that is definitely not desirable.
-ProcedureWrapper prepares call with '?'s as the first example. 
-So it would work fine for MySQL, but you can't use it with parameter names on Oracle.
-
-  # Good for both
-  conn.procedure(:my_procedure).call(10, "ten", Fixnum)
-
-  # Only for MySQL
-  conn.procedure(:my_procedure).call(:param1 => 10, :param2 => "ten", :param3 => Fixnum)
-
 == Contributing to jdbc-helper
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/lib/jdbc-helper/connection/callable_statement.rb

@@ -41,8 +41,7 @@ private
 
 		out_params = {}
 		hash_params.each do | idx, value |
-			# Symbol need to be transformed into string
-
+			# Symbols need to be transformed into string
 			idx_ = idx.is_a?(Symbol) ? idx.to_s : idx
 			case value
 			# OUT parameter

data/lib/jdbc-helper/wrapper/procedure_wrapper.rb

@@ -5,7 +5,7 @@ module JDBCHelper
 # A wrapper object representing a database procedure.
 # @since 0.3.0
 # @example Usage
-#  conn.function(:coalesce).call(nil, nil, 'king')
+#  conn.procedure(:my_procedure).call(1, ["a", String], Fixnum)
 class ProcedureWrapper < ObjectWrapper
 	# Returns the name of the procedure
 	# @return [String]
@@ -14,15 +14,124 @@ class ProcedureWrapper < ObjectWrapper
 	# Executes the procedure and returns the values of INOUT & OUT parameters in Hash
 	# @return [Hash]
 	def call(*args)
-		param_count = args.first.kind_of?(Hash) ? args.first.keys.length : args.length
-
-		cstmt = @connection.prepare_call "{call #{name}(#{Array.new(param_count){'?'}.join ', '})}"
+		params = build_params args
+		cstmt = @connection.prepare_call "{call #{name}(#{Array.new(@cols.length){'?'}.join ', '})}"
 		begin
-			cstmt.call *args
+			process_result( args, cstmt.call(*params) )
 		ensure
 			cstmt.close
 		end
 	end
+
+	# Reloads procedure metadata. Metadata is cached for performance.
+	# However, if you have modified the procedure, you need to reload the
+	# metadata with this method.
+	# @return [JDBCHelper::ProcedureWrapper]
+	def refresh
+		@cols = @defaults = nil
+		self
+	end
+
+private
+	def metadata_lookup
+		return if @cols
+
+		procedure, package, schema = name.split('.').reverse
+		procedure_u, package_u, schema_u = name.upcase.split('.').reverse
+
+		# Alas, metadata lookup can be case-sensitive. e.g. Oracle
+		dbmd = @connection.java_obj.get_meta_data
+		lookups = 
+			if schema
+				[ 
+					lambda { dbmd.getProcedureColumns(package, schema, procedure, nil) },
+					lambda { dbmd.getProcedureColumns(package_u, schema_u, procedure_u, nil) } 
+				]
+			else
+				# schema or catalog? we don't know.
+				# - too inefficient for parameter-less procedures
+				[ lambda { dbmd.getProcedureColumns(nil, package, procedure, nil) },
+				  lambda { dbmd.getProcedureColumns(nil, package_u, procedure_u, nil) },
+				  lambda { dbmd.getProcedureColumns(package, nil, procedure, nil) },
+				  lambda { dbmd.getProcedureColumns(package_u, nil, procedure_u, nil) },
+				]
+			end
+
+		cols = []
+		@defaults = {}
+		lookups.each do |ld|
+			rset = ld.call
+			default_support = rset.get_meta_data.get_column_count >= 14
+			while rset.next
+				next if rset.getString("COLUMN_TYPE") == Java::JavaSql::DatabaseMetaData.procedureColumnReturn
+
+				cols << rset.getString("COLUMN_NAME").upcase
+				# TODO/NOT TESTED
+				# - MySQL doesn't support default values for procedure parameters
+				# - Oracle supports default values, however it does not provide
+				#   standard interface to query default values. COLUMN_DEF always returns null.
+				#   http://download.oracle.com/docs/cd/E11882_01/appdev.112/e13995/oracle/jdbc/OracleDatabaseMetaData.html#getProcedureColumns_java_lang_String__java_lang_String__java_lang_String__java_lang_String_
+				if default_support && (default = rset.getString("COLUMN_DEF"))
+					@defaults[cols.length - 1] << default
+				end
+			end
+			unless cols.empty?
+				@cols = cols
+				break
+			end
+		end
+		@cols ||= []
+	end
+
+	def build_params args
+		metadata_lookup
+
+		params = []
+		# Array
+		unless args.first.kind_of?(Hash)
+			if args.length < @cols.length
+				# Fill the Array with default values
+				@cols.length.times do |idx|
+					if @defaults[idx]
+						params << @defaults[idx]
+					else
+						params << args[idx]
+					end
+				end
+			else
+				params = args
+			end
+
+		# Hash
+		else
+			raise ArgumentError.new("More than one Hash given") if args.length > 1
+
+			# Set to default,
+			@defaults.each do |idx, v|
+				params[idx] = v
+			end
+
+			# then override
+			args.first.each do |k, v|
+				idx = @cols.index k.to_s.upcase
+				params[idx] = v
+			end
+		end
+
+		return params
+	end
+
+	def process_result args, result
+		input = args.first
+		return result unless input.kind_of? Hash
+
+		final = {}
+		result.each do |idx, ret|
+			key = input.keys.find { |key| key.to_s.upcase == @cols[idx - 1] }
+			final[key] = ret
+		end
+		final
+	end
 end#ProcedureWrapper
 end#JDBCHelper
 

data/test/database.yml

@@ -2,12 +2,21 @@
 mysql:
     driver: com.mysql.jdbc.Driver
     url: jdbc:mysql://localhost/test
+    database: test
     user: root
     password:
 
+#oracle:
+    #driver: oracle.jdbc.driver.OracleDriver
+    #url: jdbc:oracle:thin:@localhost/svc
+    #database: test
+    #user: testuser
+    #password: testpassword
+
 oracle:
     driver: oracle.jdbc.driver.OracleDriver
     url: jdbc:oracle:thin:@10.20.253.105/didev
+    database: wisefn
     user: wisefn
     password: wisefndb
-
+    timeout: 5

data/test/database.yml.org

@@ -0,0 +1,17 @@
+---
+mysql:
+    driver: com.mysql.jdbc.Driver
+    url: jdbc:mysql://localhost/test
+    database: test
+    user: root
+    password:
+    timeout: 5
+
+oracle:
+    driver: oracle.jdbc.driver.OracleDriver
+    url: jdbc:oracle:thin:@10.20.253.105/didev
+    database: wisefn
+    user: wisefn
+    password: wisefndb
+    timeout: 5
+

data/test/helper.rb

@@ -22,26 +22,48 @@ module JDBCHelperTestHelper
 		@db_config ||= YAML.load File.read(File.dirname(__FILE__) + '/database.yml')
 	end
 
+	def create_test_procedure_simple conn, name
+		case @type
+		when :mysql
+			conn.update "drop procedure #{name}" rescue nil
+			conn.update("
+				create procedure #{name}()
+				select 1 from dual where 1 != 0")
+		when :oracle
+			conn.update "drop procedure #{name}" rescue nil
+			conn.update "
+				create or replace
+				procedure #{name} as
+				begin
+					null;
+				end;"
+		else
+			raise NotImplementedError.new "Procedure test not implemented for #{@type}"
+		end
+	end
+
 	def create_test_procedure conn, name
 		case @type
 		when :mysql
 			conn.update "drop procedure #{name}" rescue nil
 			conn.update("
 				create procedure #{name} 
-				(IN i1 varchar(100), IN i2 int, 
+				(IN i1 varchar(100), IN i2 int,
 				 INOUT io1 int, INOUT io2 timestamp,
+				 IN n1 int,
 				 OUT o1 float, OUT o2 varchar(100))
-				select io1 * 10, 0.1, i1 into io1, o1, o2 from dual")
+				select io1 * i2, 0.1, i1 into io1, o1, o2 from dual where n1 is null")
 		when :oracle
 			conn.update "drop procedure #{name}" rescue nil
 			conn.update "
 				create or replace
 				procedure #{name} 
-				(i1 in varchar2, i2 in int,
+				(i1 in varchar2, i2 in int default '1',
 				 io1 in out int, io2 in out date,
+				 n1 in int,
 				 o1 out float, o2 out varchar2) as
 				begin
-					  select io1 * 10, 0.1, i1 into io1, o1, o2 from dual;
+					  select io1 * i2, 0.1, i1 into io1, o1, o2 from dual where n1 is null;
 				end;"
 		else
 			raise NotImplementedError.new "Procedure test not implemented for #{@type}"
@@ -59,7 +81,7 @@ module JDBCHelperTestHelper
 
 	def each_connection(&block)
 		config.each do | db, conn_info |
-			conn = JDBCHelper::Connection.new(conn_info)
+			conn = JDBCHelper::Connection.new(conn_info.reject { |k,v| k == 'database'})
 			# Just for quick and dirty testing
 			@type = case conn_info['driver'] || conn_info[:driver]
 					when /mysql/i

data/test/test_connection.rb

@@ -71,7 +71,7 @@ class TestConnection < Test::Unit::TestCase
 	def test_connect_and_close
 		config.each do | db, conn_info_org |
 			4.times do | i |
-				conn_info = conn_info_org.dup
+				conn_info = conn_info_org.reject { |k,v| k == 'database' }
 
 				# With or without timeout parameter
 				conn_info['timeout'] = 60 if i % 2 == 1
@@ -305,22 +305,23 @@ class TestConnection < Test::Unit::TestCase
 			create_test_procedure conn, TEST_PROCEDURE
 
 			# Array parameter
-			cstmt_ord = conn.prepare_call "{call #{TEST_PROCEDURE}(?, ?, ?, ?, ?, ?)}"
-			result = cstmt_ord.call('hello', 10, [100, Fixnum], [Time.now, Time], Float, String)
+			cstmt_ord = conn.prepare_call "{call #{TEST_PROCEDURE}(?, ?, ?, ?, ?, ?, ?)}"
+			result = cstmt_ord.call('hello', 10, [100, Fixnum], [Time.now, Time], nil, Float, String)
 			assert_instance_of Hash, result
 			assert_equal 1000, result[3]
-			assert_equal 'hello', result[6]
+			assert_equal 'hello', result[7]
 
 			# Hash parameter
 			cstmt_name = conn.prepare_call(case @type
 						when :oracle
-							"{call #{TEST_PROCEDURE}(:i1, :i2, :io1, :io2, :o1, :o2)}"
+							"{call #{TEST_PROCEDURE}(:i1, :i2, :io1, :io2, :n1, :o1, :o2)}"
 						else
-							"{call #{TEST_PROCEDURE}(?, ?, ?, ?, ?, ?)}"
+							"{call #{TEST_PROCEDURE}(?, ?, ?, ?, ?, ?, ?)}"
 						end)
 			result = cstmt_name.call(
 				:i1 => 'hello', :i2 => 10,
 				:io1 => [100, Fixnum], 'io2' => [Time.now, Time], 
+				:n1 => nil,
 				:o1 => Float, 'o2' => String)
 			assert_instance_of Hash, result
 			assert_equal 1000, result[:io1]
@@ -340,29 +341,40 @@ class TestConnection < Test::Unit::TestCase
 				assert_raise(RuntimeError) { cstmt.call }
 			end
 
-			# pend('mysql raises data truncation error') do
+			# Data truncated for column 'io1' at row 2. WHY?
+			# http://www.herongyang.com/JDBC/MySQL-CallableStatement-INOUT-Parameters.html
 			if @type != :mysql
-				cstmt_ord = conn.prepare_call "{call #{TEST_PROCEDURE}(?, 10, ?, ?, ?, ?)}"
+				cstmt_ord = conn.prepare_call "{call #{TEST_PROCEDURE}('howdy', ?, ?, ?, ?, ?, ?)}"
 				cstmt_name = conn.prepare_call(case @type
 						when :oracle
-							"{call #{TEST_PROCEDURE}(:i1, 10, :io1, :io2, :o1, :o2)}"
+							"{call #{TEST_PROCEDURE}('howdy', :i2, :io1, :io2, :n1, :o1, :o2)}"
 						else
-							"{call #{TEST_PROCEDURE}(?, 10, ?, ?, ?, ?)}"
+							"{call #{TEST_PROCEDURE}('howdy', ?, ?, ?, ?, ?, ?)}"
 						end)
 				# Hash parameter
 				result = cstmt_name.call(
-					:i1 => 'hello',# :i2 => 10,
+					#:i1 => 'hello',
+					:i2 => 10,
 					:io1 => [100, Fixnum], 'io2' => [Time.now, Time], 
+					:n1 => nil,
 					:o1 => Float, 'o2' => String)
 				assert_instance_of Hash, result
 				assert_equal 1000, result[:io1]
-				assert_equal 'hello', result['o2']
+				assert_equal 'howdy', result['o2']
 
 				# Array parameter
-				result = cstmt_ord.call('hello', [100, Fixnum], [Time.now, Time], Float, String)
+				result = cstmt_ord.call(10, [100, Fixnum], [Time.now, Time], nil, Float, String)
 				assert_instance_of Hash, result
 				assert_equal 1000, result[2]
-				assert_equal 'hello', result[5]
+				assert_equal 'howdy', result[6]
+
+				# Close
+				[ cstmt_ord, cstmt_name ].each do | cstmt |
+					assert_equal false, cstmt.closed?
+					cstmt.close
+					assert_equal true, cstmt.closed?
+					assert_raise(RuntimeError) { cstmt.call }
+				end
 			end
 		end
 	end

data/test/test_object_wrapper.rb

@@ -99,25 +99,58 @@ class TestObjectWrapper < Test::Unit::TestCase
 	end
 
 	def test_procedure_wrapper
-		each_connection do |conn|
-			create_test_procedure conn, @procedure_name
+		each_connection do |conn, conn_info|
+			{ 
+				:proc => @procedure_name,
+				:db_proc => [conn_info['database'], @procedure_name].join('.')
+			}.each do |mode, prname|
+				create_test_procedure_simple conn, prname
+
+				pr = conn.procedure(prname)
+				pr.call # should be ok without any arguments
 
-			pr = conn.procedure(@procedure_name)
+				# Complex case
+				create_test_procedure conn, prname
+				pr.refresh
 
-			result = pr.call 'hello', 10, [100, Fixnum], [Time.now, Time], Float, String
-			assert_instance_of Hash, result
-			assert_equal 1000, result[3]
-			assert_equal 'hello', result[6]
+				result = pr.call 'hello', 10, [100, Fixnum], [Time.now, Time], nil, Float, String
+				assert_instance_of Hash, result
+				assert_equal 1000, result[3]
+				assert_equal 'hello', result[7]
 
-			if @type != :oracle
 				result = pr.call(
-					:i1 => 'hello', :i2 => 10,
-					:io1 => [100, Fixnum], 'io2' => [Time.now, Time], 
+					:io1 => [100, Fixnum],
+					'io2' => [Time.now, Time], 
+					:i2 => 10,
+					:i1 => 'hello',
 					:o1 => Float, 'o2' => String)
 				assert_instance_of Hash, result
 				assert_equal 1000, result[:io1]
 				assert_equal 'hello', result['o2']
-			end
+
+				# Test default values
+				# - MySQL does not support default values
+				# - Oracle JDBC does not fully implement getProcedureColumns
+				#   => Cannot get default values with standard interface => Pending
+				if @type != :mysql
+					pend("Not tested") do
+						result = pr.call(
+							:io1 => [100, Fixnum],
+							'io2' => [Time.now, Time], 
+							#:i2 => 10,
+							:i1 => 'hello',
+							:o1 => Float, 'o2' => String)
+						assert_instance_of Hash, result
+						assert_equal 100, result[:io1]
+						assert_equal 'hello', result['o2']
+
+						result = pr.call 'hello', [100, Fixnum], [Time.now, Time], nil, Float, String
+						assert_instance_of Hash, result
+						assert_equal 100, result[3]
+						assert_equal 'hello', result[7]
+					end
+				end
+			end#prname
 		end
 	end
 

metadata

@@ -2,7 +2,7 @@
 name: jdbc-helper
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors: 
   - Junegunn Choi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-04 00:00:00 +09:00
+date: 2011-06-06 00:00:00 +09:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -89,6 +89,7 @@ files:
   - LICENSE.txt
   - README.rdoc
   - test/database.yml
+  - test/database.yml.org
   - test/helper.rb
   - test/test_connection.rb
   - test/test_connectors.rb
@@ -128,6 +129,7 @@ specification_version: 3
 summary: A JDBC helper for JRuby/Database developers.
 test_files: 
   - test/database.yml
+  - test/database.yml.org
   - test/helper.rb
   - test/test_connection.rb
   - test/test_connectors.rb