explain method (DominoQuery - Java)

Executes a query string passed in according to set parameters and returns an Explain string to indicate how the query was executed.

Defined in



String explain ( String query ) throws NotesException


String query

A string containing a DQL query

Returned value

String Explain text

A string containing text showing the execution method chosen for each query term and the boolean operators that house them. The format is that of a boolean tree. For details about explain output, see explain.


Useful in getting your DQL queries optimized. The full query is performed and intermediate and full results counted and described. Some runtime errors are also possible and if they occur, their text will appear in the NotesException that is returned.

Language cross-reference

Explain method (NotesDominoQuery - LotusScript)