Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [INFORMATION] >  [SCHEMA] >  [INDEXES]
Private  Storage   

persistent class INFORMATION.SCHEMA.INDEXES extends %Library.Persistent

SQL Table Name: 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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 15


Summary

Properties
ASCORDESC COLUMNNAME INDEXCATALOG INDEXNAME
INDEXSCHEMA NONUNIQUE ORDINALPOSITION PRIMARYKEY
TABLECATALOG TABLENAME TABLESCHEMA

Methods
%AddToSaveSet %AddToSyncSet %CheckConstraints %CheckConstraintsForExtent
%ClassIsLatestVersion %ClassName %ComposeOid %ConstructClone
%Delete %DeleteExtent %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Exists %ExistsId
%Extends %GUID %GUIDSet %GetLock
%GetParameter %GetSwizzleObject %Id %IsA
%IsModified %IsNull %KillExtent %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnBeforeAddToSync %OnDetermineClass
%Open %OpenId %OriginalNamespace %PackageName
%PurgeIndices %Reload %RemoveFromSaveSet %ResolveConcurrencyConflict
%RollBack %Save %SaveDirect %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject


Parameters

• parameter READONLY = 1;
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 COLUMNNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = COLUMN_NAME ];
Name of column in the index.
• property INDEXCATALOG as %String(MAXLEN=128) [ Calculated,SqlFieldName = INDEX_CATALOG ];
Table qualifier - always NULL in InterSystems IRIS.
• property INDEXNAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = INDEX_NAME ];
Name of the index.
• 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 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 ORDINALPOSITION as %SmallInt [ SqlFieldName = ORDINAL_POSITION ];
Column sequence number in index (starting with 1).
• 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 TABLECATALOG as %String(MAXLEN=128) [ Calculated,SqlFieldName = TABLE_CATALOG ];
Table qualifier - always NULL in InterSystems IRIS.
• property TABLENAME as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = TABLE_NAME,Required ];
Name of the table.
• property TABLESCHEMA as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = TABLE_SCHEMA,Required ];
Name of schema that contains the table.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.