getSqlPlan
Execute the provided sqlText directly within the TDV server and return the execution plan. The rootNodeTitle is the name of this sqlText execution plan.
You can get the execution plan for the SQL statement or SQL Script in sqlText. Common SELECT, UPDATE, INSERT, DELETE SQL without input parameters is supported. Input parameters for SQL script are also supported.
The parameters element contains a set of parameters to be inputs to the TDV script. A parameter contains two elements:
• definition: SQL language type for this parameter value. For example, VARCHAR(40) or BIGINT
• value: The value of this parameter.
Only users with the ACCESS_TOOLS right can call this operation.
Location
/services/webservices/system/admin/execute/operations/
Request Elements
rootNodeTitle (optional): The name of this sqlText execution plan. Defaults to Execution Plan.
sqlText: The SQL to be executed.
parameters (optional): Name-value pairs for the arameters to use as execution input.
Response Elements
queryPlanRoot: The root plan, which contains:
• name: Query plan node name.
• type: Type of this query plan node.
• properties (optional): List of properties for the current node and its child nodes (to any depth).
Faults
RuntimeError: If an error occurs during execution.
Security: If the user does not have the ACCESS_TOOLS right and other appropriate priveleges.