IDatabaseMetaData.GetFunctionColumns(String, String, String, String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves a description of the given catalog's system or user function parameters and return type.
[Android.Runtime.Register("getFunctionColumns", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetFunctionColumns_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_Handler:Java.Sql.IDatabaseMetaDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public Java.Sql.IResultSet? GetFunctionColumns (string? catalog, string? schemaPattern, string? functionNamePattern, string? columnNamePattern);[<Android.Runtime.Register("getFunctionColumns", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetFunctionColumns_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_Handler:Java.Sql.IDatabaseMetaDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member GetFunctionColumns : string * string * string * string -> Java.Sql.IResultSetParameters
- catalog
- String
a catalog name; must match the catalog name as it
is stored in the database; "" retrieves those without a catalog;
null means that the catalog name should not be used to narrow
the search
- schemaPattern
- String
a schema name pattern; must match the schema name
as it is stored in the database; "" retrieves those without a schema;
null means that the schema name should not be used to narrow
the search
- functionNamePattern
- String
a procedure name pattern; must match the function name as it is stored in the database
- columnNamePattern
- String
a parameter name pattern; must match the parameter or column name as it is stored in the database
Returns
ResultSet - each row describes a
user function parameter, column or return type
- Attributes
Exceptions
if any error occurs
Remarks
Retrieves a description of the given catalog's system or user function parameters and return type.
Only descriptions matching the schema, function and parameter name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME. Within this, the return value, if any, is first. Next are the parameter descriptions in call order. The column descriptions follow in column number order.
Each row in the ResultSet is a parameter description, column description or return type description with the following fields: <OL> <LI><B>FUNCTION_CAT</B> String => function catalog (may be null) <LI><B>FUNCTION_SCHEM</B> String => function schema (may be null) <LI><B>FUNCTION_NAME</B> String => function name. This is the name used to invoke the function <LI><B>COLUMN_NAME</B> String => column/parameter name <LI><B>COLUMN_TYPE</B> Short => kind of column/parameter: <UL> <LI> functionColumnUnknown - nobody knows <LI> functionColumnIn - IN parameter <LI> functionColumnInOut - INOUT parameter <LI> functionColumnOut - OUT parameter <LI> functionColumnReturn - function return value <LI> functionColumnResult - Indicates that the parameter or column is a column in the ResultSet</UL> <LI><B>DATA_TYPE</B> int => SQL type from java.sql.Types <LI><B>TYPE_NAME</B> String => SQL type name, for a UDT type the type name is fully qualified <LI><B>PRECISION</B> int => precision <LI><B>LENGTH</B> int => length in bytes of data <LI><B>SCALE</B> short => scale - null is returned for data types where SCALE is not applicable. <LI><B>RADIX</B> short => radix <LI><B>NULLABLE</B> short => can it contain NULL. <UL> <LI> functionNoNulls - does not allow NULL values <LI> functionNullable - allows NULL values <LI> functionNullableUnknown - nullability unknown </UL> <LI><B>REMARKS</B> String => comment describing column/parameter <LI><B>CHAR_OCTET_LENGTH</B> int => the maximum length of binary and character based parameters or columns. For any other datatype the returned value is a NULL <LI><B>ORDINAL_POSITION</B> int => the ordinal position, starting from 1, for the input and output parameters. A value of 0 is returned if this row describes the function's return value. For result set columns, it is the ordinal position of the column in the result set starting from 1. <LI><B>IS_NULLABLE</B> String => ISO rules are used to determine the nullability for a parameter or column. <UL> <LI> YES --- if the parameter or column can include NULLs <LI> NO --- if the parameter or column cannot include NULLs <LI> empty string --- if the nullability for the parameter or column is unknown </UL> <LI><B>SPECIFIC_NAME</B> String => the name which uniquely identifies this function within its schema. This is a user specified, or DBMS generated, name that may be different then the FUNCTION_NAME for example with overload functions </OL>
The PRECISION column represents the specified column size for the given parameter or column. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. Null is returned for data types where the column size is not applicable.
Added in 1.6.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.