IsSQLGenerated

Description

Returns a Bool indicating whether any fields of the query are SQL generated (that is, if the SQL is generated within HCL Compass). It returns True if the SQL in a QueryDef object is generated by HCL Compass.

• If you create a SQL query with the Query editor, then the SQL for the Query is generated. For example, if you use the following methods to build a Query
  • BuildQuery of the Session object
  • BuildField of the QueryDef object
  • BuildFilter of the QueryFilterNode object
  then the IsSQLGenerated method returns True.
• If you create a SQL query by typing in a SQL statement directly the SQL is not generated. For example, if you use the following methods to build a Query
  • BuildSQLQuery of the Session object
  • SetSQL of the QueryDef object
  then the IsSQLGenerated method returns False.

Syntax

VBScript

querydef.IsSQLGenerated 

Perl

$querydef->GetIsSQLGenerated(); 

Identifier

Description

querydef

A QueryDef object.

Return value

A Bool containing the value True if the any fields in the query are SQL generated, otherwise False.