8.6.61 getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern)
- Organization of this subsection
(1) Function
This method acquires information about stored procedure parameters.
(2) Format
public synchronized ResultSet getProcedureColumns(String catalog, String schemaPattern, String procedureNamePattern, String columnNamePattern) throws SQLException
(3) Arguments
- String catalog
-
Specifies a catalog name. This argument is ignored, if specified.
- String schemaPattern
-
Specifies a schema name pattern. This argument is ignored, if specified.
- String procedureNamePattern
-
Specifies a procedure name pattern. This argument is ignored, if specified.
- String columnNamePattern
-
Specifies a parameter name pattern. This argument is ignored, if specified.
(4) Return value
This method always returns a ResultSet object that contains no retrieval result rows. The following table shows the format of the ResultSet object that is returned.
Column No. |
Type |
Column name |
Description |
---|---|---|---|
1 |
String |
PROCEDURE_CAT |
Catalog name |
2 |
String |
PROCEDURE_SCHEM |
Schema name |
3 |
String |
PROCEDURE_NAME |
Procedure name |
4 |
String |
COLUMN_NAME |
Parameter name |
5 |
short |
COLUMN_TYPE |
Parameter type |
6 |
int |
DATA_TYPE |
Parameter's SQL type |
7 |
String |
TYPE_NAME |
Parameter's SQL type name |
8 |
int |
PRECISION |
Parameter's precision |
9 |
int |
LENGTH |
Parameter size |
10 |
short |
SCALE |
Parameter scaling |
11 |
short |
RADIX |
Radix of parameter |
12 |
short |
NULLABLE |
Whether the null value can be used |
13 |
String |
REMARKS |
Comment related to the parameter |
14 |
String |
COLUMN_DEF |
Column's default value |
15 |
int |
SQL_DATA_TYPE |
Reserved for future use |
16 |
int |
SQL_DATETIME_SUB |
Reserved for future use |
17 |
int |
CHAR_OCTET_LENGTH |
Maximum length of a binary or character-based parameter or column |
18 |
int |
ORDINAL_POSITION |
Order of input and output parameters (beginning with 1) |
19 |
String |
IS_NULLABLE |
Whether the null value is permitted in the parameter or column |
20 |
String |
SPECIFIC_NAME |
Name that uniquely identifies this procedure |
(5) Exceptions
If this Connection object is closed before this method is executed, the JDBC driver throws an SQLException.