Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/sandbox/gelernter/Extended Stored Procedure and PLSQL"

m
m
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
http://wiki.eclipse.org/EclipseLink/DesignDocs/275156
+
{{EclipseLink_UserGuide
−
<div style="margin: 5px; float: right; border: 1px solid rgb(0, 0, 0); padding: 5px;">__TOC__</div>
+
|info=y
−
= Extended Stored Procedure and Function Support  =
+
|toc=n
 +
|eclipselink=y
 +
|eclipselinktype=JPA
 +
|api=y
 +
|apis=
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Array.html @Array]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedPLSQLStoredFunctionQuery.html @NamedPLSQLStoredFunctionQuery]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedPLSQLStoredProcedureQuery.html @NamedPLSQLStoredProcedureQuery]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedStoredFunctionQuery.html @NamedStoredFunctionQuery]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedStoredProcedureQuery.html @NamedStoredProcedureQuery]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Struct.html @Struct]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Structure.html @Structure]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredFunctionCall.html PLSQLStoredFunctionCall]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredProcedureCall.html PLSQLStoredProcedureCall]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/queries/StoredFunctionCall.html StoredFunctionCall]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/queries/StoredProcedureCall.html StoredProcedureCall]
  
−
[http://bugs.eclipse.org/275156 ER 275156]  
+
|examples=y
 +
|example=
 +
*[[EclipseLink/Examples/JPA/PLSQLStoredFunction |PLSQLStoredFuntion]]
 +
}}
  
−
= overview  =
+
'''''SANDBOX VERSION'''''
  
−
This document describes the EclipseLink 2.4 extended stored procedure and function support.
+
''This page has not yet been reviewed''
  
−
The extended stored procedure support includes:
+
= Extended Stored Procedure and Function Support =
  
−
*PLSQL stored functions  
+
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 <tt>java.sql.Struct</tt> types and VARRAY types are returned as <tt>java.sql.Array</tt> type.
−
*Multiple result sets
+
−
*Multiple cursor output parameters
+
−
*Output cursors of record types  
+
−
*Optional arguments
+
−
*JPA annotation and XML support for stored functions
+
−
*JPA annotation and XML support for PLSQL procedures and functions
+
  
−
<br>
+
'''''//REVIEWERS: Should the following lists include just the annotations? We can leave the full list in the “Key API” list on the right side of the page.//'''''
  
−
These enhancements can be used by JPA, DBWS, and BPEL. '''''////Any other? Why is BPEL in here?////'''''
+
Use either of the following to call a stored function using PLSQL types:
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedPLSQLStoredFunctionQuery.html @NamedPLSQLStoredFunctionQuery]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredFunctionCall.html PLSQLStoredFunctionCall] 
  
−
= Functionality  =
+
Use either of the following to call a stored procedure:
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedPLSQLStoredProcedureQuery.html @NamedPLSQLStoredProcedureQuery]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredProcedureCall.html PLSQLStoredProcedureCall]
  
−
The [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredFunctionCall.html <tt>PLSQLStoredFunctionCall</tt>] class (a subclass of [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/platform/database/oracle/plsql/PLSQLStoredProcedureCall.html <tt>PLSQLStoredProcedureCall</tt>]) provides the existing PLSQL data-type support for stored functions. '''''////existing in previous EL or in PLSQL?////'''''
+
Use the following for regular stored functions and procedure that do not return complex PLSQL types:
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedStoredFunctionQuery.html @NamedStoredFunctionQuery]
 +
*  [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/NamedStoredProcedureQuery.html @NamedStoredProcedureQuery]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/queries/StoredFunctionCall.html StoredFunctionCall]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/queries/StoredProcedureCall.html StoredProcedureCall]
  
−
[http://www.eclipse.org/eclipselink/api/2.3/org/eclipse/persistence/queries/StoredProcedureCall.html <tt>StoredProcedureCall</tt>] now supports multiple result sets and multiple out cursors.  
+
To call PLSQL stored functions or procedures, you must define mirror OBJECT and VARRAY types for the RECORD and TABLE types. Use the [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Struct.html @Struct] annotation  to map OBJECT types to <tt>@Entity</tt> or <tt>@Embeddable</tt> classes.  Normally, you can use <tt>@Embeddable</tt>, unless the OBJECT type defines an ID and can be stored in a table.
  
−
A flag will be added for multiple result sets, or data queries will be supported, unless both result sets are for the same class. Specification of multiple out cursors is already supported from JPA, the support will allow there execution. Only data queries are supported, each out cursor will contains a List of DatabaseRecords stored in the output row the same as other output parameters.  
+
Use the following annotations to map nested OBJECT and VARRAY types:
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Structure.html @Structure]
 +
