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.
Difference between revisions of "EclipseLink/Examples/DBWS/DBWSComplexArgStoredFunction"
(→EclipseLink DBWS Service based on a PL/SQL Stored Function with complex PL/SQL arguments) |
(→EclipseLink DBWS Service based on a PL/SQL Stored Function with complex PL/SQL arguments) |
||
Line 37: | Line 37: | ||
FUNCTION F1(OLDREC IN ARECORD, FOO IN VARCHAR2) RETURN ARECORD; | FUNCTION F1(OLDREC IN ARECORD, FOO IN VARCHAR2) RETURN ARECORD; | ||
END SOMEPACKAGE; | END SOMEPACKAGE; | ||
+ | </source> | ||
+ | |||
+ | Because PL/SQL record and collection types cannot be transported over JDBC, an anonymous block of PL/SQL code will be generated that contains functions that convert to/from JDBC and PL/SQL types. What this means is that, in our example, in order to pass the PL/SQL record <code>ARECORD</code> to the function, and have the PL/SQL record <code>ARECORD</code> returned, the following JDBC type will need to be created based on the PL/SQL record <code>ARECORD</code>: | ||
+ | |||
+ | <source lang="plsql" enclose="div"> | ||
+ | CREATE OR REPLACE TYPE ARECORD AS OBJECT ( | ||
+ | T1 TBL1, | ||
+ | T2 TBL2, | ||
+ | T3 BOOLEAN | ||
+ | ) | ||
</source> | </source> | ||
Revision as of 13:10, 25 July 2012
{NB - this capability is available starting in version 2.3 of DBWS}
EclipseLink DBWS Service based on a PL/SQL Stored Function with complex PL/SQL arguments
The use-case for this example is the creation of a Web service that exposes a PL/SQL Stored Function that uses complex PL/SQL types as an IN or return argument.
The following stored function will be used for this example:
arec ARECORD; -- temp var
BEGIN
arec.T1 := ... some processing based upon OLDREC
arec.T2 := ... AND FOO
arec.T3 := ...
RETURN arec;
END F1;
Type ARECORD
is defined in PL/SQL Package SOMEPACKAGE
as follows:
TYPE TBL1 IS TABLE OF VARCHAR2(111) INDEX BY BINARY_INTEGER;
TYPE TBL2 IS TABLE OF NUMBER INDEX BY BINARY_INTEGER;
TYPE ARECORD IS RECORD (
T1 TBL1,
T2 TBL2,
T3 BOOLEAN
);
FUNCTION F1(OLDREC IN ARECORD, FOO IN VARCHAR2) RETURN ARECORD;
END SOMEPACKAGE;
Because PL/SQL record and collection types cannot be transported over JDBC, an anonymous block of PL/SQL code will be generated that contains functions that convert to/from JDBC and PL/SQL types. What this means is that, in our example, in order to pass the PL/SQL record ARECORD
to the function, and have the PL/SQL record ARECORD
returned, the following JDBC type will need to be created based on the PL/SQL record ARECORD
:
T1 TBL1,
T2 TBL2,
T3 BOOLEAN
)
The DBWSBuilder utility requires a DBWS configuration file as input. Note that the return type will be SOMEPACKAGE_ARECORD
; this is a complex type in the generated EclipseLink DBWS schema (below), which in this case is constructed based on the contents of the package SOMEPACKAGE
.
<dbws-builder xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<properties>
<property name="projectName">testPLSQLFunction</property>
... database properties
</properties>
<plsql-procedure
name="plsqlfunction"
catalogPattern="SOMEPACKAGE"
procedurePattern="F1"
/>
</dbws-builder>
prompt > dbwsbuilder.cmd -builderFile dbws-builder.xml -stageDir output_directory -packageAs wls testPLSQLFunction.war
where
- dbws-builder.xml is the DBWS builder XML file above
- output_directory is the output directory for the generated files
- -packageAs specifies the platform on which the web service will be deployed
The generated eclipselink-dbws-schema.xsd file follows:
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:plsqlfunction" xmlns="urn:plsqlfunction" elementFormDefault="qualified">
<xsd:complexType name="SOMEPACKAGE_TBL1">
<xsd:sequence>
<xsd:element name="item" type="xsd:string" maxOccurs="unbounded" nillable="true"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="SOMEPACKAGE_TBL2">
<xsd:sequence>
<xsd:element name="item" type="xsd:decimal" maxOccurs="unbounded" nillable="true"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="SOMEPACKAGE_ARECORD">
<xsd:sequence>
<xsd:element name="t1">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="item" type="xsd:string" maxOccurs="unbounded" nillable="true"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="t2">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="item" type="xsd:decimal" maxOccurs="unbounded" nillable="true"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="t3" type="xsd:boolean" nillable="true"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="simple-xml-format">
<xsd:sequence>
<xsd:any minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="SOMEPACKAGE_TBL1" type="SOMEPACKAGE_TBL1"/>
<xsd:element name="SOMEPACKAGE_TBL2" type="SOMEPACKAGE_TBL2"/>
<xsd:element name="SOMEPACKAGE_ARECORD" type="SOMEPACKAGE_ARECORD"/>
</xsd:schema>