This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

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

%Dictionary.QueryDefinition

persistent class %Dictionary.QueryDefinition extends %Library.Persistent, %Dictionary.QueryDefinitionQuery

SQL Table Name: %Dictionary.QueryDefinition

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter SQLENABLED = 1;

Properties (Including Private)

property ClientName as %CacheString;
ClientName
Property methods: ClientNameGet(), ClientNameIsValid(), ClientNameSet()
property Deprecated as %Boolean [ InitialExpression = 0 ];
True if this query is deprecated.
Property methods: DeprecatedDisplayToLogical(), DeprecatedGet(), DeprecatedIsValid(), DeprecatedLogicalToDisplay(), DeprecatedNormalize(), DeprecatedSet()
property Description as %CacheString;
Specifies a description of the query.
Property methods: DescriptionGet(), DescriptionIsValid(), DescriptionSet()
property Final as %Boolean [ InitialExpression = 0 ];
Specifies that subclasses cannot override the definition of the query.
Property methods: FinalDisplayToLogical(), FinalGet(), FinalIsValid(), FinalLogicalToDisplay(), FinalNormalize(), FinalSet()
property FormalSpec as %CacheString;
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(), FormalSpecIsValid(), FormalSpecSet()
property Internal as %Boolean [ InitialExpression = 0 ];
If true, then do not display this item in automatic documentation.
Property methods: InternalDisplayToLogical(), InternalGet(), InternalIsValid(), InternalLogicalToDisplay(), InternalNormalize(), InternalSet()
property Name as %Dictionary.CacheIdentifier [ Required ];
The name of the query.
Property methods: NameGet(), NameIsValid(), NameSet()
property NotInheritable as %Boolean [ InitialExpression = 0 ];
Deprecated
Property methods: NotInheritableDisplayToLogical(), NotInheritableGet(), NotInheritableIsValid(), NotInheritableLogicalToDisplay(), NotInheritableNormalize(), NotInheritableSet()
property Parameters as array of %CacheString;
Parameter
Property methods: ParametersBuildValueArray(), ParametersCollectionToDisplay(), ParametersCollectionToOdbc(), ParametersDisplayToCollection(), ParametersGet(), ParametersGetObject(), ParametersGetObjectId(), ParametersGetSwizzled(), ParametersIsValid(), ParametersOdbcToCollection(), ParametersSet(), ParametersSetObject(), ParametersSetObjectId()
property Private as %Boolean [ InitialExpression = 0 ];
Deprecated.
Property methods: PrivateDisplayToLogical(), PrivateGet(), PrivateIsValid(), PrivateLogicalToDisplay(), PrivateNormalize(), PrivateSet()
property SequenceNumber as %Integer [ InitialExpression = 0 ];
SequenceNumber
Property methods: SequenceNumberDisplayToLogical(), SequenceNumberGet(), SequenceNumberIsValid(), SequenceNumberLogicalToDisplay(), SequenceNumberNormalize(), SequenceNumberSet()
property SoapBindingStyle as %CacheString;
Specifies what type of SOAP invocation is used for a web method. This keyword is ignored for non-web methods.
Property methods: SoapBindingStyleGet(), SoapBindingStyleIsValid(), SoapBindingStyleSet()
property SoapBodyUse as %CacheString;
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(), SoapBodyUseIsValid(), SoapBodyUseSet()
property SoapNameSpace as %CacheString;
SoapNameSpace
Property methods: SoapNameSpaceGet(), SoapNameSpaceIsValid(), SoapNameSpaceSet()
property SqlName as %CacheString;
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(), SqlNameIsValid(), SqlNameSet()
property SqlProc as %Boolean [ InitialExpression = 0 ];
Specifies that the query can be invoked as an SQL stored procedure.
Property methods: SqlProcDisplayToLogical(), SqlProcGet(), SqlProcIsValid(), SqlProcLogicalToDisplay(), SqlProcNormalize(), SqlProcSet()
property SqlQuery as %CacheString;
Specifies an SQL statement to be used for an SQL-based query.
Property methods: SqlQueryGet(), SqlQueryIsValid(), SqlQuerySet()
property SqlView as %Boolean [ InitialExpression = 0 ];
Specifies whether to project this query as an SQL View.
Property methods: SqlViewDisplayToLogical(), SqlViewGet(), SqlViewIsValid(), SqlViewLogicalToDisplay(), SqlViewNameGet(), SqlViewNameIsValid(), SqlViewNameSet(), SqlViewNormalize(), SqlViewSet()
property SqlViewName as %CacheString;
Specifies an SQL alias for the view projected from this query.
Property methods: SqlViewNameGet(), SqlViewNameIsValid(), SqlViewNameSet()
property Type as %Dictionary.CacheClassname;
Specifies the Query class used to provide the implementation of the query interface.
Property methods: TypeGet(), TypeIsValid(), TypeSet()
property WebMethod as %Boolean [ InitialExpression = 0 ];
description=Specifies that this query can be invoked using the SOAP protocol.
Property methods: WebMethodDisplayToLogical(), WebMethodGet(), WebMethodIsValid(), WebMethodLogicalToDisplay(), WebMethodNormalize(), WebMethodSet()
relationship parent as %Dictionary.ClassDefinition [ 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()

Methods (Including Private)

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.
classmethod %Exists(oid As %ObjectIdentity) as %Boolean
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.

private method %LoadData(id As %String) as %Status
Inherited description: %LoadData() - loads an object from storage. This method is implemented by the storage class.
classmethod %LockId(id As %String, shared As %Boolean = 0, timeout As %Integer) as %Status
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 %Library.CacheStorage or %Library.CacheSQLStorage.
private method %OnNew(name As %String) as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

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 %UnlockId(id As %String, shared As %Boolean = 0, immediate As %Boolean = 0) as %Status
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 %Library.CacheStorage or %Library.CacheSQLStorage.
classmethod SoapBindingStyleIsValid(val As %String) as %Status
classmethod SoapBodyUseIsValid(val As %String) as %Status
classmethod parentOnDelete(id As %String, concurrency As %Integer) as %Status

Indexes

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

Triggers

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

Inherited Members

Inherited Methods (Including Private)