Share via


IDatabaseMetaData.GetUDTs(String, String, String, Int32[]) Method

Definition

Retrieves a description of the user-defined types (UDTs) defined in a particular schema.

[Android.Runtime.Register("getUDTs", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;[I)Ljava/sql/ResultSet;", "GetGetUDTs_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_arrayIHandler:Java.Sql.IDatabaseMetaDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public Java.Sql.IResultSet? GetUDTs (string? catalog, string? schemaPattern, string? typeNamePattern, int[]? types);
[<Android.Runtime.Register("getUDTs", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;[I)Ljava/sql/ResultSet;", "GetGetUDTs_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_arrayIHandler:Java.Sql.IDatabaseMetaDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]
abstract member GetUDTs : string * string * string * int[] -> 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 pattern name; 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

typeNamePattern
String

a type name pattern; must match the type name as it is stored in the database; may be a fully qualified name

types
Int32[]

a list of user-defined types (JAVA_OBJECT, STRUCT, or DISTINCT) to include; null returns all types

Returns

ResultSet object in which each row describes a UDT

Attributes

Exceptions

a database error occurred.

Remarks

Retrieves a description of the user-defined types (UDTs) defined in a particular schema. Schema-specific UDTs may have type JAVA_OBJECT, STRUCT, or DISTINCT.

Only types matching the catalog, schema, type name and type criteria are returned. They are ordered by DATA_TYPE, TYPE_CAT, TYPE_SCHEM and TYPE_NAME. The type name parameter may be a fully-qualified name. In this case, the catalog and schemaPattern parameters are ignored.

Each type description has the following columns: <OL> <LI><B>TYPE_CAT</B> String => the type's catalog (may be null) <LI><B>TYPE_SCHEM</B> String => type's schema (may be null) <LI><B>TYPE_NAME</B> String => type name <LI><B>CLASS_NAME</B> String => Java class name <LI><B>DATA_TYPE</B> int => type value defined in java.sql.Types. One of JAVA_OBJECT, STRUCT, or DISTINCT <LI><B>REMARKS</B> String => explanatory comment on the type <LI><B>BASE_TYPE</B> short => type code of the source type of a DISTINCT type or the type that implements the user-generated reference type of the SELF_REFERENCING_COLUMN of a structured type as defined in java.sql.Types (null if DATA_TYPE is not DISTINCT or not STRUCT with REFERENCE_GENERATION = USER_DEFINED) </OL>

<B>Note:</B> If the driver does not support UDTs, an empty result set is returned.

Added in 1.2.

Java documentation for java.sql.DatabaseMetaData.getUDTs(java.lang.String, java.lang.String, java.lang.String, int[]).

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