Home > Class Reference > %SYS namespace > %Dictionary.CompiledQuery


persistent class %Dictionary.CompiledQuery extends %Library.Persistent, %Dictionary.CompiledQueryQuery

SQL Table Name: %Dictionary.CompiledQuery

Property Inventory

Method Inventory


parameter SQLENABLED = 1;


property Cardinality as %Integer;
Property methods: CardinalityDisplayToLogical(), CardinalityGet(), CardinalityIsValid(), CardinalityLogicalToDisplay(), CardinalityNormalize(), CardinalitySet()
property ClientInfo as %RawString;
Property methods: ClientInfoGet(), ClientInfoIsValid(), ClientInfoSet()
property ClientName as %RawString;
Property methods: ClientNameGet(), ClientNameIsDefined(), ClientNameIsValid(), ClientNameReset(), ClientNameSet()
property ColCaptions as %RawString;
Property methods: ColCaptionsGet(), ColCaptionsIsValid(), ColCaptionsSet()
property ColNames as %RawString;
Property methods: ColNamesGet(), ColNamesIsValid(), ColNamesSet()
property CompilerGenerated as %Boolean;
Property methods: CompilerGeneratedDisplayToLogical(), CompilerGeneratedGet(), CompilerGeneratedIsValid(), CompilerGeneratedLogicalToDisplay(), CompilerGeneratedNormalize(), CompilerGeneratedSet()
property Deprecated as %Boolean;
True if this query is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsDefined(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedReset(), DeprecatedSet()
property Description as %RawString;
Specifies a description of the query.
Property methods: DescriptionGet(), DescriptionIsDefined(), DescriptionIsValid(), DescriptionReset(), DescriptionSet()
property ExtendedInfo as %RawString;
Property methods: ExtendedInfoGet(), ExtendedInfoIsValid(), ExtendedInfoSet()
property Final as %Boolean;
Specifies that subclasses cannot override the definition of the query.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsDefined(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalReset(), FinalSet()
property FormalSpec as %RawString;
Specifies the list of arguments passed to the Execute method. Each argument is of the format [&|*]<name>[:<type>][=<default>] where & means pass-by-reference and * means output-only.
Property methods: FormalSpecGet(), FormalSpecIsDefined(), FormalSpecIsValid(), FormalSpecParsedGet(), FormalSpecParsedIsValid(), FormalSpecParsedSet(), FormalSpecReset(), FormalSpecSet()
property FormalSpecParsed as %RawString;
Property methods: FormalSpecParsedGet(), FormalSpecParsedIsValid(), FormalSpecParsedSet()
property Id as %Integer;
Property methods: IdDisplayToLogical(), IdGet(), IdIsValid(), IdLogicalToDisplay(), IdNormalize(), IdSet()
property InheritedId as %Boolean;
Property methods: InheritedIdDisplayToLogical(), InheritedIdGet(), InheritedIdIsValid(), InheritedIdLogicalToDisplay(), InheritedIdNormalize(), InheritedIdSet()
property Internal as %Boolean;
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsDefined(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalReset(), InternalSet()
property KeywordError as %Boolean;
Property methods: KeywordErrorDisplayToLogical(), KeywordErrorGet(), KeywordErrorIsValid(), KeywordErrorLogicalToDisplay(), KeywordErrorNormalize(), KeywordErrorSet()
property KeywordModified as %Boolean;
Property methods: KeywordModifiedDisplayToLogical(), KeywordModifiedGet(), KeywordModifiedIsValid(), KeywordModifiedLogicalToDisplay(), KeywordModifiedNormalize(), KeywordModifiedSet()
relationship Methods as array of %Dictionary.CompiledQueryMethod [ InitialExpression = $listbuild("%Dictionary.CompiledQueryMethod","parent",+$this,"children",1,1) , Transient , Inverse = parent , Cardinality = children ];
Property methods: MethodsGet(), MethodsGetObject(), MethodsGetObjectId(), MethodsGetSwizzled(), MethodsIsEmpty(), MethodsIsValid(), MethodsNewObject(), MethodsRClose(), MethodsRExec(), MethodsRFetch(), MethodsRelate(), MethodsSQLCompute(), MethodsSet(), MethodsUnRelate()
property Name as %Dictionary.Identifier [ Required ];
The name of the query.
Property methods: NameGet(), NameIsDefined(), NameIsValid(), NameReset(), NameSet()
property NotInheritable as %Boolean;
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsDefined(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableReset(), NotInheritableSet()
property Origin as %RawString;
Property methods: OriginGet(), OriginIsValid(), OriginSet()
property Parameters as array of %RawString;
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property ParmNames as %RawString;
Property methods: ParmNamesGet(), ParmNamesIsValid(), ParmNamesSet()
property Private as %Boolean;
Property methods: PrivateDisplayToLogical(), PrivateGet(), PrivateIsDefined(), PrivateIsValid(), PrivateLogicalToDisplay(), PrivateNormalize(), PrivateReset(), PrivateSet()
property SequenceNumber as %Integer;
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsDefined(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberReset(), SequenceNumberSet()
property SoapBindingStyle as %RawString;
Specifies what type of SOAP invocation is used for a web method. This keyword is ignored for non-web methods.
Property methods: SoapBindingStyleGet(), SoapBindingStyleIsDefined(), SoapBindingStyleIsValid(), SoapBindingStyleReset(), SoapBindingStyleSet()
property SoapBodyUse as %RawString;
Specifies what kind of SOAP encoding is used for the inputs and outputs of a web method. This keyword is ignored for non-web methods.
Property methods: SoapBodyUseGet(), SoapBodyUseIsDefined(), SoapBodyUseIsValid(), SoapBodyUseReset(), SoapBodyUseSet()
property SoapNameSpace as %RawString;
Property methods: SoapNameSpaceGet(), SoapNameSpaceIsDefined(), SoapNameSpaceIsValid(), SoapNameSpaceReset(), SoapNameSpaceSet()
property SqlName as %RawString;
If this query is projected as an SQL stored procedure, then this name is used as the name of the stored procedure.
Property methods: SqlNameGet(), SqlNameIsDefined(), SqlNameIsValid(), SqlNameReset(), SqlNameSet()
property SqlProc as %Boolean;
Specifies that the query can be invoked as an SQL stored procedure.
Property methods: SqlProcDisplayToLogical(), SqlProcGet(), SqlProcIsDefined(), SqlProcIsValid(), SqlProcLogicalToDisplay(), SqlProcNormalize(), SqlProcReset(), SqlProcSet()
property SqlQuery as %RawString;
Specifies an SQL statement to be used for an SQL-based query.
Property methods: SqlQueryGenGet(), SqlQueryGenIsValid(), SqlQueryGenSet(), SqlQueryGet(), SqlQueryIsDefined(), SqlQueryIsValid(), SqlQueryReset(), SqlQuerySet()
property SqlQueryGen as %RawString;
Property methods: SqlQueryGenGet(), SqlQueryGenIsValid(), SqlQueryGenSet()
property SqlView as %Boolean;
Specifies whether to project this query as an SQL View.
Property methods: SqlViewDisplayToLogical(), SqlViewGet(), SqlViewIsDefined(), SqlViewIsValid(), SqlViewLogicalToDisplay(), SqlViewNameGet(), SqlViewNameIsDefined(), SqlViewNameIsValid(), SqlViewNameReset(), SqlViewNameSet(), SqlViewNormalize(), SqlViewReset(), SqlViewSet()
property SqlViewName as %RawString;
Specifies an SQL alias for the view projected from this query.
Property methods: SqlViewNameGet(), SqlViewNameIsDefined(), SqlViewNameIsValid(), SqlViewNameReset(), SqlViewNameSet()
property Type as %Dictionary.Classname;
Specifies the Query class used to provide the implementation of the query interface.
Property methods: TypeGet(), TypeIsDefined(), TypeIsValid(), TypeReset(), TypeSet()
property UserActualType as %RawString;
Property methods: UserActualTypeGet(), UserActualTypeIsValid(), UserActualTypeSet()
property WebMethod as %Boolean;
description=Specifies that this query can be invoked using the SOAP protocol.
Property methods: WebMethodDisplayToLogical(), WebMethodGet(), WebMethodIsDefined(), WebMethodIsValid(), WebMethodLogicalToDisplay(), WebMethodNormalize(), WebMethodReset(), WebMethodSet()
relationship parent as %Dictionary.CompiledClass [ Required , Inverse = Queries , Cardinality = parent ];
Pointer to the containing parent object
Property methods: parentCheck(), parentDelete(), parentGet(), parentGetObject(), parentGetObjectId(), parentGetSwizzled(), parentIsValid(), parentNewObject(), parentOnDelete(), parentRClose(), parentRExec(), parentRFetch(), parentRelate(), parentSQLCompute(), parentSet(), parentSetObject(), parentSetObjectId(), parentUnRelate(), parentUnSwizzle()


classmethod %Exists(oid As %ObjectIdentity) as %Boolean [ Language = objectscript ]
Inherited description: Checks to see if the object identified by the OID oid exists in the extent.

Returns %Boolean TRUE if it exists, FALSE if it does not.

classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status [ Language = objectscript ]
Inherited description: Obtain an exclusive or shared lock on the object identified by id. The type of lock obtained is determined by shared. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
classmethod %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status [ Language = objectscript ]
Inherited description: Release an exclusive or shared lock on the object identified by id. The type of lock released is determined by shared. If this method is not overridden then the default implementation returns an error. This method is normally generated by the storage class for persistent classes using %Storage.Persistent or %Storage.SQL.
method ClientNameIsDefined() as %Boolean [ Language = objectscript ]
method ClientNameReset() [ Language = objectscript ]
method ClientNameSet(value As %String = "") as %Status [ Language = objectscript ]
method DeprecatedIsDefined() as %Boolean [ Language = objectscript ]
method DeprecatedReset() [ Language = objectscript ]
method DeprecatedSet(value As %String = "") as %Status [ Language = objectscript ]
method DescriptionIsDefined() as %Boolean [ Language = objectscript ]
method DescriptionReset() [ Language = objectscript ]
method DescriptionSet(value As %String = "") as %Status [ Language = objectscript ]
method FinalIsDefined() as %Boolean [ Language = objectscript ]
method FinalReset() [ Language = objectscript ]
method FinalSet(value As %String = "") as %Status [ Language = objectscript ]
method FormalSpecIsDefined() as %Boolean [ Language = objectscript ]
method FormalSpecReset() [ Language = objectscript ]
method FormalSpecSet(value As %String = "") as %Status [ Language = objectscript ]
method InternalIsDefined() as %Boolean [ Language = objectscript ]
method InternalReset() [ Language = objectscript ]
method InternalSet(value As %String = "") as %Status [ Language = objectscript ]
method NameIsDefined() as %Boolean [ Language = objectscript ]
method NameReset() [ Language = objectscript ]
method NameSet(value As %String = "") as %Status [ Language = objectscript ]
method NotInheritableIsDefined() as %Boolean [ Language = objectscript ]
method NotInheritableReset() [ Language = objectscript ]
method NotInheritableSet(value As %String = "") as %Status [ Language = objectscript ]
method PrivateIsDefined() as %Boolean [ Language = objectscript ]
method PrivateReset() [ Language = objectscript ]
method PrivateSet(value As %String = "") as %Status [ Language = objectscript ]
method SequenceNumberIsDefined() as %Boolean [ Language = objectscript ]
method SequenceNumberReset() [ Language = objectscript ]
method SequenceNumberSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapBindingStyleIsDefined() as %Boolean [ Language = objectscript ]
method SoapBindingStyleReset() [ Language = objectscript ]
method SoapBindingStyleSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapBodyUseIsDefined() as %Boolean [ Language = objectscript ]
method SoapBodyUseReset() [ Language = objectscript ]
method SoapBodyUseSet(value As %String = "") as %Status [ Language = objectscript ]
method SoapNameSpaceIsDefined() as %Boolean [ Language = objectscript ]
method SoapNameSpaceReset() [ Language = objectscript ]
method SoapNameSpaceSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlNameReset() [ Language = objectscript ]
method SqlNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlProcIsDefined() as %Boolean [ Language = objectscript ]
method SqlProcReset() [ Language = objectscript ]
method SqlProcSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlQueryIsDefined() as %Boolean [ Language = objectscript ]
method SqlQueryReset() [ Language = objectscript ]
method SqlQuerySet(value As %String = "") as %Status [ Language = objectscript ]
method SqlViewIsDefined() as %Boolean [ Language = objectscript ]
method SqlViewNameIsDefined() as %Boolean [ Language = objectscript ]
method SqlViewNameReset() [ Language = objectscript ]
method SqlViewNameSet(value As %String = "") as %Status [ Language = objectscript ]
method SqlViewReset() [ Language = objectscript ]
method SqlViewSet(value As %String = "") as %Status [ Language = objectscript ]
method TypeIsDefined() as %Boolean [ Language = objectscript ]
method TypeReset() [ Language = objectscript ]
method TypeSet(value As %String = "") as %Status [ Language = objectscript ]
method WebMethodIsDefined() as %Boolean [ Language = objectscript ]
method WebMethodReset() [ Language = objectscript ]
method WebMethodSet(value As %String = "") as %Status [ Language = objectscript ]
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status [ Language = objectscript ]


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


trigger OnDelete (BEFORE event DELETE);
trigger OnInsertUpdate (BEFORE event INSERT/UPDATE);

Inherited Members

Inherited Methods

FeedbackOpens in a new window