Annotates Custom SQL

This Optional Feature is just one of the SQL Performance Monitoring and Diagnostics features provided with this release. These features have been designed specifically for customer-created or custom-invoked SQL and allow you to view explain plans, track performance history, and get actionable reports for all your saved queries, integration saved queries, and agent actions. These features make it easier to identify and address slow or problematic SQL statements before they impact system performance. 

This Optional Feature when enabled, adds a SQL comment to all custom SQL (e.g. saved queries, DIRECT SQL UPDATE, ad-hoc finder requests). This simplifies identification of these queries in database reports. It also improves support for SQL execution analysis.

See the SQL Performance Monitoring feature for an overview of this SQL Performance feature.

Business Benefit: The SQL performance tools provided in this release allow you to proactively identify and resolve potential SQL performance issues arising from your custom queries—reducing the likelihood of system slowdowns and outages. You can:

  • Validate custom SQL for syntax and efficiency before deploying it.
  • Easily detect missing conditions in direct SQL updates.
  • Monitor historical execution times and resource usage for your queries.
  • Pinpoint and improve slow ad-hoc queries through diagnostic reporting.

By making it easier to review, optimize, and maintain customer-driven SQL, you can address most issues directly—leading to increased uptime, improved end-user experience, and reduced incident resolution times.

Adding a SQL comment to all custom SQL queries streamlines the identification of such queries in database reports, enabling faster troubleshooting and more efficient support for SQL execution analysis.

Steps to Enable and Configure

If you need to change the Opt In state for this feature:

  • Go to the Optional Feature UI - Configuration and Administration > Property Management > Optional Features.

Your user must have the DBA.ADMIN user role to use this functionality.

  • Select the Annotates Custom SQL feature.
  • Run the Action to Opt Out, assuming there is an issue with the enabled functionality.