Java Persistence API (JPA) Extensions Reference for EclipseLink, Release 2.4
  Go To Table Of Contents
 Search
 PDFComments
Comments


@NamedPLSQLStoredFunctionQuery

Use @NamedPLSQLStoredFunctionQuery to define queries that call Oracle PLSQL stored functions as named queries


Annotation Elements

Table 2-36 describes this annotation's elements.

Table 2-36 @NamedPLSQLStoredFunctionQuery Annotation Elements

Annotation Element Description Default

functionName

(Required) The name of the stored function.


name

(Required) The unique name that references this stored function query.


returnParamter

(Required) The return value of the stored function.


hints

(Optional) Query hints


parameters

(Optional) The parameters for the stored function.


resultSetMapping

(Optional) The name of the SQLResultMapping.




Usage

This annotation adds support for complex PLSQL types such as RECORD and TABLE, that are not accessible from JDBC.

You can specify @NamedPLSQLStoredFunctionQuery on an Entity or MappedSuperclass.


Examples

Example 2-68 shows how to use this annotation.

Example 2-68 Using @NamedPLSQLStoredFunctionQuery Annotation

@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 { ...}


See Also

For more information, see: