Sentencia CREATE FUNCTION

La sentencia CREATE FUNCTION define una función o un procedimiento que se puede llamar.

También puede utilizar la sentencia CREATE PROCEDURE para definir una función o un procedimiento que se puede llamar, que también se conoce como rutina.

SINTAXIS

Notas:
  1. Si el tipo de rutina es FUNCTION, el indicador de dirección (IN, OUT o INOUT) es opcional para cada parámetro. Sin embargo, para fines de documentación, en programación se recomienda especificar un indicador de dirección para todas las nuevas rutinas; si no especifica la dirección, se utiliza un valor predeterminado de IN.
  2. Cuando se utiliza la cláusula NAMESPACE o NAME, su valor es implícitamente CONSTANT y del tipo CHARACTER. Para obtener información acerca de cómo utilizar las variables CONSTANT, consulte Sentencia DECLARE.
  3. Si el tipo de rutina es FUNCTION, no se puede especificar el lenguaje (LANGUAGE) DATABASE.

Visión general

Las sentencias CREATE FUNCTION y CREATE PROCEDURE definen una función o procedimiento que se pueden llamar, también denominadas rutinas.

En versiones anteriores de este producto, CREATE FUNCTION y CREATE PROCEDURE tenían distintas usos y posibilidades. Las mejoras posteriores han dado como resultado diferencias listadas anteriormente en las notas 1 y 3.

Las rutinas son útiles para crear bloques de código reutilizables que se pueden ejecutar de forma independiente muchas veces. Puede implementarlas como una serie de sentencias ESQL, un método Java o un procedimiento almacenado de base de datos. Esta flexibilidad significa que algunas de las cláusulas en el diagrama de sintaxis de no son aplicables (o permitidas) a todos los tipos de rutina.

Cada rutina tiene un nombre, que debe ser exclusivo dentro del esquema al que pertenece. Por tanto, no se pueden sobrecargar los nombres de las rutinas; si el intermediario detecta que se ha sobrecargado un nombre de rutina, genera una excepción.

La cláusula LANGUAGE especifica el lenguaje en que se escribe el cuerpo de la rutina. Las opciones son:
DATABASE
Se llama al procedimiento como un procedimiento almacenado en la base de datos.
ESQL
Se llama al procedimiento como una rutina ESQL.
JAVA
Se llama al procedimiento como a un método estático de una clase Java.
No especificado
Si no especifica la cláusula LANGUAGE, el lenguaje predeterminado es ESQL a menos que especifique la cláusula EXTERNAL NAME (en cuyo caso el lenguaje predeterminado es DATABASE).
Existen limitaciones sobre el uso de la cláusula LANGUAGE. No puede utilizar:
  • La opción ESQL con una cláusula EXTERNAL NAME
  • Las opciones DATABASE o JAVA sin una cláusula EXTERNAL NAME
  • La opción DATABASE con el tipo de rutina FUNCTION

Especifique el nombre de la rutina utilizando la cláusula NombreRutina y los parámetros de la rutina utilizando la cláusula ListaParámetros. Si la cláusula LANGUAGE especifica ESQL, implemente la rutina utilizando una sola sentencia ESQL. Esta sentencia es muy útil si es una sentencia compuesta (BEGIN ... END), ya que entonces puede contener tantas sentencias ESQL como sea necesario para cumplir su función.

De forma alternativa, en lugar de proporcionar un cuerpo ESQL para la rutina, puede especificar una cláusula LANGUAGE distinta de ESQL. Esto le permite utilizar la cláusula EXTERNAL NAME para proporcionar una referencia al cuerpo real de la rutina, dondequiera que se ubique fuera del intermediario. Para obtener más información sobre cómo utilizar la cláusula EXTERNAL NAME, consulte Invocar procedimientos almacenados y Llamada a una rutina Java.

Las rutinas con LANGUAGE de cualquier tipo pueden tener parámetros IN, OUT e INOUT. El canal de llamada puede pasar varios valores a la rutina y recibir de vuelta varios valores actualizados. Estos parámetros devueltos se suman a las cláusulas RETURNS que haya definido para la rutina. La cláusula RETURNS define el valor que la rutina devuelve el canal de llamada.

