Uploaded image for project: 'PuppetDB'
  1. PuppetDB
  2. PDB-5055

Add a new query param that returns EXPLAIN ANALYZE output for a given query

    XMLWordPrintable

Details

      • New query param which causes any query to return EXPLAIN ANALYZE output
      • Tests which check that this param works across a handful of the query endpoints
      • Documentation explaining the new query param
    • Ghost
    • 3
    • ghost-24.03.2021, ghost-7.04.2021, ghost-21.04.2021
    • Needs Assessment
    • New Feature
    • Hide
      A new paging option was added (explain). This can be used to tell PuppetDB to return the execution plan of a statement. The execution plan shows how the table(s) referenced by the statement will be scanned, the estimated statement execution cost and the actual run time statistics.

      This value should be an the string "analyze", any other value will not be validated.
      Show
      A new paging option was added (explain). This can be used to tell PuppetDB to return the execution plan of a statement. The execution plan shows how the table(s) referenced by the statement will be scanned, the estimated statement execution cost and the actual run time statistics. This value should be an the string "analyze", any other value will not be validated.
    • Needs Assessment

    Description

      We want to expose the EXPLAIN ANALYZE option added to the TK PuppetDBServer query method in PDB-5042 externally via a query param.

      To add the query param we could follow the example in the initial drop-joins pr. This pr added a optimize_drop_unused_joins=true query parameter to allow clients to opt-in to drop-joins. Following a similar pattern should allow us to pass down a flag which should eventually hit the same path used in PDB-5042 which will return the JSON of an EXPLAIN ANALYZE for a given query.

      Attachments

        Issue Links

          relates to

          New Feature - A new feature of the product, which has yet to be developed. PDB-5042 Add option to execute queries with EXPLAIN ANALYZE to PuppetDBServer TK query method

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Resolved

          Activity

            People

              oana.tanasoiu Oana Tanasoiu
              zachary.kent Zachary Kent
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Zendesk Support