getProcedures( catalog, schemaPattern, procedureNamePattern )

Previous Next

Gets a description of a set of stored procedures available in a catalog.

The set of procedures returned is optionally restricted by criteria for catalog, schema and procedure names. The procedures are returned ordered by procedure schema and procedure name.

Each procedure description has the the following columns:

PROCEDURE_CAT

String

procedure catalog (may be null)

PROCEDURE_SCHEM

String

procedure schema (may be null)

PROCEDURE_NAME

String

procedure name

REMARKS

String

explanatory comment on the procedure

PROCEDURE_TYPE

short

kind of procedure:

procedureResultUnknown - May return a result

procedureNoResult - Does not return a result

procedureReturnsResult - Returns a result

Syntax

getProcedures( string catalog, string schemaPattern, string procedureNamePattern )

 

Parameters

catalog

The catalog that the procedure is in

schemaPattern

The schema that the procedure is in

procedureNamePattern

The name of the procedure

If catalog is "" (the empty string), only procedures without a catalog are returned.

If catalog is the null value, catalog names are not part of the selection criteria.

If schemaPattern is "" (the empty string), only procedures without a schema are returned.