DB2_PROCEDURE_COLUMNS(3) 1 DB2_PROCEDURE_COLUMNS(3)
db2_procedure_columns - Returns a result set listing stored procedure parameters
SYNOPSIS
resource db2_procedure_columns (resource $connection, string $qualifier, string $schema, string $procedure, string $parameter)
DESCRIPTION
Returns a result set listing the parameters for one or more stored procedures.
PARAMETERS
o $connection
- A valid connection to an IBM DB2, Cloudscape, or Apache Derby database.
o $qualifier
- A qualifier for DB2 databases running on OS/390 or z/OS servers. For other databases, pass NULL or an empty string.
o $schema
- The schema which contains the procedures. This parameter accepts a search pattern containing _ and % as wildcards.
o $procedure
- The name of the procedure. This parameter accepts a search pattern containing _ and % as wildcards.
o $parameter
- The name of the parameter. This parameter accepts a search pattern containing _ and % as wildcards. If this parameter is NULL,
all parameters for the specified stored procedures are returned.
RETURN VALUES
Returns a statement resource with a result set containing rows describing the parameters for the stored procedures matching the specified
parameters. The rows are composed of the following columns:
+---------------------------+---------------------------------------------------+
| Column name | |
| | |
| | Description |
| | |
+---------------------------+---------------------------------------------------+
| PROCEDURE_CAT | |
| | |
| | The catalog that contains the procedure. The |
| | value is NULL if this table does not have cata- |
| | logs. |
| | |
| PROCEDURE_SCHEM | |
| | |
| | Name of the schema that contains the stored pro- |
| | cedure. |
| | |
| PROCEDURE_NAME | |
| | |
| | Name of the procedure. |
| | |
| COLUMN_NAME | |
| | |
| | Name of the parameter. |
| | |
| COLUMN_TYPE | |
| | |
| | An integer value representing the type of the |
| | parameter: |
| | |
| | box, tab (|); c | c | . T{ Return value |
| | |
| | Parameter type |
| | |
+---------------------------+---------------------------------------------------+
| 1 (SQL_PARAM_INPUT) | |
| | |
| | Input (IN) parameter. |
| | |
|2 (SQL_PARAM_INPUT_OUTPUT) | |
| | |
| | Input/output (INOUT) parameter. |
| | |
| 3 (SQL_PARAM_OUTPUT) | |
| | |
| | Output (OUT) parameter. |
| | |
+---------------------------+---------------------------------------------------+
T} T{ DATA_TYPE
T} |T{ The SQL data type for the parameter represented as an integer value.
T} T{ TYPE_NAME
T} |T{ A string representing the data type for the parameter.
T} T{ COLUMN_SIZE
T} |T{ An integer value representing the size of the parameter.
T} T{ BUFFER_LENGTH
T} |T{
Maximum number of bytes necessary to store data for this parameter.
T} T{ DECIMAL_DIGITS
T} |T{
The scale of the parameter, or NULL where scale is not applicable.
T} T{ NUM_PREC_RADIX
T} |T{
An integer value of either 10 (representing an exact numeric data type), 2 (representing an approximate numeric data type), or NULL (rep-
resenting a data type for which radix is not applicable).
T} T{ NULLABLE
T} |T{ An integer value representing whether the parameter is nullable or not.
T} T{ REMARKS
T} |T{ Description of the parameter.
T} T{ COLUMN_DEF
T} |T{ Default value for the parameter.
T} T{ SQL_DATA_TYPE
T} |T{ An integer value representing the size of the parameter.
T} T{ SQL_DATETIME_SUB
T} |T{
Returns an integer value representing a datetime subtype code, or NULL for SQL data types to which this does not apply.
T} T{ CHAR_OCTET_LENGTH
T} |T{
Maximum length in octets for a character data type parameter, which matches COLUMN_SIZE for single-byte character set data, or NULL for
non-character data types.
T} T{ ORDINAL_POSITION
T} |T{ The 1-indexed position of the parameter in the CALL statement.
T} T{ IS_NULLABLE
T} |T{
A string value where 'YES' means that the parameter accepts or returns NULL values and 'NO' means that the parameter does not accept or
return NULL values.
T}
SEE ALSO
db2_column_privileges(3), db2_columns(3), db2_foreign_keys(3), db2_primary_keys(3), db2_procedures(3), db2_special_columns(3), db2_statis-
tics(3), db2_table_privileges(3), db2_tables(3).
PHP Documentation Group DB2_PROCEDURE_COLUMNS(3)