NotesDominoQuery

Properties

Name	Description
DesignDocumentsOnly Property	Specifies if the execute() and explain() methods should only search for design documents. If set to true, then only design documents will be searched…
MaxScanDocs Property	Specifies the maximum allowable number of documents scanned across all query terms. DQL execution returns an error when exceeded. Default is 500,000.
MaxScanEntries Property	Specifies the maximum allowable number of view entries scanned across all query terms. DQL execution return an error when exceeded. Default is 200,000.
NoViews Property	Specifies not to perform any view processing in satisfying a query. Default is False (off).
RebuildDesignCatalog property	Specifies to DQL processing to completely rebuild the Design Catalog before processing a query using Explain or Execute.
RefreshDesignCatalog property	Specifies to DQL processing to refresh the Design Catalog before processing a query using Explain or Execute.
RefreshFullText property	Specifies to DQL processing to refresh the full text index for a database prior to query processing using Explain or Execute.
RefreshViews Property	Specifies to DQL processing to refresh every view it opens to perform any view processing to satisfy a query. Default is False.
TimeoutSec Property	Specifies the maximum allowable seconds a DQL query is allowed to run. DQL execution returns an error when exceeded. Default is 300 (5 minutes).

Methods

Name	Description
CreateIndex method	Creates an index (Domino view) that is optimized for DQL query terms.
Execute method	Executes a query string passed in according to set parameters and returns named results in a database where they can be accessed again more quickly. For…
Explain method	Executes a query string passed in according to set parameters and returns an explain string to indicate how the query was executed.
ListIndexes method	Lists the indexes that are optimized for Domino DQL query terms.
Parse method	Parses a DQL query string for correct syntax.
RemoveIndex method	Removes an index (Domino view) that is optimized for DQL query terms. RemoveIndex is very powerful and can remove production views. Take care in choosing…
RemoveNamedResult method	Deletes named results created by the NotesDominoQuery Execute method.
ResetNamedVariables method	Removes all previously set named variables and values from a DominoQuery instance.
SetNamedVariable method	Assigns a value to a named substitution variable in a DQL query.