Las rutinas que están implementadas en distintos lenguajes tienen sus propias restricciones sobre qué tipos de datos se pueden pasar o devolver; estas restricciones se indican más adelante en eta sección. El tipo de datos del valor devuelto debe coincidir con el tipo de datos del valor definido para devolverse desde la rutina. Además, si una rutina está definida para que tenga un valor de retorno, el canal de llamada de la rutina no puede ignorarlo. Si desea ver más información, consulte el apartado Sentencia CALL.

Las rutinas pueden definirse tanto en un módulo como en un esquema. Las rutinas que están definidas en un módulo son locales en el ámbito del nodo actual, lo cual significa que sólo puede llamarlas el código que pertenece al mismo módulo (o nodo). Sin embargo, a las rutinas definidas en un esquema, se pueden invocar utilizando una de las opciones siguientes:
  • Código en el mismo esquema
  • El código de cualquier otro esquema, si se aplica alguna de las condiciones siguientes:
    • La cláusula PATH del otro esquema contiene la vía de acceso a la rutina llamada
    • La rutina llamada se invoca utilizando el nombre totalmente calificado (que es el nombre, con el nombre de esquema como prefijo, separado por un punto)
Por tanto, si tiene que invocar la misma rutina en más de un nodo, defínala en un esquema.

Para cualquier lenguaje o tipo de rutina, el método de invocación de la rutina debe coincidir con la forma de declaración de la rutina. Si la rutina tiene una cláusula RETURNS, utilice la sintaxis de invocación FUNCTION o una sentencia CALL con una cláusula INTO. Y a la inversa, si una rutina no tiene ninguna cláusula RETURNS, debe utilizar una sentencia CALL sin una cláusula INTO.

Direcciones de parámetros

Los parámetros que se pasan a las rutinas siempre tienen una dirección asociada a ellos, que es uno de los tipos siguientes:
IN
La rutina no puede cambiar el valor del parámetro. Se permite el valor NULL para el parámetro y puede pasarse a la rutina.
OUT
Cuando la rutina llamada lo recibe, el parámetro pasado a la rutina siempre tiene el valor NULL del tipo de datos correcto. Este valor se establece independientemente del valor que tenía antes de llamar a la rutina. La rutina puede cambiar el valor del parámetro.
INOUT
INOUT es un parámetro IN y OUT a la vez. Pasa un valor a la rutina y el valor que se ha pasado puede cambiarlo la rutina. Se permite el valor NULL para el parámetro y puede pasarse dentro y fuera de la rutina.

Si el tipo de rutina es FUNCTION, el indicador de dirección (IN, OUT, INOUT) es opcional para cada parámetro. Sin embargo, en programación se recomienda especificar un indicador de dirección para todas las nuevas rutinas de cualquier tipo.

Las variables ESQL que se declaran como CONSTANT (o las referencias a las variables declaradas como CONSTANT) no pueden tener la dirección OUT o INOUT.

Rutinas ESQL

Las rutinas ESQL están escritas en ESQL y tienen una cláusula LANGUAGE de ESQL. El cuerpo de una rutina ESQL normalmente es una sentencia compuesta de la forma BEGIN… END, que contiene múltiples sentencias para procesar los parámetros que han pasado a la rutina.

Ejemplo 1 de ESQL

El ejemplo siguiente muestra el mismo procedimiento que en Ejemplo 1 de rutina de base de datos, pero se implementa como una rutina ESQL y no como un procedimiento almacenado. La sintaxis de CALL y el resultado de esta rutina son los mismos que en Restricciones en las rutinas Java.
CREATE PROCEDURE swapParms (
  IN parm1 CHARACTER,
  OUT parm2  CHARACTER,
  INOUT parm3 CHARACTER )
BEGIN
   SET parm2 = parm3;
   SET parm3 = parm1;
 END; 

