CREATE FUNCTION statement

The CREATE FUNCTION statement defines a callable function or procedure.

You can also use the CREATE PROCEDURE statement to define a callable function or procedure, also known as a routine.

Syntax

Read syntax diagramSkip visual syntax diagramCREATERoutineType RoutineName(ParameterList )ReturnTypeLanguageResultSetRoutineBody
RoutineType
Read syntax diagramSkip visual syntax diagramFUNCTIONPROCEDURE
ParameterList
Read syntax diagramSkip visual syntax diagram,Parameter
Parameter
Read syntax diagramSkip visual syntax diagramIN1OUTINOUTParameterNameCONSTANTDataTypeNAMESPACE2NAMENULLABLENOT NULL
ReturnType
Read syntax diagramSkip visual syntax diagramRETURNSDataType NULLABLENOT NULL
Language
Read syntax diagramSkip visual syntax diagramLANGUAGE ESQLDATABASE3.NETCLRJAVA
ResultSet
Read syntax diagramSkip visual syntax diagramDYNAMIC RESULT SETSinteger
RoutineBody
Read syntax diagramSkip visual syntax diagramStatementEXTERNALNAMEExternalRoutineName.NetTypeInfoJavaClassLoaderService
.NetTypeInfo
Read syntax diagramSkip visual syntax diagramASSEMBLYAssemblyName 4APPDOMAINDomainNameVERSIONVersionCULTURECulturePUBLICKEYTOKENPublicKeyToken
JavaClassLoaderService
Read syntax diagramSkip visual syntax diagramCLASSLOADERClassLoaderConfigurableServiceName
Notes:
  • 1 If the routine type is FUNCTION, the direction indicator (IN, OUT, or INOUT) is optional for each parameter. However, for documentation purposes, it is good programming practice to specify a direction indicator for all new routines; if you do not specify the direction, a default value of IN is used.
  • 2 When the NAMESPACE or NAME clause is used, its value is implicitly CONSTANT and of type CHARACTER. For information about the use of CONSTANT variables, see the DECLARE statement.
  • 3 If the routine type is FUNCTION, you cannot specify a LANGUAGE of DATABASE.
  • 4 Each can be specified once only.

Overview

The CREATE FUNCTION and CREATE PROCEDURE statements define a callable function or procedure, also known as a routine.

In previous versions of this product, CREATE FUNCTION and CREATE PROCEDURE had different uses and different capabilities. Subsequent enhancements have resulted in the differences listed previously in notes 1 and 3.

Routines are useful for creating reusable blocks of code that can be run independently many times. You can implement them as a series of ESQL statements, a Java™ method, a .NET method, or a database stored procedure. This flexibility means that some of the clauses in the syntax diagram are not applicable (or allowed) for all types of routine.

Each routine has a name, which must be unique within the schema to which it belongs. Routine names therefore cannot be overloaded; if the integration node detects that a routine name has been overloaded, it raises an exception.

The LANGUAGE clause specifies the language the routines body is written in. The options are:
DATABASE
The procedure is called as a database stored procedure.
ESQL
The procedure is called as an ESQL routine.
.NET
The routine is called as a method on a class in the .NET run time.
CLR
The routine is called as a method on a class in the .NET run time and is a synonym for LANGUAGE.NET.
JAVA
The procedure is called as a static method in a Java class.
Unspecified
If you do not specify the LANGUAGE clause, the default language is ESQL unless you specify the EXTERNAL NAME clause (in which case, the default language is DATABASE).
Restrictions on the use of the LANGUAGE clause exist. You cannot use:
  • The ESQL option with an EXTERNAL NAME clause
  • The DATABASE or JAVA options without an EXTERNAL NAME clause
  • The DATABASE option with a routine type of FUNCTION

Specify the name of the routine by using the RoutineName clause, and its parameters by using the ParameterList clause. If the LANGUAGE clause specifies ESQL, implement the routine by using a single ESQL statement. This statement is most useful if it is a compound statement (BEGIN ... END), because it can then contain as many ESQL statements as necessary to fulfill its function.

