This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


persistent class %Library.CompiledQuery extends %Library.Persistent

SQL Table Name: %Library.CompiledQuery

Note: The class definition classes in the %Library package have been superceded by those in the %Dictionary package.

This class represents a specific class query description for a compiled class contained within the Caché Dictionary.

For more information on class definition classes, refer to About Class Definition Classes.

Property Inventory (Including Private)

Method Inventory (Including Private)


property ClassName as %CacheString;
A string containing the name of the class the query belongs to.
Property methods: ClassNameGet(), ClassNameIsValid(), ClassNameSet()
property ContainId as %CacheString;
A flag indicating whether the query contains an ID column (1) or not (0).
Property methods: ContainIdGet(), ContainIdIsValid(), ContainIdSet()
property Name as %CacheString;
A string containing the name of the query.
Property methods: NameGet(), NameIsValid(), NameSet()
property RowSpec as %CacheString;
A string containing a comma-delimited list of the columns returned by the query.
Property methods: RowSpecGet(), RowSpecIsValid(), RowSpecSet()
property Type as %CacheString;
A string containing the name of the class used for the implementation of the query.
Property methods: TypeGet(), TypeIsValid(), TypeSet()


private classmethod %DeleteData(id As %String, concurrency As %Integer) as %Status
Inherited description: This method is normally generated by the storage class for persistent classes using %Library.CacheStorage or %Library.CacheSQLStorage. Persistent classes using some other storage class, such as %Library.CustomStorage must override this method.
private method %LoadData(queryId As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
private method %SaveData(id As %String) as %Status
Inherited description: %SaveData() - saves an object to disk, checks uniqueness and referential integrity constraints, and maintains index structures. This method is implemented by the storage class.
classmethod QueryInfoClose(QHandle As %Binary) as %Status
classmethod QueryInfoExecute(ByRef QHandle As %Binary, ClassName As %String) as %Status
classmethod QueryInfoFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status


query QueryInfo(ClassName As %String)
Selects Name, ContainId


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods (Including Private)