Ejemplo 2 de ESQL

Este procedimiento de ejemplo muestra el uso repetitivo de una rutina ESQL. Analiza un árbol, visitando todos los lugares a partir de un punto inicial concreto, y genera informes sobre lo que ha encontrado:

SET OutputRoot.MQMD = InputRoot.MQMD;

  DECLARE answer CHARACTER;
  SET answer = '';

  CALL navigate(InputRoot.XMLNS, answer);
  SET OutputRoot.XMLNS.Data.FieldNames = answer;


  CREATE PROCEDURE navigate (IN root REFERENCE, INOUT answer CHARACTER)
  BEGIN
    SET answer = answer || 'Reached Field... Type:' 
    || CAST(FIELDTYPE(root) AS CHAR)||
    ': Name:' || FIELDNAME(root) || ': Value :' || root || ': ';

    DECLARE cursor REFERENCE TO root;
    MOVE cursor FIRSTCHILD;
    IF LASTMOVE(cursor) THEN
      SET answer = answer || 'Field has children... drilling down ';
    ELSE
      SET answer = answer || 'Listing siblings... ';
    END IF;

    WHILE LASTMOVE(cursor) DO
      CALL navigate(cursor, answer);
      MOVE cursor NEXTSIBLING;
    END WHILE;

    SET answer = answer || 'Finished siblings... Popping up ';
  END;

Cuando se proporciona el siguiente mensaje de entrada:

<Person>
  <Name>John Smith</Name>
  <Salary period='monthly' taxable='yes'>-1200</Salary>
</Person>

el procedimiento genera la salida siguiente que se ha formateado manualmente:

  Reached Field... Type:16777232: Name:XML: Value :: Field has children... 
  drilling down 
  Reached Field... Type:16777216: Name:Person: Value :: Field has children...
  drilling down 
  Reached Field... Type:16777216: Name:Name: 
  Value :John Smith: Field has children... drilling down 
  Reached Field... Type:33554432: Name:: 
  Value :John Smith: Listing siblings... Finished siblings... Popping up
  Finished siblings... Popping up 
  Reached Field... Type:16777216: Name:Salary:
  Value :-1200: Field has children... drilling down 
  Reached Field... Type:50331648: Name:period: 
  Value :monthly: Listing siblings... Finished siblings... Popping up
  Reached Field... Type:50331648: Name:taxable: 
  Value :yes: Listing siblings... Finished siblings... Popping up 
  Reached Field... Type:33554432: Name:: 
  Value :-1200: Listing siblings... Finished siblings... Popping up 
  Finished siblings... Popping up 
  Finished siblings... Popping up 
  Finished siblings... Popping up

Rutinas Java

Una rutina Java se implementa como un método Java y tiene una cláusula LANGUAGE de JAVA. Para rutinas Java, ExternalRoutineName debe contener el nombre de clase y el nombre del método Java que se debe llamar. Especifique el NombreRutinaExterna de la siguiente manera:
>>--"-- nombreClase---.---nombreMétodo--"--------------><
donde nombreClase identifica la clase que contiene el método y nombreMétodo identifica el método a invocar. Si la clase forma parte de un paquete, la parte correspondiente al identificador de clase debe incluir el prefijo del paquete completo; por ejemplo, "com.ibm.broker.test.MyClass.myMethod".

Para encontrar la clase Java, el intermediario utiliza el método de búsqueda que se describe en Despliegue de clases Java.

Cualquier método Java que desee invocar debe tener la siguiente signatura básica:
public static <return-type> <method-name> (<parámetros 0 - N>)

donde <tipo-retorno> debe estar en la lista de tipos de datos IN de Java de la tabla de Correlación de tipo de datos ESQL a Java (excluido el tipo REFERENCE, que no está permitido como valor de retorno) o el tipo de datos void (vacío) de Java. Los tipos de datos de parámetros también deben estar en la tabla Correlación de tipo de datos ESQL a Java. Además, no se permite que el método Java tenga una cláusula exception throws en su signatura.

