Java: Passing Array to Oracle Stored Procedure

This tutorial guides us on how to pass Array objects from Java to stored procedures in Oracle and also, how to retrieve an array object in Java. All PLSQL arrays can not be called from java. An array needs to be created as TYPE, at SCHEMA level in the database and then it can be used with ArrayDescriptor in Java, as oracle.sql.ArrayDescriptor class in Java can not access at package level.

Database Code

First, Create an array, at SCHEMA level. An example is shown below:

CREATE TYPE array_table AS TABLE OF VARCHAR2 (50); -- Array of String CREATE TYPE array_int AS TABLE OF NUMBER; -- Array of integers
Code language: SQL (Structured Query Language) (sql)

Next, Create a procedure which takes an array as an input parameter and returns an array as its OUT parameter. An example of one such procedure is shown below, which has 2 parameters –

  1. an array of String as its IN parameter – p_array
  2. an array of Integers as OUT parameter – p_arr_int
CREATE OR REPLACE PROCEDURE SchemaName.proc1 (p_array IN array_table, len OUT NUMBER, p_arr_int OUT array_int) AS v_count NUMBER; BEGIN p_arr_int := NEW array_int (); p_arr_int.EXTEND (10); len := p_array.COUNT; v_count := 0; FOR i IN 1 .. p_array.COUNT LOOP DBMS_OUTPUT.put_line (p_array (i)); p_arr_int (i) := v_count; v_count := v_count + 1; END LOOP; END; /
Code language: SQL (Structured Query Language) (sql)

After this, Execution permission would be required to execute the procedure created by you:

GRANT EXECUTE ON SchemaNAme.proc1 TO UserName;
Code language: SQL (Structured Query Language) (sql)

Java Code

Create a java class which makes a call to the procedure proc1, created before. Below is an example which contains the whole flow from creating a connection with the database, to making a call to the stored procedure, passing an array to Oracle procedure, retrieving an array from an Oracle procedure and displaying the result.

