No cache version.
Caching disabled. Default setting for this page:enabled (code LNG204)
If the display is too slow, you can disable the user mode to view the cached version.
db2_procedure_columns
(PECL ibm_db2 >= 1.0.0)
db2_procedure_columns — Returns a result set listing stored procedure parameters
Description
$connection
, string $qualifier
, string $schema
, string $procedure
, string $parameter
) : resourceReturns a result set listing the parameters for one or more stored procedures.
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.
-
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 catalogs. |
||||||||
PROCEDURE_SCHEM | Name of the schema that contains the stored procedure. | ||||||||
PROCEDURE_NAME | Name of the procedure. | ||||||||
COLUMN_NAME | Name of the parameter. | ||||||||
COLUMN_TYPE |
An integer value representing the type of the parameter:
|
||||||||
DATA_TYPE | The SQL data type for the parameter represented as an integer value. | ||||||||
TYPE_NAME | A string representing the data type for the parameter. | ||||||||
COLUMN_SIZE | An integer value representing the size of the parameter. | ||||||||
BUFFER_LENGTH | Maximum number of bytes necessary to store data for this parameter. | ||||||||
DECIMAL_DIGITS |
The scale of the parameter, or NULL where scale is not applicable.
|
||||||||
NUM_PREC_RADIX |
An integer value of either 10 (representing
an exact numeric data type), 2 (representing an
approximate numeric data type), or NULL (representing a data type for
which radix is not applicable).
|
||||||||
NULLABLE | An integer value representing whether the parameter is nullable or not. | ||||||||
REMARKS | Description of the parameter. | ||||||||
COLUMN_DEF | Default value for the parameter. | ||||||||
SQL_DATA_TYPE | An integer value representing the size of the parameter. | ||||||||
SQL_DATETIME_SUB |
Returns an integer value representing a datetime subtype code,
or NULL for SQL data types to which this does not apply.
|
||||||||
CHAR_OCTET_LENGTH |
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.
|
||||||||
ORDINAL_POSITION | The 1-indexed position of the parameter in the CALL statement. | ||||||||
IS_NULLABLE |
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.
|
See Also
- db2_column_privileges() - Returns a result set listing the columns and associated privileges for a table
- db2_columns() - Returns a result set listing the columns and associated metadata for a table
- db2_foreign_keys() - Returns a result set listing the foreign keys for a table
- db2_primary_keys() - Returns a result set listing primary keys for a table
- db2_procedures() - Returns a result set listing the stored procedures registered in a database
- db2_special_columns() - Returns a result set listing the unique row identifier columns for a table
- db2_statistics() - Returns a result set listing the index and statistics for a table
- db2_table_privileges() - Returns a result set listing the tables and associated privileges in a database
- db2_tables() - Returns a result set listing the tables and associated metadata in a database
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-db2-procedure-columns.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.