La signatura del método Java debe coincidir con la declaración del método de la rutina ESQL. Debe también cumplir las reglas siguientes:
  • Asegúrese de que el nombre de método Java, incluyendo el nombre de clase y los calificadores de paquetes, coincide con el EXTERNAL NAME del procedimiento.
  • Si el tipo de retorno Java es void, no ponga una cláusula RETURNS en la definición de la rutina ESQL. A la inversa, si tipo de retorno Java no es void, debe poner una cláusula RETURNS en la definición de la rutina ESQL.
  • Asegúrese de que cada dirección y tipo del parámetro coincida con la declaración ESQL, según las normas listadas en la tabla de Correlación de tipo de datos ESQL a Java.
  • Asegúrese de que los tipos de retorno de los métodos coincidan con el tipo de datos de la cláusula RETURNS.
  • Encierre EXTERNAL NAME entre comillas porque debe contener al menos "class.method".
  • Si desea invocar un método Java sobrecargado, debe crear una definición de ESQL independiente para cada método sobrecargado y proporcionar a cada definición de ESQL un nombre de rutina exclusivo.

Puede utilizar la API de nodo Java definido por el usuario en el método Java, a condición de que observe las restricciones documentadas en Restricciones en las rutinas Java. Para obtener más información sobre cómo utilizar la API Java, consulte Compilación de un nodo Java definido por el usuario.

Ejemplo de rutina Java 1

Esta rutina contiene tres parámetros de diversas direcciones y devuelve un entero, que se correlaciona a un tipo de retorno Java de java.lang.Long.

CREATE FUNCTION  myProc1( IN P1 INTEGER, OUT P2 INTEGER, INOUT P3 INTEGER )
 RETURNS INTEGER
 LANGUAGE JAVA 
 EXTERNAL NAME "com.ibm.broker.test.MyClass.myMethod1";

Puede utilizar el ESQL siguiente para invocar myProc1:

CALL myProc1( intVar1, intVar2, intVar3) INTO intReturnVar3;
-- o
SET intReturnVar3 = myProc1( intVar1, intVar2, intVar3);

Ejemplo 2 de rutina Java

Esta rutina contiene tres parámetros de diversas direcciones y tiene un tipo de retorno Java de void.

CREATE PROCEDURE myProc2( IN P1 INTEGER, OUT P2 INTEGER, INOUT P3 INTEGER )
 LANGUAGE JAVA 
 EXTERNAL NAME "com.ibm.broker.test.MyClass.myMethod2";

Debe utilizar el ESQL siguiente para invocar myProc2:

CALL myProc2(intVar1, intVar2, intVar3);

La siguiente clase Java proporciona un método para cada uno de los ejemplos Java anteriores:

package com.ibm.broker.test;

class MyClass {
public static Long myMethod1( Long P1, Long[] P2 Long[] P3) { ... }
public static void myMethod2( Long P2, Long[] P2 Long[] P3) { ... }

 /*  Cuando se llama a cualquiera de estos métodos:
    P1 puede ser o no NULL (dependiendo del valor de intVar1).
    P2[0] siempre es NULL (sea cual sea el valor de intVar2).
    P3[0] puede ser o no NULL (dependiendo del valor de intVar3).  
    Es lo mismo que con las rutinas LANGUAGE ESQL. 
    Estos métodos pueden devolver:
         intVar1 sin modificar
         intVar2 modificado o todavía con el valor NULL
         intVar3 modificado o todavía con el mismo valor
     Es lo mismo que con las rutinas LANGUAGE ESQL.
     
    Cuando myMethod1 devuelve: intReturnVar3 puede ser  NULL (si
    el método devuelve NULL) o contiene el valor devuelto por el 
    método.
 */
}

Correlación de tipo de datos ESQL a Java