Alternatively, instead of providing an ESQL body for the routine, you can specify a LANGUAGE clause other than ESQL. You can then use the EXTERNAL NAME clause to provide a reference to the actual body of the routine, wherever it is located externally to the integration node. For more information about using the EXTERNAL NAME clause, see Invoking stored procedures and Calling a Java routine.

Routines of any LANGUAGE type can have IN, OUT, and INOUT parameters. The caller can pass several values into the routine, and receive back several updated values. These returned parameters are in addition to any RETURNS clause that you have defined for the routine. The RETURNS clause defines the value that the routine returns to the caller.

Routines that are implemented in different languages have their own restrictions on which data types can be passed in or returned; these restrictions are documented later in this section. The data type of the returned value must match the data type of the value that is defined to be returned from the routine. Also, if a routine is defined to have a return value, the caller of the routine cannot ignore it. For more information, see CALL statement.

Routines can be defined in either a module or a schema. Routines that are defined in a module are local in scope to the current node, which means that only code belonging to that same module (or node) can invoke them. Routines that are defined in a schema, however, can be invoked by using either of the following options:
  • Code in the same schema
  • Code in any other schema, if either of the following conditions applies:
    • The other schemas PATH clause contains the path to the called routine
    • The called routine is invoked by using its fully qualified name (which is its name, prefixed by its schema name, separated by a period)
Thus, if you need to invoke the same routine in more than one node, define it in a schema.

For any language or routine type, the method of invocation of the routine must match the manner of declaration of the routine. If the routine has a RETURNS clause, use either the FUNCTION invocation syntax or a CALL statement with an INTO clause. Conversely, if a routine has no RETURNS clause, you must use a CALL statement without an INTO clause.

Parameter directions

Parameters that are passed to routines always have a direction associated with them, which is one of the following types:
IN
The value of the parameter cannot be changed by the routine. A NULL value for the parameter is allowed, and can be passed to the routine.
OUT
When it is received by the called routine, the parameter that is passed into the routine always has a NULL value of the correct data type. This value is set irrespective of its value before the routine is called. The routine is allowed to change the value of the parameter.
INOUT
INOUT is both an IN and an OUT parameter. It passes a value into the routine, and the value that is passed in can be changed by the routine. A NULL value for the parameter is allowed, and can be passed both into and out of the routine.
NULLABLE
This optional clause indicates the value of the parameter is allowed to contain a NULL value. NULL is the default clause if this clause is omitted, unless the NOT NULL clause is specified.
NOT NULL
This optional clause indicates the value of the parameter cannot contain a NULL value. If a parameter is marked as NOT NULL and a NULL value is passed on the call, an exception is thrown. Note: Currently this clause can be used only with LANGUAGE CLR or LANGUAGE .NET.

If the routine type is FUNCTION, the direction indicator (IN, OUT, INOUT) is optional for each parameter. However, it is good programming practice to specify a direction indicator for all new routines of any type for documentation purposes.

ESQL variables that are declared to be CONSTANT (or references to variables declared to be CONSTANT) are not allowed to have the direction OUT or INOUT.

ESQL routines

ESQL routines are written in ESQL, and have a LANGUAGE clause of ESQL. The body of an ESQL routine is typically a compound statement of the form BEGIN … END, that contains multiple statements for processing the parameters that are passed to the routine.

ESQL example 1

The following example shows the same procedure as in Database routine example 1, but is implemented as an ESQL routine and not as a stored procedure. The CALL syntax and results of this routine are the same as found in:
CREATE PROCEDURE swapParms (
  IN parm1 CHARACTER,
  OUT parm2  CHARACTER,
  INOUT parm3 CHARACTER )
BEGIN
   SET parm2 = parm3;
   SET parm3 = parm1;
 END; 

ESQL example 2

This example procedure shows the recursive use of an ESQL routine. It parses a tree, visiting all places at and below the specified starting point, and reports what it has found:

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;

When given the following input message:

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

the procedure produces the following output, which has been manually formatted:

  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

