INDEXES Class Reference

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. More...

Inheritance diagram for INDEXES:

Collaboration diagram for INDEXES:

Public Attributes
	ASCORDESC
	Sort sequence for the column: "A" for ascending; "D" for descending. More...
	COLUMNNAME
	Name of column in the index. More...
	DATAFIELDS
	Comma-separated list of data field names stored in this index, which can be retrieved as part of an index lookup. More...
	INDEXCATALOG
	Table qualifier - always NULL in InterSystems IRIS. More...
	INDEXNAME
	Name of the index. More...
	INDEXSCHEMA
	Name of schema that contains the index. More...
	MAPSTATUS
	Status information on this index map, indicating whether it is selectable by the query optimizer or not. More...
	NONUNIQUE
	NON_UNIQUE indicates whether or not the index is a unique index. More...
	ORDINALPOSITION
	Column sequence number in index (starting with 1). More...
	PRIMARYKEY
	PRIMARY_KEY indicates whether or not the index is a primary key index. More...
	TABLECATALOG
	Table qualifier - always NULL in InterSystems IRIS. More...
	TABLENAME
	Name of the table. More...
	TABLESCHEMA
	Name of schema that contains the table. More...

Additional Inherited Members
Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...
_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...
_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...
_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...
Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...
_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...
_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)
_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)
_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...
	DEFAULTGLOBAL = None
	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...
	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
	USEEXTENTSET = None
	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

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.

Member Data Documentation

ASCORDESC

ASCORDESC

Sort sequence for the column: "A" for ascending; "D" for descending.

InterSystems IRIS only supports "A" sort sequences.

 

COLUMNNAME

COLUMNNAME

Name of column in the index.

 

DATAFIELDS

DATAFIELDS

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 (<property>COLUMNNAME</property>), but will repeat the list of data fields for each of those.  

INDEXCATALOG

INDEXCATALOG

Table qualifier - always NULL in InterSystems IRIS.

 

INDEXNAME

INDEXNAME

Name of the index.

 

INDEXSCHEMA

INDEXSCHEMA

Name of schema that contains the index.

Always the same as the TABLE_SCHEMA.

 

MAPSTATUS

MAPSTATUS

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()  

NONUNIQUE

NONUNIQUE

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).

 

ORDINALPOSITION

ORDINALPOSITION

Column sequence number in index (starting with 1).

 

PRIMARYKEY

PRIMARYKEY

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.

 

TABLECATALOG

TABLECATALOG

Table qualifier - always NULL in InterSystems IRIS.

 

TABLENAME

TABLENAME

Name of the table.

 

TABLESCHEMA

TABLESCHEMA

Name of schema that contains the table.