La tabla siguiente resume las correlaciones de ESQL a Java.
Notas:
  • Sólo se pasan a Java los wrappers escalares Java.
  • Los tipos escalares ESQL se correlacionan con los tipos de datos Java como wrappers de objetos o como matrices de wrappers de objetos, dependiendo de la dirección del parámetro de procedimiento. Cada matriz de wrapper contiene exactamente un elemento.
  • Los wrappers de objetos escalares se utilizan para que puedan pasarse valores NULL a y desde los métodos Java.
Tipos de datos ESQL 1 Tipos de datos IN de Java Tipos de datos INOUT y OUT de Java
INTEGER, INT java.lang.Long java.lang.Long []
FLOAT java.lang.Double java.lang.Double[]
DECIMAL java.math.BigDecimal java.math.BigDecimal[]
CHARACTER, CHAR java.lang.String java.lang.String[]
BLOB byte[] byte[][]
BIT java.util.BitSet java.util.BitSet[]
DATE com.ibm.broker.plugin.MbDate com.ibm.broker.plugin.MbDate[]
TIME 2 com.ibm.broker.plugin.MbTime com.ibm.broker.plugin.MbTime[]
GMTTIME 2 com.ibm.broker.plugin.MbTime com.ibm.broker.plugin.MbTime[]
TIMESTAMP 2 com.ibm.broker.plugin.MbTimestamp com.ibm.broker.plugin.MbTimestamp[]
GMTTIMESTAMP 2 com.ibm.broker.plugin.MbTimestamp com.ibm.broker.plugin.MbTimestamp[]
INTERVAL No soportado No soportado
BOOLEAN java.lang.Boolean java.lang.Boolean[]
REFERENCE (a un árbol de mensaje) 3 4 5 6 com.ibm.broker.plugin.MbElement com.ibm.broker.plugin.MbElement[] (Soportado para INOUT. No soportado para OUT)
ROW No soportado No soportado
LIST No soportado No soportado
  1. Las variables que se declaran como CONSTANT (o las referencias a las variables que se declaran como CONSTANT) no pueden tener la dirección INOUT u OUT.
  2. El huso horario establecido en la variable Java no es importante, el huso horario necesario se obtiene en el ESQL de salida.
  3. l parámetro de referencia no puede ser NULL cuando se pasa a un método Java.
  4. La referencia no puede tener la dirección OUT cuando se pasa a un método Java.
  5. Si se vuelve a pasar un MbElement de Java ESQL como un parámetro INOUT, debe apuntar a una ubicación en el mismo árbol de mensaje al que apuntaba el MbElement que se ha pasado en el método Java.

    Por ejemplo, si se pasa una referencia ESQL a OutputRoot.XML.Test a un método Java como un MbElement INOUT, pero se vuelve a pasar un MbElement diferente a ESQL cuando se devuelve la llamada, el elemento diferente también debe apuntar a algún lugar del árbol OutputRoot.

  6. Un MbElement no se puede devolver desde un método Java con la cláusula RETURNS, ya que ninguna rutina ESQL puede devolver una referencia. No obstante, un elemento MbElement se puede devolver como un parámetro de dirección INOUT, dependiendo de las condiciones descritas en el punto 5.

Puede utilizarse una referencia (REFERENCE) a una variable escalar en la llamada (CALL) de un método Java, siempre que el tipo de datos de la variable a la que REFERENCE hace referencia coincida con el tipo de datos correspondiente en la signatura del programa Java.

Restricciones en las rutinas Java

Se aplican las restricciones siguientes a las rutinas Java llamadas desde ESQL:
  • El método Java debe tener seguridad de hebras (reentrante).
  • Las conexiones de base de datos deben ser JDBC tipo 2 o tipo 4. Además, las operaciones de base de datos no forman parte de una transacción de intermediario y, por consiguiente, no pueden ser controladas por un coordinador de recursos externo (como es el caso en un entorno XA).
  • La API de nodo definido por el usuario de Java sólo debe utilizarla la misma hebra que ha invocado el método Java.

    Puede crear hebras dentro del método. Sin embargo, las hebras creados no deben utilizar las API de Java y se debe devolver el control al intermediario.

    Todas las restricciones que se aplican al uso de la API de Java también se aplican a los métodos API Java llamados desde ESQL.

  • Los métodos Java que se llaman desde ESQL no deben utilizar la clase MbNode. Por tanto, no pueden crear objetos de tipo MbNode, ni llamar a ninguno de los métodos de un objeto MbNode existente.
  • El trabajo de WebSphere MQ o JMS realizado en un método Java llamado desde ESQL debe realizarse siguiendo las directrices para realizar el trabajo de WebSphere MQ y JMS en un nodo definido por el usuario. Inicio del cambioConsulte Planificación de nodos de entrada definidos por el usuario.Fin del cambio

