Skip to main content

INFORMATION.SCHEMA.INDEXES

persistent class INFORMATION.SCHEMA.INDEXES extends %Library.Persistent [ Final ]

SQL Table Name: INFORMATION_SCHEMA.INDEXES

Returns one row for each indexed field in the current namespace for tables that can be accessed by the current user in the current namespace.

Property Inventory

Parameters

parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

property ASCORDESC as %String (COLLATION = "Upper", MAXLEN = 1) [ SqlFieldName = ASC_OR_DESC ];
Sort sequence for the column: "A" for ascending; "D" for descending. InterSystems IRIS only supports "A" sort sequences.
Property methods: ASCORDESCDisplayToLogical(), ASCORDESCGet(), ASCORDESCIsValid(), ASCORDESCLogicalToDisplay(), ASCORDESCLogicalToOdbc(), ASCORDESCNormalize(), ASCORDESCSet()
property COLUMNNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = COLUMN_NAME ];
Name of column in the index.
Property methods: COLUMNNAMEDisplayToLogical(), COLUMNNAMEGet(), COLUMNNAMEIsValid(), COLUMNNAMELogicalToDisplay(), COLUMNNAMELogicalToOdbc(), COLUMNNAMENormalize(), COLUMNNAMESet()
property DATAFIELDS as %String (COLLATION = "Upper", MAXLEN = 3200) [ Calculated , SqlFieldName = DATA_FIELDS ];
Comma-separated list of data field names stored in this index, which can be retrieved as part of an index lookup without requiring an additional master map lookup. Data field names are returned as delimited strings. Note that this table has one row for each indexed field (COLUMNNAME), but will repeat the list of data fields for each of those.
Property methods: DATAFIELDSCompute(), DATAFIELDSDisplayToLogical(), DATAFIELDSGet(), DATAFIELDSIsValid(), DATAFIELDSLogicalToDisplay(), DATAFIELDSLogicalToOdbc(), DATAFIELDSNormalize(), DATAFIELDSSQLCompute()
property INDEXCATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = INDEX_CATALOG ];
Table qualifier - always NULL in InterSystems IRIS.
Property methods: INDEXCATALOGCompute(), INDEXCATALOGDisplayToLogical(), INDEXCATALOGGet(), INDEXCATALOGIsValid(), INDEXCATALOGLogicalToDisplay(), INDEXCATALOGLogicalToOdbc(), INDEXCATALOGNormalize(), INDEXCATALOGSQLCompute()
property INDEXNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = INDEX_NAME ];
Name of the index.
Property methods: INDEXNAMEDisplayToLogical(), INDEXNAMEGet(), INDEXNAMEIsValid(), INDEXNAMELogicalToDisplay(), INDEXNAMELogicalToOdbc(), INDEXNAMENormalize(), INDEXNAMESet()
property INDEXSCHEMA as %String (COLLATION = "Upper", MAXLEN = 128) [ Calculated , SqlFieldName = INDEX_SCHEMA ];
Name of schema that contains the index. Always the same as the TABLE_SCHEMA.
Property methods: INDEXSCHEMACompute(), INDEXSCHEMADisplayToLogical(), INDEXSCHEMAGet(), INDEXSCHEMAIsValid(), INDEXSCHEMALogicalToDisplay(), INDEXSCHEMALogicalToOdbc(), INDEXSCHEMANormalize(), INDEXSCHEMASQLCompute()
property MAPSTATUS as %String (COLLATION = "SqlUpper", MAXLEN = 10) [ Calculated , SqlFieldName = MAP_STATUS ];
Status information on this index map, indicating whether it is selectable by the query optimizer or not. Map selectability can be controlled via $SYSTEM.SQL.Util.SetMapSelectablity()
Property methods: MAPSTATUSCompute(), MAPSTATUSDisplayToLogical(), MAPSTATUSGet(), MAPSTATUSIsValid(), MAPSTATUSLogicalToDisplay(), MAPSTATUSLogicalToOdbc(), MAPSTATUSNormalize(), MAPSTATUSSQLCompute()
property NONUNIQUE as %SmallInt [ SqlFieldName = NON_UNIQUE ];
NON_UNIQUE indicates whether or not the index is a unique index. Returns one of the following values:
  • 1 - If the index values can be nonunique (not a unique index).
  • 0 - if the index values must be unique (a unique index).
Property methods: NONUNIQUEDisplayToLogical(), NONUNIQUEGet(), NONUNIQUEIsValid(), NONUNIQUELogicalToDisplay(), NONUNIQUENormalize(), NONUNIQUESet()
property ORDINALPOSITION as %SmallInt [ SqlFieldName = ORDINAL_POSITION ];
Column sequence number in index (starting with 1).
Property methods: ORDINALPOSITIONDisplayToLogical(), ORDINALPOSITIONGet(), ORDINALPOSITIONIsValid(), ORDINALPOSITIONLogicalToDisplay(), ORDINALPOSITIONNormalize(), ORDINALPOSITIONSet()
property PRIMARYKEY as %SmallInt [ Calculated , SqlFieldName = PRIMARY_KEY ];
PRIMARY_KEY indicates whether or not the index is a primary key index. Returns one of the following values:
  • 1 - If the index values are the primary key values.
  • 0 - if the index values are not the primary key values.
Property methods: PRIMARYKEYCompute(), PRIMARYKEYDisplayToLogical(), PRIMARYKEYGet(), PRIMARYKEYIsValid(), PRIMARYKEYLogicalToDisplay(), PRIMARYKEYNormalize(), PRIMARYKEYSQLCompute()
property TABLECATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = TABLE_CATALOG ];
Table qualifier - always NULL in InterSystems IRIS.
Property methods: TABLECATALOGCompute(), TABLECATALOGDisplayToLogical(), TABLECATALOGGet(), TABLECATALOGIsValid(), TABLECATALOGLogicalToDisplay(), TABLECATALOGLogicalToOdbc(), TABLECATALOGNormalize(), TABLECATALOGSQLCompute()
property TABLENAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = TABLE_NAME , Required ];
Name of the table.
Property methods: TABLENAMEDisplayToLogical(), TABLENAMEGet(), TABLENAMEIsValid(), TABLENAMELogicalToDisplay(), TABLENAMELogicalToOdbc(), TABLENAMENormalize(), TABLENAMESet()
property TABLESCHEMA as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = TABLE_SCHEMA , Required ];
Name of schema that contains the table.
Property methods: TABLESCHEMADisplayToLogical(), TABLESCHEMAGet(), TABLESCHEMAIsValid(), TABLESCHEMALogicalToDisplay(), TABLESCHEMALogicalToOdbc(), TABLESCHEMANormalize(), TABLESCHEMASet()

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: SQLStorage

Maps: 2

  • Map number 1 is named Master

    thismap.Global: ^oddSQL

  • Map number 2 is named rxIndex

    thismap.Global: ^rINDEXSQL

  • ^oddSQL({SchemaExact},{TableExact},9,{Sequence})
    =
    Node Delimiter Piece Name
    TABLE_SCHEMA
    4 NON_UNIQUE
    6 INDEX_NAME
    8 ORDINAL_POSITION
    9 COLUMN_NAME
    10 ASC_OR_DESC
    ^rINDEXSQL("rv",$$UPPER({TABLE_SCHEMA}),$$UPPER({TABLE_NAME}),{Sequence})
    =
    Node Delimiter Piece Name
    TableExact
FeedbackOpens in a new tab