.NET routines

A .NET routine is implemented as a .NET method, and has a LANGUAGE clause of .NET or CLR. For .NET routines, the ExternalRoutineName must contain the class name and method name of the .NET method to be called. Specify the ExternalRoutineName like this example:

>>--"-- className---.---methodName--"--------------><
Where className identifies the class that contains the method and methodName identifies the method to invoke. If the class is part of a Namespace or is a nested class, the class identifier part must include all Namespace and nested class names; for example,IBM.Broker.test.MyOuterClass.MyNestedClass.MyMethod

To find the .NET class, the integration node searches the GAC and the AppDomain base location for the specified assembly.

Any .NET method that you want to invoke must be a public static method. In addition, all parameters must be listed in ESQL-to-.NET data-type mapping tables. Also, if the method has a return type, the return type must be listed in the IN data type mapping table.

The .NET methods signature must match the ESQL routines declaration of the method. You must also observe the following rules:
  • Ensure that the .NET method name, including the class name and any Namespace qualifiers, matches the ESQL procedures EXTERNAL NAME.
  • If the .NET method does not have a return type, do not put a RETURNS clause on the ESQL routines definition. Conversely, if the .NET method does have a return type, you must put a RETURNS clause on the ESQL routines definition.
  • Ensure that every parameters type and direction matches the ESQL declaration, according to the rules listed in ESQL-to-.NET data-type mapping tables.
  • Ensure that the methods return type matches the data type of the RETURNS clause.
  • Enclose EXTERNAL NAME in quotation marks because it must contain at least "Class.Method".
  • If you want to invoke an overloaded .NET method, you must create a separate ESQL definition for each overloaded method and give each ESQL definition a unique routine name.
.NET Type Info
The clause in the .NET Type Info section applies only to LANGUAGE .NET routines.
ASSEMBLY
The ASSEMBLY indicates the .NET assembly that the method to be invoked resides in. If the assembly resides in the GAC, it can simply be the assembly name (for example, "MyAssembly"). However, if the assembly is not in the GAC, it needs to contain the fully qualified path to the assembly.
APPDOMAIN
This parameter provides the name of the APPDOMAIN in which to load the assembly and execute the method. If this clause is omitted, the APPDOMAIN is set to the name of the application that the flow belongs to. If the flow does not belong to an application, the APPDOMAIN is set to the name of the message flow.
VERSION
This provides the exact version of the assembly to be loaded. If the version is omitted, the first version found of the named assembly is used.
CULTURE
This provides the ability to specify an exact culture for the assembly. The default is to use the "neutral" culture.
PUBLICKEYTOKEN
If the assembly to be loaded resides in the GAC, its public key token needs to be provided. However, if the assembly does not reside in the GAC, this clause is optional. When searching for an assembly, the search order is as defined by the .NET framework, the full details of which are listed in MSDN. However, the abridged version states; If the assembly name is not fully qualified, the base for the AppDomain is used. If the assembly name is fully qualified (that is the version and public key token have been specified), the GAC is searched before the App Domains base folder.

.NET routine example 1

Defines a procedure representing a .NET Method that returns a System:String with three parameters of varying directions.
CREATE PROCEDURE Swap ( 
       IN a INT NOT NULL, 
       OUT b INT NOT NULL, 
       INOUT c INT NOT NULL ) RETURNS CHARACTER NOT NULL
LANGUAGE .NET
EXTERNAL NAME "FunctionTests.SwapString"
ASSEMBLY "C:\coding\test projects\MyAssembly"
APPDOMAIN "MyDomain";
The following ESQL can be used to invoke Swap.
CALL Swap( intVar1, intVar2, intVar3 ) INTO ReturnVar;
-- or
SET ReturnVar = Swap ( intVar1, intVar2, intVar3);

.NET routine example 2

Defines a procedure representing a .NET Method that has no return value with three Nullable parameters of varying directions.

CREATE PROCEDURE SwapNullable ( 
       IN a INTEGER NULLABLE, 
       OUT b INTEGER NULLABLE, 
       INOUT c INTEGER NULLABLE )
