%ExtentMgr.Catalog.Extent

hidden persistent class %ExtentMgr.Catalog.Extent extends %Library.Persistent [ Final ]

SQL Table Name: %ExtentMgr_Catalog.Extent

The Extent Manager Catalog classes model the extent metadata. Extent metadata is not part of the %Dictionary. Rather, extent metadata should be considered to be part of the data. Extent metadata describes the structure of persistent data. Extent metadata also includes information about the state of the data including selectivity information used by the query optimizer, the status of index structures and the current state of constraints on the extent.

An extent corresponds to an SQL table. The name of the extent is always the same as the class with a ".cls" extension. A class can only have one extent in a namespace but there can be extents for a class in many different namespaces.

Property Inventory

• Class
• ExtentSize
• Indices
• Name
• Properties
• ShardIdRanges
• SuperExtent
• TuneTable

Properties

property Class as %Dictionary.CompiledClass;

This property is a reference to the CompiledClass in the dictionary. This property might not always be set and it might not always swizzle when it is set. If this property value is not null and it will not swizzle it simply means the class that owns this extent is not currently compiled.

Property methods: ClassGet(), ClassGetObject(), ClassGetObjectId(), ClassGetStored(), ClassGetSwizzled(), ClassIsValid(), ClassNewObject(), ClassSet(), ClassSetObject(), ClassSetObjectId(), ClassUnSwizzle()

property ExtentSize as %RawString;

ExtentSize

Property methods: ExtentSizeGet(), ExtentSizeGetStored(), ExtentSizeIsValid(), ExtentSizeSet()

relationship Indices as array of %ExtentMgr.Catalog.Index [ InitialExpression = $listbuild("%ExtentMgr.Catalog.Index","Extent",+$this,"children",1,1) , Transient , Inverse = Extent , Cardinality = children ];

Property methods: IndicesGet(), IndicesGetObject(), IndicesGetObjectId(), IndicesGetSwizzled(), IndicesIsEmpty(), IndicesIsValid(), IndicesNewObject(), IndicesRClose(), IndicesRExec(), IndicesRFetch(), IndicesRelate(), IndicesSQLCompute(), IndicesSet(), IndicesUnRelate()

property Name as %String (MAXLEN = 255) [ Required ];

Extent name - this is normally the same as the name of the class bound to this extent with the addition of an extension of ".cls".

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

relationship Properties as array of %ExtentMgr.Catalog.Property [ InitialExpression = $listbuild("%ExtentMgr.Catalog.Property","Extent",+$this,"children",1,1) , Transient , Inverse = Extent , Cardinality = children ];

Property methods: PropertiesGet(), PropertiesGetObject(), PropertiesGetObjectId(), PropertiesGetSwizzled(), PropertiesIsEmpty(), PropertiesIsValid(), PropertiesNewObject(), PropertiesRClose(), PropertiesRExec(), PropertiesRFetch(), PropertiesRelate(), PropertiesSQLCompute(), PropertiesSet(), PropertiesUnRelate()

relationship ShardIdRanges as array of %ExtentMgr.Catalog.ShardIdRanges [ InitialExpression = $listbuild("%ExtentMgr.Catalog.ShardIdRanges","Extent",+$this,"children",1,1) , Transient , Inverse = Extent , Cardinality = children ];

Property methods: ShardIdRangesGet(), ShardIdRangesGetObject(), ShardIdRangesGetObjectId(), ShardIdRangesGetSwizzled(), ShardIdRangesIsEmpty(), ShardIdRangesIsValid(), ShardIdRangesNewObject(), ShardIdRangesRClose(), ShardIdRangesRExec(), ShardIdRangesRFetch(), ShardIdRangesRelate(), ShardIdRangesSQLCompute(), ShardIdRangesSet(), ShardIdRangesUnRelate()

property SuperExtent as %ExtentMgr.Catalog.Extent;

If this extent is a subextent then SuperExtent is a reference to this extent's parent. If SuperExtent is empty then this extent is a root extent.

Property methods: SuperExtentGet(), SuperExtentGetObject(), SuperExtentGetObjectId(), SuperExtentGetStored(), SuperExtentGetSwizzled(), SuperExtentIsValid(), SuperExtentNewObject(), SuperExtentSet(), SuperExtentSetObject(), SuperExtentSetObjectId(), SuperExtentUnSwizzle()

property TuneTable as %Integer;

Property methods: TuneTableDisplayToLogical(), TuneTableGet(), TuneTableGetStored(), TuneTableIsValid(), TuneTableLogicalToDisplay(), TuneTableNormalize(), TuneTableSet()

Indexes

index (C on Class) [Unique];

Index methods: CCheck(), CCheckUnique(), CDelete(), CExists(), COpen(), CSQLCheckUnique(), CSQLExists(), CSQLFindPKeyByConstraint(), CSQLFindRowIDByConstraint(), ClassGet(), ClassGetObject(), ClassGetObjectId(), ClassGetStored(), ClassGetSwizzled(), ClassIsValid(), ClassNewObject(), ClassSet(), ClassSetObject(), ClassSetObjectId(), ClassUnSwizzle()

index (IDK on Name) [IdKey, Type = key];

Index methods: IDKCheck(), IDKDelete(), IDKExists(), IDKOpen(), IDKSQLCheckUnique(), IDKSQLExists(), IDKSQLFindPKeyByConstraint(), IDKSQLFindRowIDByConstraint()