IDatabaseMetaData.GetAttributes(String, String, String, String) Method

Reference

Definition

Namespace:: Java.Sql

Assembly:: Mono.Android.dll

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 attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.

[Android.Runtime.Register("getAttributes", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetAttributes_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? GetAttributes (string? catalog, string? schemaPattern, string? typeNamePattern, string? attributeNamePattern);

[<Android.Runtime.Register("getAttributes", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetAttributes_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 GetAttributes : string * 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

typeNamePattern: String

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

attributeNamePattern: String

an attribute name pattern; must match the attribute name as it is declared in the database

Returns

IResultSet

a ResultSet object in which each row is an attribute description

Attributes: RegisterAttribute

Exceptions

SQLException

if there is a database error.

Remarks

Retrieves a description of the given attribute of the given type for a user-defined type (UDT) that is available in the given schema and catalog.

Descriptions are returned only for attributes of UDTs matching the catalog, schema, type, and attribute name criteria. They are ordered by TYPE_CAT, TYPE_SCHEM, TYPE_NAME and ORDINAL_POSITION. This description does not contain inherited attributes.

The ResultSet object that is returned has the following columns: <OL> <LI>TYPE_CAT String => type catalog (may be null) <LI>TYPE_SCHEM String => type schema (may be null) <LI>TYPE_NAME String => type name <LI>ATTR_NAME String => attribute name <LI>DATA_TYPE int => attribute type SQL type from java.sql.Types <LI>ATTR_TYPE_NAME String => Data source dependent type name. For a UDT, the type name is fully qualified. For a REF, the type name is fully qualified and represents the target type of the reference type. <LI>ATTR_SIZE int => column size. For char or date types this is the maximum number of characters; for numeric or decimal types this is precision. <LI>DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable. <LI>NUM_PREC_RADIX int => Radix (typically either 10 or 2) <LI>NULLABLE int => whether NULL is allowed <UL> <LI> attributeNoNulls - might not allow NULL values <LI> attributeNullable - definitely allows NULL values <LI> attributeNullableUnknown - nullability unknown </UL> <LI>REMARKS String => comment describing column (may be null) <LI>ATTR_DEF String => default value (may be null) <LI>SQL_DATA_TYPE int => unused <LI>SQL_DATETIME_SUB int => unused <LI>CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column <LI>ORDINAL_POSITION int => index of the attribute in the UDT (starting at 1) <LI>IS_NULLABLE String => ISO rules are used to determine the nullability for a attribute. <UL> <LI> YES --- if the attribute can include NULLs <LI> NO --- if the attribute cannot include NULLs <LI> empty string --- if the nullability for the attribute is unknown </UL> <LI>SCOPE_CATALOG String => catalog of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) <LI>SCOPE_SCHEMA String => schema of table that is the scope of a reference attribute (null if DATA_TYPE isn't REF) <LI>SCOPE_TABLE String => table name that is the scope of a reference attribute (null if the DATA_TYPE isn't REF) <LI>SOURCE_DATA_TYPE short => source type of a distinct type or user-generated Ref type,SQL type from java.sql.Types (null if DATA_TYPE isn't DISTINCT or user-generated REF) </OL>

Added in 1.4.

Java documentation for java.sql.DatabaseMetaData.getAttributes(java.lang.String, 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