8.6.31 getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern)

(1) Function

This method returns information about the function's parameters and the types that are returned.

To Page Top

(2) Format

public synchronized ResultSet getFunctionColumns(String catalog, String schemaPattern, String functionNamePattern, String columnNamePattern) throws SQLException

To Page Top

(3) Arguments

String catalog

Specifies a catalog name. This argument is ignored, if specified.

String schemaPattern

Specifies a schema name pattern. This argument is case sensitive.

String functionNamePattern

Specifies a function name pattern. This argument is case sensitive.

String columnNamePattern

Specifies a parameter name pattern. This argument is case sensitive.

To Page Top

(4) Return value

This method always returns a ResultSet object that contains no rows of retrieval results. The following table shows the format of the ResultSet object that is returned.

Table 8‒51: Format of the ResultSet object that is returned

Column No.	Type	Column name	Description
1	String	FUNCTION_CAT	Catalog name
2	String	FUNCTION_SCHEM	Authorization identifier name
3	String	FUNCTION_NAME	Function name
4	String	COLUMN_NAME	Column or parameter name
5	short	COLUMN_TYPE	Column type or parameter
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 (number of decimal places)
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	int	CHAR_OCTET_LENGTH	Maximum length of a binary or character-based parameter or column
15	int	ORDINAL_POSITION	Order of input and output parameters (beginning with 1) For a function's return value, 0 is returned.
16	String	IS_NULLABLE	Whether the null value is permitted in the parameter or column
17	String	SPECIFIC_NAME	Name that uniquely identifies this function within the schema

To Page Top

(5) Exceptions

If this Connection object is closed before this method is executed, the JDBC driver throws an SQLException.

To Page Top