cancel
Showing results for 
Search instead for 
Did you mean: 
Create Post

Add comments to queries

Add comments to queries

It would be great to have the ability to add comments (annotate) in the Queries Module to a given query. It can take a lot of time to examine a query to see if improvements can be made. This may lead to some ticket getting created that will be worked on at a later date. If we could comment on a query, we could mention what we've discovered about why it's not performing well, what work is planned for the future etc. When someone else comes across the same query, they'd see the comments and not need to redo the same time consuming work to research the query.

7 Comments
Level 16

Not exactly sure of your question but if you are using SQL or SWQL queries have you tried adding two minus signs in your query such as --

Example:

--Selects the first 10 nodes in the database and displays IP address and caption
SELECT TOP 10 IPAddress, Caption
--Selects data from this table
FROM Orion.Nodes
--Filters out only nodes with SW in the caption
Where Caption Like '%SW%'

 

Level 9

What I'm suggesting isn't to add comments to the actual query, but in the Queries module in DPM. Having a way to annotate the query family itself.

Level 8

Glad i saw this as I was going to submit the same request.  As an example one might add a link to a ticket to track work to improve the query.  Or, one might add an explanation of why the query is being left as-is, despite whatever costs/shortcomings/etc. 

Level 9

It would also be great if by default comments/annotations of all time could be seen as well as a checkbox to only show comments based on the current time selection.

Community Manager
Community Manager
 
Community Manager
Community Manager
 
Product Manager
Product Manager
Status changed to: Open for Voting