Java.Sql.IDatabaseMetaData.GetIndexInfo Method
Returns a list of indices and statistics for a specified table.

Syntax

[Android.Runtime.Register("getIndexInfo", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ZZ)Ljava/sql/ResultSet;", "GetGetIndexInfo_Ljava_lang_String_Ljava_lang_String_Ljava_lang_String_ZZHandler:Java.Sql.IDatabaseMetaDataInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]
public IResultSet GetIndexInfo (string catalog, string schema, string table, bool unique, bool approximate)

Parameters

catalog
a catalog name. null is used to imply no narrowing of the search by catalog name. Otherwise, the name must match a catalog name held in the database, with "" used to retrieve those without a catalog name.
schema
a schema name. null is used to imply no narrowing of the search by schema name. Otherwise, the name must match a schema name in the database, with "" used to retrieve those without a schema name.
table
a table name, which must match the name of a table in the database.
unique
true means only return indices for unique values, false implies that they can be returned even if not unique.
approximate
true implies that the list can contain approximate or "out of data" values, false implies that all values must be precisely accurate

Returns

Documentation for this section has not yet been entered.

Exceptions

TypeReason
Java.Sql.SQLExceptiona database error occurred.

Remarks

Returns a list of indices and statistics for a specified table.

The list is returned as a ResultSet, with one row for each index or statistic. The list is ordered by NON_UNIQUE, TYPE, INDEX_NAME, and ORDINAL_POSITION. Each row has the following format:

  1. TABLE_CAT - String - table catalog name (possibly null)
  2. TABLE_SCHEM - String - table schema name (possibly null)
  3. TABLE_NAME - String - The table name
  4. NON_UNIQUE - boolean - true when index values can be non-unique. Must be false when the TYPE is tableIndexStatistic
  5. INDEX_QUALIFIER - String : index catalog name. null when the TYPE is 'tableIndexStatistic'
  6. INDEX_NAME - String : index name. null when TYPE is 'tableIndexStatistic'
  7. TYPE - short - the index type. One of:
    • DatabaseMetaData.tableIndexStatistic - table statistics returned with Index descriptions
    • DatabaseMetaData.tableIndexClustered - a clustered Index
    • DatabaseMetaData.tableIndexHashed - a hashed Index
    • DatabaseMetaData.tableIndexOther - other style of Index
    • ORDINAL_POSITION - short - column sequence within Index. 0 when TYPE is tableIndexStatistic
    • COLUMN_NAME - String - the column name. null when TYPE is tableIndexStatistic
    • ASC_OR_DESC - String - column sort sequence. null if sequencing not supported or TYPE is tableIndexStatistic; otherwise "A" means sort ascending and "D" means sort descending.
    • CARDINALITY - int - Number of unique values in the Index. If TYPE is tableIndexStatistic, this is number of rows in the table.
    • PAGES - int - Number of pages for current Index. If TYPE is tableIndexStatistic, this is number of pages used for the table.
    • FILTER_CONDITION - String - Filter condition. (possibly null)

    [Android Documentation]

    Requirements

    Namespace: Java.Sql
    Assembly: Mono.Android (in Mono.Android.dll)
    Assembly Versions: 0.0.0.0
    Since: Added in API level 1