This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %SYS.PTools.SQLUtilResults

%SYS.PTools.SQLUtilResults

persistent class %SYS.PTools.SQLUtilResults extends %Library.Persistent

SQL Table Name: %SYS_PTools.SQLUtilResults

This class is used by methods in %SYS.PTools.SQLUtilites to temporarily store the results of different Options. The data must be generated by running one of the class methods: IndexUsage, TableScans, TempIndices or IndexJoins the data in this table is deleted when GatherStats is run

Property Inventory (Including Private)

Properties (Including Private)

property BlockCount as %Integer;
Property methods: BlockCountDisplayToLogical(), BlockCountGet(), BlockCountGetStored(), BlockCountIsValid(), BlockCountLogicalToDisplay(), BlockCountNormalize(), BlockCountSet()
property Counter as %Integer [ InitialExpression = $I(^%sqlcq($NAMESPACE,"PTools","Utils","Results","D")) , Required ];
Property methods: CounterDisplayToLogical(), CounterGet(), CounterGetStored(), CounterIsValid(), CounterLogicalToDisplay(), CounterNormalize(), CounterSet()
property DataValues as list of %String;
Property methods: DataValuesBuildValueArray(), DataValuesCollectionToDisplay(), DataValuesCollectionToOdbc(), DataValuesDisplayToCollection(), DataValuesDisplayToLogical(), DataValuesGet(), DataValuesGetObject(), DataValuesGetObjectId(), DataValuesGetStored(), DataValuesGetSwizzled(), DataValuesIsValid(), DataValuesLogicalToDisplay(), DataValuesLogicalToOdbc(), DataValuesNormalize(), DataValuesOdbcToCollection(), DataValuesSet(), DataValuesSetObject(), DataValuesSetObjectId()
property ExtentSize as %Integer;
Property methods: ExtentSizeDisplayToLogical(), ExtentSizeGet(), ExtentSizeGetStored(), ExtentSizeIsValid(), ExtentSizeLogicalToDisplay(), ExtentSizeNormalize(), ExtentSizeSet()
property IndexFields as list of %String;
Property methods: IndexFieldsBuildValueArray(), IndexFieldsCollectionToDisplay(), IndexFieldsCollectionToOdbc(), IndexFieldsDisplayToCollection(), IndexFieldsDisplayToLogical(), IndexFieldsGet(), IndexFieldsGetObject(), IndexFieldsGetObjectId(), IndexFieldsGetStored(), IndexFieldsGetSwizzled(), IndexFieldsIsValid(), IndexFieldsLogicalToDisplay(), IndexFieldsLogicalToOdbc(), IndexFieldsNormalize(), IndexFieldsOdbcToCollection(), IndexFieldsSet(), IndexFieldsSetObject(), IndexFieldsSetObjectId()
property IndexName as %String;
Property methods: IndexNameDisplayToLogical(), IndexNameGet(), IndexNameGetStored(), IndexNameIsValid(), IndexNameLogicalToDisplay(), IndexNameLogicalToOdbc(), IndexNameNormalize(), IndexNameSet()
property JoinIndexFlag as %Integer;
Property methods: JoinIndexFlagDisplayToLogical(), JoinIndexFlagGet(), JoinIndexFlagGetStored(), JoinIndexFlagIsValid(), JoinIndexFlagLogicalToDisplay(), JoinIndexFlagNormalize(), JoinIndexFlagSet()
property MapType as %String;
Property methods: MapTypeDisplayToLogical(), MapTypeGet(), MapTypeGetStored(), MapTypeIsValid(), MapTypeLogicalToDisplay(), MapTypeLogicalToOdbc(), MapTypeNormalize(), MapTypeSet()
property ModuleName as %String;
Property methods: ModuleNameDisplayToLogical(), ModuleNameGet(), ModuleNameGetStored(), ModuleNameIsValid(), ModuleNameLogicalToDisplay(), ModuleNameLogicalToOdbc(), ModuleNameNormalize(), ModuleNameSet()
property OptionName as %String (VALUELIST = ",IU,TS,TI,JI,") [ Required ];
this property can have 4 different values: IndexUsage, TableScans, TempIndices, or IndexJoins
Property methods: OptionNameDisplayToLogical(), OptionNameGet(), OptionNameGetStored(), OptionNameIsValid(), OptionNameLogicalToDisplay(), OptionNameLogicalToOdbc(), OptionNameNormalize(), OptionNameSet()
property SQLPointer as %SYS.PTools.SQLUtilities;
Property methods: SQLPointerGet(), SQLPointerGetObject(), SQLPointerGetObjectId(), SQLPointerGetStored(), SQLPointerGetSwizzled(), SQLPointerIsValid(), SQLPointerNewObject(), SQLPointerSet(), SQLPointerSetObject(), SQLPointerSetObjectId(), SQLPointerUnSwizzle()
property SchemaName as %String;
Property methods: SchemaNameDisplayToLogical(), SchemaNameGet(), SchemaNameGetStored(), SchemaNameIsValid(), SchemaNameLogicalToDisplay(), SchemaNameLogicalToOdbc(), SchemaNameNormalize(), SchemaNameSet()
property TableName as %String;
Property methods: TableNameDisplayToLogical(), TableNameGet(), TableNameGetStored(), TableNameIsValid(), TableNameLogicalToDisplay(), TableNameLogicalToOdbc(), TableNameNormalize(), TableNameSet()
property UsageCount as %Integer;
Property methods: UsageCountDisplayToLogical(), UsageCountGet(), UsageCountGetStored(), UsageCountIsValid(), UsageCountLogicalToDisplay(), UsageCountNormalize(), UsageCountSet()

Indexes

index (Master on OptionName,Counter) [IdKey, Type = key];
Index methods: MasterCheck(), MasterDelete(), MasterExists(), MasterOpen(), MasterSQLCheckUnique(), MasterSQLExists(), MasterSQLFindPKeyByConstraint(), MasterSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (%SYS.PTools.SQLUtilResults)

^%sqlcq($NAMESPACE,"PTools","Utils","Results","D")(ID)
=
%%CLASSNAME
SchemaName
TableName
IndexName
TempIndex
UsageCount
DataValues
IndexFields
SQLPointer
ExtentSize
ModuleName
JoinIndexFlag
MapType
BlockCount
FeedbackOpens in a new window