db2_procedures

(PECL)

db2_procedures --  Returns a result set listing the stored procedures registered in a database

Description

resource db2_procedures ( resource connection, string qualifier, string schema, string procedure )

Returns a result set listing the stored procedures registered in a database.

Parameters

connection

A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.

qualifier

A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass NULL or an empty string.

schema

The schema which contains the procedures. This parameter accepts a search pattern containing _ and % as wildcards.

procedure

The name of the procedure. This parameter accepts a search pattern containing _ and % as wildcards.

Return Values

Returns a statement resource with a result set containing rows describing the stored procedures matching the specified parameters. The rows are composed of the following columns:

Column nameDescription
PROCEDURE_CATThe catalog that contains the procedure. The value is NULL if this table does not have catalogs.
PROCEDURE_SCHEMName of the schema that contains the stored procedure.
PROCEDURE_NAMEName of the procedure.
NUM_INPUT_PARAMSNumber of input (IN) parameters for the stored procedure.
NUM_OUTPUT_PARAMSNumber of output (OUT) parameters for the stored procedure.
NUM_RESULT_SETSNumber of result sets returned by the stored procedure.
REMARKSAny comments about the stored procedure.
PROCEDURE_TYPEAlways returns 1, indicating that the stored procedure does not return a return value.

See Also

db2_column_privileges()
db2_columns()
db2_foreign_keys()
db2_primary_keys()
db2_procedure_columns()
db2_special_columns()
db2_statistics()
db2_table_privileges()
db2_tables()