循序渐进丨JDBC调用 MogDB 数据库存储过程返回ref_cursor的方法和注意事项

MogDB 数据库在处理存储过程的时候，有时候需要返回结果集，类型为ref_cursor，但有时候可能会报错，而大部分应用程序都是使用Java JDBC。

我们根据这几年的数据库国产化改造经验，通过本文给大家分享一下JDBC调用 MogDB 存储过程返回ref_cursor的方法和注意事项。

01

创建测试用存储过程

该存储过程有两个OUT参数，其中一个返回结果集(sys_refcursor)，返回的行数根据第一个参数的长度而定，接下来看看代码：

create or replace procedure test_proc_return_cursor(a varchar,mycur OUT sys_refcursor, total_rows OUT int)
as
begin
total_rows :=length(a);
open mycur for 'select substr(x,1,id),id from (select x,generate_series(1,length(x)) as id from (select :a as x))' using a;
end;

02

创建Java测试代码

import java.sql.*;

public class TestReturnCursor {
    public static void main(String[] args) throws SQLException, ClassNotFoundException {
        TestReturnCursor test = new TestReturnCursor();
        test.runTest();
    }

   private void runTest() throws SQLException, ClassNotFoundException {
       Class.forName("org.opengauss.Driver");
# 此处替换成准确的ip/port/user/password
       Connection conn = DriverManager.getConnection("jdbc:opengauss://192.168.56.110:26000/postgres?loggerLevel=off","testproc","Test@123");
       conn.setAutoCommit(false);
       CallableStatement cs = (conn.prepareCall ("{call " + "test_proc_return_cursor(?,?,?)}")) ;
        cs.setString(1,"Test return ref_cursor");
        cs.registerOutParameter(2,Types.REF_CURSOR);
        cs.registerOutParameter(3,Types.INTEGER);

        cs.execute();

        ResultSet rs=(ResultSet)(cs.getObject(2));
        System.out.println("Total rows:"+cs.getInt(3));

        while(rs.next()){
            System.out.println(rs.getInt(2)+" "+rs.getString(1));
        }
        rs.close();
        cs.close();
        conn.close();
    }
}

03

编译Java程序‍‍

准备好测试用例之后，接下来我们来编译一下：

javac *.java 
java -cp opengaussjdbc.jar:. TestReturnCursor

如下是编译执行的结果输出：

04

Connection对象不设置autocommit=false的情况分析

上述测试代码中，里面有个关键点，Connection对象的autocommit必须设置为false，否则会有如下报错：ERROR: cursor “<unnamed portal 1>” does not exist

原因是在产生ref_cursor的时候，如果没有设置autocommit为false，则内部自动提交，建立的ref_cursor对象在事务外不可见。

05

总结

1、registerOutParameter里，type可以设成Types.REF_CURSOR，也可以设成Types.OTHER；

2、获取结果集时，使用getObject()方法，并将其转换成ResultSet对象。注意CallableStatement.getResultSet()不是这个用途；

3、最关键的一点，Connection对象需要设置autocommit=false。

数据驱动，成就未来，云和恩墨，不负所托！

---

云和恩墨创立于2011年，是业界领先的“智能的数据技术提供商”。公司总部位于北京，在国内外35个地区设有本地办公室并开展业务。

云和恩墨以“数据驱动，成就未来”为使命，致力于将创新的数据技术产品和解决方案带给全球的企业和组织，帮助客户构建安全、高效、敏捷且经济的数据环境，持续增强客户在数据洞察和决策上的竞争优势，实现数据驱动的业务创新和升级发展。

自成立以来，云和恩墨专注于数据技术领域，根据不断变化的市场需求，创新研发了系列软件产品，涵盖数据库、数据库存储、数据库云管和数据智能分析等领域。这些产品已经在集团型、大中型、高成长型客户以及行业云场景中得到广泛应用，证明了我们的技术和商业竞争力，展现了公司在数据技术端到端解决方案方面的优势。

在云化、数字化和智能化的时代背景下，云和恩墨始终以正和多赢为目标，感恩每一位客户和合作伙伴的信任与支持，“利他先行”，坚持投入于数据技术核心能力，为构建数据驱动的智能未来而不懈努力。

我们期待与您携手，共同探索数据力量，迎接智能未来。