dmaClass_Query

The complete definition of a query, including control settings.

Class ID: dmaClass_Query
Superclass: DMA

Interfaces

Properties

Name	Impl. Required	System Gen'ed	Read-Only	Value Required	Type	Cardinality	Required Class
OIID	-	Yes	Yes	-	String	Scalar
Class Description	Yes	Yes	Yes	Yes	Object	Scalar	Class Description
This	-	Yes	Yes	Yes	Object	Scalar	Query
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Query Root	Yes	-	-	Yes	Object	Scalar	Query Root
Batch Size Hint	-	-	-	-	Integer32	Scalar
Maximum Result Items	-	-	-	-	Integer32	Scalar
Time Limit	-	-	-	-	Integer32	Scalar
Collation Sequence Id	Yes	-	-	-	ID	Scalar

Detailed Description

Query objects are passed to the ExecuteSearch method. The main part of a Query is the Query Root property, which contains the entire description of the query.

Property Descriptions

• OIID {dmaProp_OIID}
Property Inherited from DMA

• Class Description {dmaProp_ClassDescription}
Property Inherited from DMA

• This {dmaProp_This}
Property Inherited from DMA

• Create Pending {dmaProp_CreatePending}
Property Inherited from DMA

• Update Pending {dmaProp_UpdatePending}
Property Inherited from DMA

• Delete Pending {dmaProp_DeletePending}
Property Inherited from DMA

• Query Root {dmaProp_QueryRoot}

This specifies the query to be performed.

• Batch Size Hint {dmaProp_BatchSizeHint}

This integer property is relevant for the case that result rows are generated incrementally on demand in groups of N. The value of this property is a suggestion for N. If results are generated all at once, this property is simply ignored.

• Maximum Result Items {dmaProp_MaximumResultItems}

The value of this property indicates to the scope that it need not return more than the specified number of rows. If the result set is truncated as a result of reaching this upper limit, the result code DMARC_MAX_ROWS is returned. The value of this property is passed to all the component scopes

• Time Limit {dmaProp_TimeLimit}

This integer property gives a hint as to the maximum number of elapsed seconds between the time ExecuteSearch is called and the time query result items need no longer be returned. In the case of merged scopes, the hint applies to each of the component scopes separately as well as to the merged scope itself.

When a result set is truncated because of this time limit being exceeded, IdmaResultRow::GetNextResultRow returns DMARC_TIMEOUT. If results are truncated for multiple different reasons (e.g., DMARC_MAX_ROWS and DMARC_TIMEOUT), the result DMARC_TRUNCATED is returned.

• Collation Sequence Id {dmaProp_CollationSequenceId}

This property specifies the text collation sequence to be used for all comparisons of string properties in all scopes executing the query.