LANGUAGE CLR
EXTERNAL NAME "FunctionTests.SwapStringNullable"
ASSEMBLY "MyAssembly2"
APPDOMAIN "MyDomain";
The following ESQL must be used to invoke SwapNullable.
CALL SwapNullable(intVar1, intVar2, intVar3);

Example code for various .NET languages providing methods for both examples

C#

public class FunctionTests
{

  public static string Swap(int pIn, out int pOut, ref int pInout)
  {
    pOut = pInout;
    pInout = pIn;
    return "Finished";
  }

  public static void SwapNullable(long? pIn, out long? pOut, ref long? pInout)
  {
    pOut = pInout;
    pInout = pIn;
  }

}

VB

Public Class FunctionTests

  Shared Function Swap(ByVal pIn As Integer, <Out()> ByRef pOut As Integer, ByRef pInout As Integer) As String
    pOut = pInout
    pInout = pIn
    Return "Finished"
  End Function

  Shared Sub SwapNullable(ByVal pIn As Long?, ByRef pOut As Long?, ByRef pInout As Long?)
    pOut = pInout
    pInout = pIn
  End Sub

End Class

F#

module FunctionTests

  let Swap( pIn : int, [<Out>] pOut : byref<int> ,  pInOut : byref<int> ) = (
    pOut <- pInout
    pInout <- pIn
    let temp = "Finished"
    temp
  )

  let SwapNullable(  pIn : Nullable<int64>, [<Out>] pOut : byref<Nullable<int64>> ,  pInOut : byref<Nullable<int64>> ) = (
    pOut <- pInout
    pInout)
  )

C++ / CLi

public ref class FunctionTests
{
public:

  static String^ Swap(int pIn, [Out] int% pOut, int% pInout)
  {
    pOut = pInout;
    pInout = pIn;
    String^ temp = "Finished";
    return temp;
  }

  static void SwapNullable(Nullable<long long> pIn, [Out] Nullable<long long>% pOut, Nullable<long long>% pInout)
  {
    pOut = pInout;
    pInout = pIn;
  }
}

Java routines

A Java routine is implemented as a Java method, and has a LANGUAGE clause of JAVA. For Java routines, the ExternalRoutineName must contain the class name and method name of the Java method to be called. Specify the ExternalRoutineName value as shown in the following example:
>>--"-- className---.---methodName--"--------------><
where className identifies the class that contains the method, and methodName identifies the method to call. If the class is part of a package, the class identifier part must include the complete package prefix; for example: com.ibm.broker.test.MyClass.myMethod

To find the Java class, the integration node uses the search method that is described in Deploying Java classes.

Any Java method that you want to call must have the following basic signature:
public static <return-type> <method-name> (< 0 - N parameters>)

Where <return-type> must be in the list of Java IN data types in the table in ESQL to Java data type mapping (excluding the REFERENCE type, which is not permitted as a return value), or the Java void data type. The parameter data types must also be in the ESQL to Java data type mapping table. In addition, the Java method must not have exception throws clause in its signature.

The Java methods signature must match the ESQL routines declaration of the method. You must also observe the following rules:
  • Ensure that the Java method name, including the class name and any package qualifiers, matches the procedures EXTERNAL NAME.
  • If the Java return type is void, do not put a RETURNS clause on the ESQL routines definition. Conversely, if the Java return type is not void, you must put a RETURNS clause on the ESQL routines definition.
  • Ensure that every parameters type and direction matches the ESQL declaration, according to the rules listed in the table in ESQL to Java data type mapping.
  • Ensure that the methods return type matches the data type of the RETURNS clause.
  • Enclose EXTERNAL NAME in quotation marks because it must contain at least "class.method".
  • If you want to call an overloaded Java method, you must create a separate ESQL definition for each overloaded method and give each ESQL definition a unique routine name.

The clause in the JavaClassLoader section applies only to LANGUAGE JAVA routines. The CLASSLOADER clause is optional; if you do not specify this clause, the Java class is loaded by the EGShared classloader. For more information, see JavaCompute node class loading and JavaClassLoader configurable service.