Despliegue de clases Java

Puede desplegar las clases Java en un intermediario dentro de un archivo JAR (Java Archive), utilizando uno de los dos métodos siguientes:
  1. Añada el archivo JAR al archivo de archivado de intermediario (BAR)

    El método más eficiente y flexible de desplegar en el intermediario consiste en añadir el archivo JAR al archivo BAR. Puede realizar esta acción manualmente o automáticamente utilizando el entorno de trabajo.

    Si el entorno de trabajo encuentra la clase Java correcta en un proyecto Java al que se hace referencia abierto en el espacio de trabajo, compila automáticamente la clase Java en un archivo JAR y lo añade al archivo BAR. Este procedimiento es el mismo que se sigue para desplegar un nodo JavaCompute en un JAR, tal como se describe en Carga de clases de nodo definido por el usuario.

    Al desplegar un archivo JAR desde el entorno de trabajo, el flujo que se ha vuelto a desplegar vuelve a cargar el archivo JAR contenido en el archivo BAR.

    Los archivos también se vuelven a cargar si se detiene y se reinicia el flujo de mensajes que hace referencia a una clase Java. Asegúrese de detener y reiniciar (o volver a desplegar) todos los flujos que hacen referencia al archivo JAR que desea actualizar. Esta acción evita el problema de algunos flujos ejecutándose con la versión antigua del archivo JAR y otros flujos ejecutándose con la versión nueva.

    El entorno de trabajo sólo despliega archivos JAR; no despliega archivos de clase Java autónomos.

  2. Almacenar el archivo JAR en una de las ubicaciones siguientes:
    1. La carpeta víaAccesoTrabajo/shared-classes/ de la máquina que ejecuta el intermediario
    2. La variable de entorno CLASSPATH del sistema que ejecuta el intermediario

    Debe completar esta acción manualmente; no puede utilizar el entorno de trabajo.

    En este método, al desplegar de nuevo el flujo de mensajes no se vuelven a cargar las clases Java a las que se hace referencia; éstas tampoco se vuelven a cargar al detener y reiniciar el flujo de mensajes. En este caso, la única manera de volver a cargar las clases es detener y reiniciar el intermediario mismo.

Para permitir que el intermediario encuentre una clase Java, asegúrese de que esté en una de las ubicaciones anteriores. Si el intermediario no puede encontrar la clase especificada, genera una excepción.

Aunque tiene las opciones mostradas anteriormente al desplegar el archivo JAR, la utilización del entorno de trabajo para desplegar el archivo BAR proporciona la máxima flexibilidad al volver a desplegar el archivo JAR.

Rutinas de base de datos

CREATE FUNCTION no da soporte a las rutinas de base de datos. Utilice CREATE PROCEDURE para definir una rutina de base de datos.

Conceptos relacionados
Visión general de ESQL
Tareas relacionadas
Desarrollo de ESQL
Invocar procedimientos almacenados
Compilación de un nodo Java definido por el usuario
Adición de archivos a un archivador de intermediario
Referencia relacionada
Diagramas de sintaxis: tipos disponibles
Sentencias ESQL
Sentencia CALL
Sentencia CREATE PROCEDURE
Tabla de correlación de tipos de datos ESQL a Java
Información relacionada
API de extensiones Java definidas por el usuario
Avisos | Marcas registradas | Descargas | Biblioteca | Soporte | Su opinión

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
Última actualización : 2009-02-16 13:55:29

ak04960_