Tests and demo code for stored procedures with MyBatis

Author: jeffgbutler

src/test/java/org/apache/ibatis/submitted/sptests/CreateDB.sql

@@ -0,0 +1,42 @@
+drop procedure sptest.getnames if exists]
+drop procedure sptest.getname if exists]
+drop procedure sptest.adder if exists]
+drop table sptest.names if exists]
+drop schema sptest if exists]
+
+create schema sptest]
+
+create procedure sptest.adder(in addend1 integer, in addend2 integer, out theSum integer)
+begin atomic
+  set theSum = addend1 + addend2; 
+end]
+
+create table sptest.names (
+  id integer generated by default as identity not null,
+  first_name varchar(20),
+  last_name varchar(20),
+  primary key(id)
+)]
+
+insert into sptest.names (first_name, last_name) values('Fred', 'Flintstone')]
+insert into sptest.names (first_name, last_name) values('Wilma', 'Flintstone')]
+insert into sptest.names (first_name, last_name) values('Barney', 'Rubble')]
+insert into sptest.names (first_name, last_name) values('Betty', 'Rubble')]
+
+-- note that these create procedure statements will fail until hsqldb 2.0.1
+create procedure sptest.getname(in nameId integer)
+reads sql data
+dynamic result sets 1
+BEGIN ATOMIC
+  declare cur cursor for select * from sptest.names where id = nameId;
+  open cur;
+END]
+
+create procedure sptest.getnames(in lowestId int, out totalrows integer)
+reads sql data
+dynamic result sets 1
+BEGIN ATOMIC
+  declare cur cursor for select * from sptest.names where id >= lowestId;
+  select count(*) into totalrows from sptest.names where id >= lowestId;
+  open cur;
+END]

src/test/java/org/apache/ibatis/submitted/sptests/MapperConfig.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!DOCTYPE configuration
+    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
+    "http://mybatis.org/dtd/mybatis-3-config.dtd">
+<configuration>
+
+  <settings>
+    <setting name="cacheEnabled" value="true"/>
+    <setting name="lazyLoadingEnabled" value="false"/>
+    <setting name="multipleResultSetsEnabled" value="true"/>
+    <setting name="useColumnLabel" value="true"/>
+    <setting name="useGeneratedKeys" value="false"/>
+    <setting name="defaultExecutorType" value="SIMPLE"/>
+    <setting name="defaultStatementTimeout" value="25000"/>
+  </settings>
+
+  <environments default="development">
+    <environment id="development">
+      <transactionManager type="JDBC"/>
+      <dataSource type="UNPOOLED">
+        <property name="driver" value="org.hsqldb.jdbcDriver"/>
+        <property name="url" value="jdbc:hsqldb:mem:sptest"/>
+        <property name="username" value="sa"/>
+      </dataSource>
+    </environment>
+  </environments>
+
+  <mappers>
+    <mapper resource="org/apache/ibatis/submitted/sptests/SPMapper.xml" />
+  </mappers>
+
+</configuration>

src/test/java/org/apache/ibatis/submitted/sptests/Name.java

@@ -0,0 +1,25 @@
+package org.apache.ibatis.submitted.sptests;
+
+public class Name {
+    private Integer id;
+    private String firstName;
+    private String lastName;
+    public Integer getId() {
+        return id;
+    }
+    public void setId(Integer id) {
+        this.id = id;
+    }
+    public String getFirstName() {
+        return firstName;
+    }
+    public void setFirstName(String firstName) {
+        this.firstName = firstName;
+    }
+    public String getLastName() {
+        return lastName;
+    }
+    public void setLastName(String lastName) {
+        this.lastName = lastName;
+    }
+}

src/test/java/org/apache/ibatis/submitted/sptests/Parameter.java

@@ -0,0 +1,25 @@
+package org.apache.ibatis.submitted.sptests;
+
+public class Parameter {
+    private Integer addend1;
+    private Integer addend2;
+    private Integer sum;
+    public Integer getAddend1() {
+        return addend1;
+    }
+    public void setAddend1(Integer addend1) {
+        this.addend1 = addend1;
+    }
+    public Integer getAddend2() {
+        return addend2;
+    }
+    public void setAddend2(Integer addend2) {
+        this.addend2 = addend2;
+    }
+    public Integer getSum() {
+        return sum;
+    }
+    public void setSum(Integer sum) {
+        this.sum = sum;
+    }
+}

src/test/java/org/apache/ibatis/submitted/sptests/SPMapper.java

@@ -0,0 +1,11 @@
+package org.apache.ibatis.submitted.sptests;
+
+import java.util.List;
+import java.util.Map;
+
+public interface SPMapper {
+    Object adder(Parameter parameter);
+    void adder2(Parameter parameter);
+    Name getName(Integer id);
+    List<Name> getNames(Map<String, Object> parms);
+}

src/test/java/org/apache/ibatis/submitted/sptests/SPMapper.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
+<mapper namespace="org.apache.ibatis.submitted.sptests.SPMapper">
+  <resultMap type="org.apache.ibatis.submitted.sptests.Name" id="nameResult">
+    <result column="ID" property="id"/>
+    <result column="FIRST_NAME" property="firstName"/>
+    <result column="LAST_NAME" property="lastName"/>
+  </resultMap>
+
+  <!-- Important things for stored procedures:
+    1. Must set the statement type to CALLABLE
+    2. Must use the JDBC standard escape sequence for stored procedures:
+       {call xxx (parm1, parm2)}
+    3. Must set the MODE of all parameters (IN, OUT, INOUT)
+    4. All IN, OUT, and INOUT parameters must be a part of the
+       parameterType or parameterMap (discouraged).
+    5. resultType or resultMap (more typically) is only used if
+       the procedure returns a result set. IMPORTANT: Oracle ref
+       cursors are usually returned as parameters, NOT directly
+       from the stored proc.  So with ref cursors, resultMap
+       and/or resultType is usually not used.  
+   -->
+   
+  <select id="adder" parameterType="org.apache.ibatis.submitted.sptests.Parameter" statementType="CALLABLE">
+    {call sptest.adder(
+      #{addend1,jdbcType=INTEGER,mode=IN},
+      #{addend2,jdbcType=INTEGER,mode=IN},
+      #{sum,jdbcType=INTEGER,mode=OUT}
+    )}
+  </select>
+
+  <update id="adder2" parameterType="org.apache.ibatis.submitted.sptests.Parameter" statementType="CALLABLE">
+    {call sptest.adder(
+      #{addend1,jdbcType=INTEGER,mode=IN},
+      #{addend2,jdbcType=INTEGER,mode=IN},
+      #{sum,jdbcType=INTEGER,mode=OUT}
+    )}
+  </update>
+  
+  <select id="getName" parameterType="java.lang.Integer" statementType="CALLABLE"
+    resultMap="nameResult">
+    {call sptest.getname(
+      #{id,jdbcType=INTEGER,mode=IN})}
+  </select>
+
+  <select id="getNames" parameterType="java.util.Map" statementType="CALLABLE"
+    resultMap="nameResult">
+    {call sptest.getnames(
+      #{lowestId,jdbcType=INTEGER,mode=IN},
+      #{totalRows,jdbcType=INTEGER,mode=OUT})}
+  </select>
+</mapper>