You can use the Java user-defined node API in your Java method, if you observe the restrictions documented in Restrictions on Java routines. For more information about using the Java API, see Compiling a Java user-defined node.

Java routine example 1

This routine contains three parameters of varying directions, and returns an integer, which maps to a Java return type of 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";

You can use the following ESQL to invoke myProc1:

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

Java routine example 2

This routine contains three parameters of varying directions and has a Java return type of void.

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

You must use the following ESQL to invoke myProc2:

CALL myProc2(intVar1, intVar2, intVar3);

The following Java class provides a method for each of the preceding Java examples:

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

 /* When either of these methods is called:
    P1 might or might not be NULL (depending on the value of intVar1).
    P2[0] is always NULL (whatever the value of intVar2).
    P3[0] might or might not be NULL (depending on the value of intVar3).  
    This is the same as with LANGUAGE ESQL routines. 
    When these methods return:
         intVar1 is unchanged
         intVar2 might still be NULL or might have been changed
         intVar3 might contain the same value or might have been changed.
     This is the same as with LANGUAGE ESQL routines.
     
    When myMethod1 returns: intReturnVar3 is either  NULL (if the
    method returns NULL) or it contains the value returned by the 
    method.
 */
}

Java routine example 3

The following example has a LANGUAGE clause of JAVA and specifies an EXTERNAL NAME for a Java method named myMethod1 in class com.ibm.broker.test.MyClass. It also specifies a JavaClassLoader configurable service named myClassLoader to use for loading the Java class com.ibm.broker.test.MyClass.
CREATE FUNCTION myMethod1 ( IN P1 INTEGER, IN P2 INTEGER )
  RETURNS INTEGER
  LANGUAGE JAVA
  EXTERNAL NAME "com.ibm.broker.test.MyClass.myMethod1"
  CLASSLOADER "myClassLoader";

Java routine example 4

The following example shows how to access a Java class in a referenced shared library called MyJava.
CREATE PROCEDURE CallJava(IN VAL1 CHARACTER) 
  RETURNS CHARACTER 
  LANGUAGE JAVA 
  EXTERNAL NAME "com.ibm.test.esql.StaticJavaMethods.basicTransform" 
  CLASSLOADER "{MyJava}";
    
You can also have a Java classloader configurable service that shares the same name as a shared library. In this case, omit the braces around the configurarable service name when you specify the CLASSLOADER value. In the following example, the Java classloader configurable service is called MyJava:
CREATE PROCEDURE CallJava(IN VAL1 CHARACTER) 
  RETURNS CHARACTER 
  LANGUAGE JAVA 
  EXTERNAL NAME "com.ibm.test.esql.StaticJavaMethods.basicTransform" 
  CLASSLOADER "MyJava";
    

ESQL to Java data type mapping

The following table summarizes the mappings from ESQL to Java.
Notes:
  • Only the Java scalar wrappers are passed to Java.
  • The ESQL scalar types are mapped to Java data types as object wrappers, or object wrapper arrays, depending upon the direction of the procedure parameter. Each wrapper array contains exactly one element.
  • Scalar object wrappers are used to allow NULL values to be passed to and from Java methods.
ESQL data types 1 Java IN data types Java INOUT and OUT data types
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 Not supported Not supported
BOOLEAN java.lang.Boolean java.lang.Boolean[]
REFERENCE (to a message tree) 3 4 5 6 com.ibm.broker.plugin.MbElement com.ibm.broker.plugin.MbElement[] (Supported for INOUT. Not supported for OUT)
ROW Not supported Not supported
LIST Not supported Not supported
  1. Variables that are declared to be CONSTANT (or references to variables that are declared to be CONSTANT) are not allowed to have the direction INOUT or OUT.
  2. The time zone set in the Java variable is not important; you obtain the required time zone in the output ESQL.
  3. The reference parameter cannot be NULL when passed into a Java method.
  4. The reference cannot have the direction OUT when passed into a Java method.
  5. If an MbElement is passed back from Java to ESQL as an INOUT parameter, it must point to a location in the same message tree as that pointed to by the MbElement that was passed into the called Java method.

    For example, if an ESQL reference to OutputRoot.XML.Test is passed into a Java method as an INOUT MbElement, but a different MbElement is passed back to ESQL when the call returns, the different element must also point to somewhere in the OutputRoot tree.

  6. An MbElement cannot be returned from a Java method with the RETURNS clause, because no ESQL routine can return a reference. However, an MbElement can be returned as an INOUT direction parameter, subject to the conditions described in point 5.

