Latest revision as of 14:23, 23 April 2013

This page is now obsolete.

For current information, please see "Stored Procedure and Function Annotations" in the Java Persistence API (JPA) Extensions Reference for EclipseLink: http://www.eclipse.org/eclipselink/documentation/latest/jpa/extensions/

EclipseLink
Website
Download
Community
Mailing List • Forums • IRC • mattermost
Issues
Open • Help Wanted • Bug Day
Contribute
Browse Source

Key API

• @Array
• @NamedPLSQLStoredFunctionQuery
• @NamedPLSQLStoredProcedureQuery
• @NamedStoredFunctionQuery
• @NamedStoredProcedureQuery
• @Struct
• @Structure
• PLSQLStoredFunctionCall
• PLSQLStoredProcedureCall
• StoredFunctionCall
• StoredProcedureCall

Examples

• PLSQLStoredFuntion

This page has not yet been reviewed

Extended Stored Procedure and Function Support

EclipseLink provides support for calling Oracle PLSQL stored functions that return complex PLSQL data types such as RECORD types and TABLE types. PLSQL types are not supported by Oracle JDBC, so these types must be translated to Oracle OBJECT types and VARRAY types. OBJECT types are returned in JDBC as java.sql.Struct types and VARRAY types are returned as java.sql.Array type.

Use either of the following to call a stored function using PLSQL types:

• @NamedPLSQLStoredFunctionQuery
• PLSQLStoredFunctionCall

Use either of the following to call a stored procedure:

• @NamedPLSQLStoredProcedureQuery
• PLSQLStoredProcedureCall

Use the following for regular stored functions and procedure that do not return complex PLSQL types:

• @NamedStoredFunctionQuery
• @NamedStoredProcedureQuery
• StoredFunctionCall
• StoredProcedureCall

To call PLSQL stored functions or procedures, you must define mirror OBJECT and VARRAY types for the RECORD and TABLE types. Use the @Struct annotation to map OBJECT types to @Entity or @Embeddable classes. Normally, you can use @Embeddable, unless the OBJECT type defines an ID and can be stored in a table.

Use the following annotations to map nested OBJECT and VARRAY types:

• @Structure
• @Array

Examples

Oracle Stored Function Returning PLSQL RECORD Type

The following stored function returns the PLSQL RECORD type:

CREATE OR REPLACE PACKAGE EMP_PKG AS
TYPE EMP_REC IS RECORD (F_NAME VARCHAR2(30), L_NAME VARCHAR2(30), SALARY NUMBER(10,2));
FUNCTION GET_EMP RETURN EMP_REC;
END EMP_PKG;

CREATE OR REPLACE PACKAGE BODY EMP_PKG AS
FUNCTION GET_EMP RETURN EMP_REC AS
  P_EMP EMP_REC;
  BEGIN P_EMP.F_NAME := 'Bob'; P_EMP.F_NAME := 'Smith'; P_EMP.SALARY := 30000;
  RETURN P_EMP;
END;
END EMP_PKG;

An OBJECT type mirror for the EMP_REC type must also be defined.

CREATE OR REPLACE TYPE EMP_TYPE AS OBJECT (F_NAME VARCHAR2(30), L_NAME VARCHAR2(30), SALARY NUMBER(10,2))

Defining a Java Class to Map to OBJECT type

@Embeddable
@Struct(name="EMP_TYPE", fields={"F_NAME", "L_NAME", "SALARY"})
public class Employee {
 @Column(name="F_NAME")
 private String firstName;
 @Column(name="L_NAME")
 private String lastName;
 @Column(name="SALARY")
 private BigDecimal salary;
 ...
}

Using JpaEntityManager createQuery() API to Execute a PLSQL Stored Function

import javax.persistence.Query;
import org.eclipse.persistence.platform.database.orcle.plsql.PLSQLStoredFunctionCall;
import org.eclipse.persistence.queries.ReadAllQuery;
 
DataReadQuery databaseQuery = new DataReadQuery();
PLSQLrecord record = new PLSQLrecord();
record.setTypeName("EMP_PKG.EMP_REC");
record.setCompatibleType("EMP_TYPE");
record.setJavaType(Employee.class);
record.addField("F_NAME", JDBCTypes.VARCHAR_TYPE, 30);
record.addField("L_NAME", JDBCTypes.VARCHAR_TYPE, 30);
record.addField("SALARY", JDBCTypes.NUMERIC_TYPE, 10, 2);
PLSQLStoredFunctionCall call = new PLSQLStoredFunctionCall(record);
call.setProcedureName("EMP_PKG.GET_EMP");
databaseQuery.setCall(call);
 
Query query = ((JpaEntityManager)entityManager.getDelegate()).createQuery(databaseQuery);
Employee result = (Employee)query.getSingleResult();

Using @NamedPLSQLStoredFunctionQuery to Define a Stored Function

@NamedPLSQLStoredFunctionQuery(name="getEmployee", functionName="EMP_PKG.GET_EMP",
    returnParameter=@PLSQLParameter(name="RESULT", databaseType="EMP_PKG.EMP_REC"))
@Embeddable
@Struct(name="EMP_TYPE", fields={"F_NAME", "L_NAME", "SALARY"})
@PLSQLRecord(name="EMP_PKG.EMP_REC", compatibleType="EMP_TYPE", javaType=Employee.class,
    fields={@PLSQLParameter(name="F_NAME"), @PLSQLParameter(name="L_NAME"), @PLSQLParameter(name="SALARY", databaseType="NUMERIC_TYPE")})
public class Employee {
 ...
}

Using a Named Query

Query query = entityManager.createNamedQuery("getEmployee");
Employee result = (Employee)query.getSingleResult();

EclipseLink Home JPA User Guide: Table of Contents, Search
How to contribute to this guide...