Command Reference

INVOKE STORED PROCEDURE

Invokes a procedure stored at the location of a database. Also known as the Database Application Remote Interface (DARI). The server procedure executes at the location of the database, and returns data to the client application.

The application programmer designs the program to run in two parts, one on the client and the other on the server. The server procedure at the database runs within the same transaction as the client application. If the client application and the server procedure are on the same node, the server procedure is executed locally.
Note: This command has been replaced by the SQL CALL statement (see the SQL Reference). SQL CALL cannot be used from within the CLP.

Authorization

CONNECT privilege on a database.

Required Connection

Database

Command Syntax

>>-INVOKE--program-name----+---------------------------+-------><
                           '-USING--server-input-data--'

Note:

Do not use INVOKE to call server procedures that use input or output SQLDA structures, including server procedures that return data. For more information, see the Application Development Guide.

Command Parameters

program-name

Specifies the procedure to be run on the server. This parameter can be specified in one of the following ways:

By a procName with no extensions. This notation tells the database manager to load a DARI library named procName into memory. It is assumed that the name of the function routine to be executed is identical to the library name. For example,
```
   db2 invoke foo
```
will load the DARI library named FOO and execute the function routine FOO() within the library.
The database manager will find the DARI libraries in the default directory $HOME/sqllib/function of the instance owner.
By the exclamation sign (!) delimited name, as in procName!funcName. This notation tells the database manager to load a DARI library, named procName, into memory. The function routine to be executed is funcName. This convention allows similar function routines to be packaged in the same DARI library.
By an absolute path name, as in /u/cche/procName!/funcName, for example. This notation includes the storage path of the DARI library. In this example, the DARI library named procName is stored in the directory /u/cche. The function routine to be executed is funcName.

Note: To support portability between various versions of DB2 products, the ! delimiter can be replaced by the backslash (\) delimiter.

USING server-input-data

Specifies any information that is passed to the server routine. A variable character string, free form, flexible parameter that can be used to transmit input data according to specific needs.

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

[ DB2 List of Books | Search the DB2 Books ]