A REFERENCE to a scalar variable can be used in the CALL of a Java method, provided that the data type of the variable to which the reference refers matches the corresponding data type in the Java program signature.

Restrictions on Java routines

The following restrictions apply to Java routines that are called from ESQL:
  • The Java method must be threadsafe (reentrant).
  • Database connections must be JDBC type 2 or type 4. Furthermore, database operations are not part of an integration node transaction and therefore cannot be controlled by an external resource coordinator (as is the case in an XA environment).
  • The Java user-defined node API must be used only by the same thread that invoked the Java method.

    You can create threads inside your method. However, created threads must not use the Java APIs, and you must return control back to the integration node.

    All restrictions that apply to the usage of the Java API also apply to Java methods that are called from ESQL.

  • Java methods that are called from ESQL must not use the MbNode class. Therefore, they cannot create objects of type MbNode, or call any of the methods on an existing MbNode object.
  • WebSphere® MQ or JMS work done inside a Java method that is called from ESQL must be done in accordance with the guidelines for performing WebSphere MQ and JMS work in a user-defined node. See Planning user-defined input nodes.

Deploying Java classes

You can deploy your Java classes to an integration node within a Java Archive (JAR) file, by using one of the following methods:
  • Add the JAR file to the BAR file

    The most efficient and flexible method of deploying to the integration node is to add your JAR file to the BAR file. You can do this manually or automatically using the IBM® Integration Toolkit.

    If the IBM Integration Toolkit finds the correct Java class inside a referenced Java project open in the workspace, it automatically compiles the Java class into a JAR file and adds it to the BAR file. This procedure is the same procedure that you follow to deploy a JavaCompute node inside a JAR, as described in User-defined node class loading.

    When you deploy a JAR file from the IBM Integration Toolkit, the flow that has been redeployed reloads the JAR file contained in the BAR file.

    The files are also reloaded if the message flow that references a Java class is stopped and restarted. There is no need to stop and restart flows or redeploy them, because the ESQL manager is refreshed when JAR file is redeployed and any subsequent external Java calls from ESQL use the new classloader. After the deploy has finished, all flows are running with the new version of the JAR file.

    The IBM Integration Toolkit deploys only JAR files; it does not deploy stand-alone Java class files.

  • Add the Java classes to a shared library

    To share Java classes between multiple solutions, store your Java classes in a shared library. When you deploy the shared library, either directly to the integration server or in a BAR file, the Java classes are packaged into a JAR file. If you update the Java classes and redeploy the shared library, the updated Java classes are automatically available to any applications that refer to that shared library.

  • Store the JAR file in either of the following locations:
    • The workpath/shared-classes/ folder on the computer that is running the integration node
    • The CLASSPATH environment variable on the computer that is running the integration node

      You must complete this action manually; you cannot use the IBM Integration Toolkit.

      In this method, redeploying the message flow does not reload the referenced Java classes; neither does stopping and restarting the message flow. The only way to reload the classes in this case is to stop and restart the integration node itself.

      To enable the integration node to find a Java class, ensure that it is in one of the preceding locations. If the integration node cannot find the specified class, it generates an exception.

Although you have the choices shown previously when you deploy the JAR file, by using the IBM Integration Toolkit to deploy the BAR file provides the greatest flexibility when redeploying the JAR file.

Database routines

CREATE FUNCTION does not support database routines. Use CREATE PROCEDURE to define a database routine.