IDatabaseMetaData.GetFunctions(String, String, String) Method

Definition

Retrieves a description of the system and user functions available in the given catalog.

[Android.Runtime.Register("getFunctions", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetFunctions_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? GetFunctions (string? catalog, string? schemaPattern, string? functionNamePattern);
[<Android.Runtime.Register("getFunctions", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetFunctions_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 GetFunctions : string * string * string -> Java.Sql.IResultSet

Parameters

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 function name pattern; must match the function name as it is stored in the database

Returns

ResultSet - each row is a function description

Attributes

Exceptions

if any error occurs

Remarks

Retrieves a description of the system and user functions available in the given catalog.

Only system and user function descriptions matching the schema and function name criteria are returned. They are ordered by FUNCTION_CAT, FUNCTION_SCHEM, FUNCTION_NAME and SPECIFIC_ NAME.

Each function description has the the following columns: <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>REMARKS</B> String => explanatory comment on the function <LI><B>FUNCTION_TYPE</B> short => kind of function: <UL> <LI>functionResultUnknown - Cannot determine if a return value or table will be returned <LI> functionNoTable- Does not return a table <LI> functionReturnsTable - Returns a table </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>

A user may not have permission to execute any of the functions that are returned by getFunctions

Added in 1.6.

Java documentation for java.sql.DatabaseMetaData.getFunctions(java.lang.String, java.lang.String, java.lang.String).

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.

Applies to