IDatabaseMetaData.GetColumns(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 table columns available in the specified catalog.

[Android.Runtime.Register("getColumns", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetColumns_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? GetColumns (string? catalog, string? schemaPattern, string? tableNamePattern, string? columnNamePattern);

[<Android.Runtime.Register("getColumns", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Ljava/sql/ResultSet;", "GetGetColumns_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 GetColumns : 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

tableNamePattern: String

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

columnNamePattern: String

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

Returns

IResultSet

ResultSet - each row is a column description

Attributes: RegisterAttribute

Exceptions

SQLException

if there is a database error.

Remarks

Retrieves a description of table columns available in the specified catalog.

Only column descriptions matching the catalog, schema, table and column name criteria are returned. They are ordered by TABLE_CAT,TABLE_SCHEM, TABLE_NAME, and ORDINAL_POSITION.

Each column description has the following columns: <OL> <LI>TABLE_CAT String => table catalog (may be null) <LI>TABLE_SCHEM String => table schema (may be null) <LI>TABLE_NAME String => table name <LI>COLUMN_NAME String => column name <LI>DATA_TYPE int => SQL type from java.sql.Types <LI>TYPE_NAME String => Data source dependent type name, for a UDT the type name is fully qualified <LI>COLUMN_SIZE int => column size. <LI>BUFFER_LENGTH is not used. <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 => is NULL allowed. <UL> <LI> columnNoNulls - might not allow NULL values <LI> columnNullable - definitely allows NULL values <LI> columnNullableUnknown - nullability unknown </UL> <LI>REMARKS String => comment describing column (may be null) <LI>COLUMN_DEF String => default value for the column, which should be interpreted as a string when the value is enclosed in single quotes (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 column in table (starting at 1) <LI>IS_NULLABLE String => ISO rules are used to determine the nullability for a column. <UL> <LI> YES --- if the column can include NULLs <LI> NO --- if the column cannot include NULLs <LI> empty string --- if the nullability for the column 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 the DATA_TYPE isn't REF) <LI>SCOPE_TABLE String => table name that this 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) <LI>IS_AUTOINCREMENT String => Indicates whether this column is auto incremented <UL> <LI> YES --- if the column is auto incremented <LI> NO --- if the column is not auto incremented <LI> empty string --- if it cannot be determined whether the column is auto incremented </UL> <LI>IS_GENERATEDCOLUMN String => Indicates whether this is a generated column <UL> <LI> YES --- if this a generated column <LI> NO --- if this not a generated column <LI> empty string --- if it cannot be determined whether this is a generated column </UL> </OL>

The COLUMN_SIZE column specifies the column size for the given 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.

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