Share via


IDatabaseMetaData.GetProcedures(String, String, String) Method

Definition

Retrieves a description of the stored procedures available in the given catalog.

[Android.Runtime.Register("getProcedures", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetProcedures_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? GetProcedures (string? catalog, string? schemaPattern, string? procedureNamePattern);
[<Android.Runtime.Register("getProcedures", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetProcedures_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 GetProcedures : 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

procedureNamePattern
String

a procedure name pattern; must match the procedure name as it is stored in the database

Returns

ResultSet - each row is a procedure description

Attributes

Exceptions

a database error occurred.

Remarks

Retrieves a description of the stored procedures available in the given catalog.

Only procedure descriptions matching the schema and procedure name criteria are returned. They are ordered by PROCEDURE_CAT, PROCEDURE_SCHEM, PROCEDURE_NAME and SPECIFIC_ NAME.

Each procedure description has the the following columns: <OL> <LI><B>PROCEDURE_CAT</B> String => procedure catalog (may be null) <LI><B>PROCEDURE_SCHEM</B> String => procedure schema (may be null) <LI><B>PROCEDURE_NAME</B> String => procedure name <LI> reserved for future use <LI> reserved for future use <LI> reserved for future use <LI><B>REMARKS</B> String => explanatory comment on the procedure <LI><B>PROCEDURE_TYPE</B> short => kind of procedure: <UL> <LI> procedureResultUnknown - Cannot determine if a return value will be returned <LI> procedureNoResult - Does not return a return value <LI> procedureReturnsResult - Returns a return value </UL> <LI><B>SPECIFIC_NAME</B> String => The name which uniquely identifies this procedure within its schema. </OL>

A user may not have permissions to execute any of the procedures that are returned by getProcedures

Java documentation for java.sql.DatabaseMetaData.getProcedures(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