* [http://www.eclipse.org/eclipselink/api/latest/org/eclipse/persistence/annotations/Array.html @Array]
  
−
Queries will support an optional argument for stored procedures that have parameters that define a default value. If the query argument is null, and the StoredProcedureCall defines the argument to be optional, then the query's SQL will be regenerate to omit the parameter.
+
==Examples==
  
−
JPA annotation and XML support will be added for stored functions the same as stored procedures, as well as the new options to the existing stored procedure annotation and XML.
+
===Oracle Stored Function Returning PLSQL RECORD Type===
  
−
JPA annotation and XML support will be added for PLSQL procedures and functions, this will require adding annotations for Record, Table, Struct, and Array types.
+
The following stored function returns the PLSQL <tt>RECORD</tt> type:
  
−
= Testing  =
+
<source lang="sql">
 +
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;
 +
</source>
  
−
Extend existing foundation and JPA stored procedure tests for new types of procedure being supported.  
+
<source lang="sql">
 +
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;
 +
</source>
  
−
= API  =
+
An OBJECT type mirror for the EMP_REC type must also be defined.
  
−
*StoredProcedureCall
+
<source lang="sql">
−
**setHasMultipleResultSets(boolean)
+
CREATE OR REPLACE TYPE EMP_TYPE AS OBJECT (F_NAME VARCHAR2(30), L_NAME VARCHAR2(30), SALARY NUMBER(10,2))
−
**addNamedCursorOutputArgument(String)  
+
</source>
−
**addUnamedCursorOutputArgument(String)  
+
−
**addOptionalArgument(String)
+
−
*DatabaseQuery
+
−
**addArgument(String argumentName, Class type, boolean nullable)  
+
−
*@NamedStoredProcedureQuery
+
−
**callByIndex&nbsp;: boolean
+
−
**multipleResultSets&nbsp;: boolean
+
−
*@StoredProcedureParameter
+
−
**optional&nbsp;: boolean
+
−
*PLSQLStoredFunctionCall
+
−
**setResult(DatabaseType)  
+
−
*@NamedStoredFunctionQuery
+
−
**returnParameter&nbsp;: @StoredProcedureParameter
+
−
*@NamedPLSQLStoredProcedureQuery (org.eclipse.persistence.platform.oracle.annotations)
+
−
*@NamedPLSQLStoredFunctionQuery (org.eclipse.persistence.platform.oracle.annotations)
+
−
*@PLSQLParameter (org.eclipse.persistence.platform.oracle.annotations)
+
−
*@PLSQLRecord (org.eclipse.persistence.platform.oracle.annotations)
+
−
*@PLSQLTable (org.eclipse.persistence.platform.oracle.annotations)
+
  
−
*@Struct
+
=== Defining a Java Class to Map to OBJECT type ===
−
*@Array
+
−
*@Structure
+
  
−
= Config files =
+
<source lang="java">
 +
@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;
 +
...
 +
}
 +
</source>
  
−
*orm.xml
+
=== Using JpaEntityManager createQuery() API to Execute a PLSQL Stored Function ===
  
−
<source lang="xml">
+
<source lang="java">
−
<name-stored-function-query function-name="CHECK_EMP">
+
import javax.persistence.Query;
−
    <parameter name="EMP_ID"/>
+
import org.eclipse.persistence.platform.database.orcle.plsql.PLSQLStoredFunctionCall;
−
    <return-parameter name="STATUS" type="java.lang.Boolean"/>
+
import org.eclipse.persistence.queries.ReadAllQuery;
−
</name-stored-function-query>
+
−
<plsql-name-stored-function-query function-name="GET_EMP">
+
−
    <parameter name="EMP_ID" database-type="NUMERIC"/>
+
−
    <return-parameter name="EMP" database-type="EMP"/>
+
−
</plsql-name-stored-function-query>
+
−
<plsql-record type-name="EMP" compatible-type="EMP_TYPE" java-type="org.acme.Employee">
+
−
    <field name="EMP_ID" database-type="NUMERIC"/>
+
−
    <field name="NAME" database-type="VARCHAR"/>
+
−
</plsql-record>
+
−
</source>
+
  
−
= Documentation  =
+
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);
  
−
Should be documented under query stored procedure section.  
+
Query query = ((JpaEntityManager)entityManager.getDelegate()).createQuery(databaseQuery);
 +
Employee result = (Employee)query.getSingleResult();
  
−
= Open Issues  =
+
</source>
  
−
{| class="FCK__ShowTableBorders"
+
=== Using @NamedPLSQLStoredFunctionQuery to Define a Stored Function ===
−
|-
+
−
! Issue #
+
−
! Owner
+
−
! Description / Notes
+
−
|-
+
−
| 1
+
−
|
+
−
| What package to add JPA annotations to?
+
−
|-
+
−
| 2
+
−
|
+
−
|
+
−
|}
+
  
−
= Decisions  =
+
<source lang="java">
 +
@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 {
 +
...
 +
}
 +
</source>
  
−
{| class="FCK__ShowTableBorders"
+
=== Using a Named Query ===
−
|-
+
<source lang="java">
−
! Issue
+
Query query = entityManager.createNamedQuery("getEmployee");
−
! Description / Notes
+
Employee result = (Employee)query.getSingleResult();
−
! Decision
+
</source>
−
|}
+
  
−
= Future Considerations  =
 
  
−
*Other procedure functionality.
+
{{EclipseLink_JPA }}
−
 
+
−
== Headline text ==
+

Latest revision as of 09:56, 11 July 2011

EclipseLink JPA


SANDBOX VERSION

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.

//REVIEWERS: Should the following lists include just the annotations? We can leave the full list in the “Key API” list on the right side of the page.//

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

Use either of the following to call a stored procedure:

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

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:

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-logo.gif
Version: DRAFT
Other versions...

Retrieved from "https://wiki.eclipse.org/index.php?title=EclipseLink/UserGuide/sandbox/gelernter/Extended_Stored_Procedure_and_PLSQL&oldid=260684"

This page was last modified 09:56, 11 July 2011 by Ben Gelernter.

Back to the top