import java.math.BigDecimal; import java.sql.CallableStatement; import java.sql.Connection; import java.sql.DriverManager; import java.sql.Types; import oracle.jdbc.OracleCallableStatement; import oracle.jdbc.internal.OracleTypes; import oracle.sql.ARRAY; import oracle.sql.ArrayDescriptor; public class TestDatabase { public static void passArray() { try{ Class.forName("oracle.jdbc.OracleDriver"); Connection con = DriverManager.getConnection("jdbc:oracle:thin:url ","UserName","Password");; String array[] = {"one", "two", "three","four"}; ArrayDescriptor des = ArrayDescriptor.createDescriptor("SchemaName.ARRAY_TABLE", con); ARRAY array_to_pass = new ARRAY(des,con,array); CallableStatement st = con.prepareCall("call SchemaName.proc1(?,?,?)"); // Passing an array to the procedure - st.setArray(1, array_to_pass); st.registerOutParameter(2, Types.INTEGER); st.registerOutParameter(3,OracleTypes.ARRAY,"SchemaName.ARRAY_INT"); st.execute(); System.out.println("size : "+st.getInt(2)); // Retrieving array from the resultset of the procedure after execution - ARRAY arr = ((OracleCallableStatement)st).getARRAY(3); BigDecimal[] recievedArray = (BigDecimal[])(arr.getArray()); for(int i=0;i<recievedArray.length;i++) System.out.println("element" + i + ":" + recievedArray[i] + "\n"); } catch(Exception e) { System.out.println(e); } } public static void main(String args[]){ passArray(); } }
Code language: Java (java)

Brief Explanations:

  1. Class.forName() – Returns the Class object associated with the class or interface with the given string name.
  2. DriverManager.getConnection() – Attempts to establish a connection to the given database URL.
  3. oracle.sql.ArrayDescriptor – Describes an array class
  4. ArrayDescriptor.createDescriptor() – Descriptor factory. Lookup the name in the database, and determine the characteristics of this array.
  5. oracle.sql.ARRAY – An Oracle implementation for generic JDBC Array interface.
  6. CallableStatement – The interface used to execute SQL stored procedures.

References

View Comments

  • Hi this is sridhar, I executed the above program and stored procedure but I am getting the malformed sql 92 exception I am not getting aware of where the error is whether it is from java side or oracle zide could you please help me thanks for all

    Thanks & regards
    Sridhar

  • Hi

    I'm Try to execute the above code
    i getting error while creating procedure:
    CREATE OR REPLACE PROCEDURE SchemaName.proc1 (p_array IN array_table,
    len OUT NUMBER,
    p_arr_int OUT array_int)
    AS
    v_count NUMBER;
    BEGIN
    p_arr_int := NEW array_int ();
    p_arr_int.EXTEND (10);
    len := p_array.COUNT;
    v_count := 0;
    FOR i IN 1 .. p_array.COUNT
    LOOP
    DBMS_OUTPUT.put_line (p_array (i));
    p_arr_int (i) := v_count;
    v_count := v_count + 1;
    END LOOP;
    END;

    ---------------------------------
    Error report:
    ORA-01435: user does not exist
    01435. 00000 - "user does not exist"
    *Cause:
    *Action:

  • Very nice article, Vibhati.
    However, for this case, I won't extend the nested table by 10. It should either be extended by p_array.COUNT or each time by 1 inside the loop. It would avoid returning null values.

  • Hi Thanx,
    nice post,
    I have tried it but it is showing null or blank. it never show correct data.

  • Hi Joe,
    Object -
    [code language="sql"]
    CREATE OR REPLACE type obj_employee AS object (
    EmpNo INTEGER,
    EmpName VARCHAR(50),
    datet DATE);
    [/code]
    Array -
    [code language="sql"]
    create or replace type Arr_Emp as Table of obj_employee;
    [/code]
    Java class.
    [code language="java"]
    public void ArrayListToOracleArray() {
    logger.info(dbSchemaName);
    try {
    ArrayDescriptor arraydesc = ArrayDescriptor.createDescriptor("ARR_EMP", conn);
    obj_employee obj1 = new obj_employee("OBJ_EMPLOYEE", 1, "Bharat", new Date(new java.util.Date("03-MAY-13").getTime()));
    obj_employee obj2 = new obj_employee("OBJ_EMPLOYEE", 2, "Singh", new Date(new java.util.Date().getTime()));
    ArrayList ob = new ArrayList();
    ob.add(obj1);
    ob.add(obj2);
    ARRAY array = new ARRAY(arraydesc, conn, ob.toArray());
    CallableStatement cstm = conn.prepareCall("{ call SP_TEST_RESULT_ENT_SAVEDATA_V1(?,?) }");
    ((OracleCallableStatement) cstm).setARRAY(1, array);
    cstm.registerOutParameter(2, java.sql.Types.VARCHAR);
    cstm.execute();
    System.out.println(" Test " + cstm.getString(2));
    System.out.println("Please check database");
    } catch (Exception e) {
    System.err.println("dothis method exception: " + e.getMessage());
    }
    }
    [/code]
    Employee java class
    [code language="java"]
    public class obj_employee implements SQLData, Serializable {

    private String sql_type;
    private int EmpNo;
    private String EmpName;
    private Date date;

    public obj_employee(String sql_type, int EmpNo, String EmpName, Date date) {
    this.sql_type = sql_type;
    this.EmpNo = EmpNo;
    this.EmpName = EmpName;
    this.date = date;
    }

    public String getSQLTypeName() throws SQLException {
    return sql_type;
    }

    public void readSQL(SQLInput stream, String typeName) throws SQLException {
    this.sql_type = typeName;
    this.EmpNo = stream.readInt();
    this.EmpName = stream.readString();
    this.date = stream.readDate();
    }

    public void writeSQL(SQLOutput stream) throws SQLException {
    stream.writeInt(EmpNo);
    //stream.writeBinaryStream(new BufferedInputStream(new ByteArrayInputStream("bharat".getBytes())));
    stream.writeString("Bhaart");
    stream.writeDate((java.sql.Date) this.date);
    System.out.println(" This Name : " + this.EmpName);
    }
    [/code]
    .i am facing a problem. EmpName is showing blank in DB. but other field is woking fine.

  • Hi,

    Is there any way to bind package level associative arrays in java code with hash map.

    Please help.
    I am trying to do the following.
    create or replace
    package hr_pkg
    as
    type charArray is table of varchar2(255) index by varchar2(10);
    end;

    --Java--
    Map test = new HashMap();
    test.put("PLAN", "2012");
    test.put("ORDER", "9999");
    ArrayDescriptor des = ArrayDescriptor.createDescriptor("hr_pkg.charArray", con);
    ARRAY array_to_pass = new ARRAY(des,con,test);

    When i execute this, i recieve

    java.sql.SQLException: invalid name pattern: hr_pkg.charArray.

    Any work around for this?

    Thanks

Recent Posts

  • Java

Java URL Encoder/Decoder Example

Java URL Encoder/Decoder Example - In this tutorial we will see how to URL encode/decode…

4 years ago
  • General

How to Show Multiple Examples in OpenAPI Spec

Show Multiple Examples in OpenAPI - OpenAPI (aka Swagger) Specifications has become a defecto standard…

4 years ago
  • General

How to Run Local WordPress using Docker

Local WordPress using Docker - Running a local WordPress development environment is crucial for testing…

4 years ago
  • Java

Create and Validate JWT Token in Java using JJWT

1. JWT Token Overview JSON Web Token (JWT) is an open standard defines a compact…

4 years ago
  • Spring Boot

Spring Boot GraphQL Subscription Realtime API

GraphQL Subscription provides a great way of building real-time API. In this tutorial we will…

4 years ago
  • Spring Boot

Spring Boot DynamoDB Integration Test using Testcontainers

1. Overview Spring Boot Webflux DynamoDB Integration tests - In this tutorial we will see…

4 years ago