SAP HANA SQL Analyzer for Visual Studio Code

HANA SQL Analyzer for Visual Studio Code is a brand new software that we are developing from the scratch to help users analyze the performance of HANA SQL queries. This repository will be the only single source for the development plan, code, development status, release information, downloadable package, analysis know-hows, and bug reporting.

Why Another SQL Analysis Tool?

First of all, you might have a question why we are developing another tool in addtion to the existing PlanViz in Studio and SQL Analyzer in HANA Cockpit. Some answers are:

• Bascially it is to make developers happier (developer experience).
• With the deprecation of Studio, we couldn't bring new features anymore to PlanViz in Studio.
• New WebIDE (official name: SAP Business Application Studio) is built on Eclipse Theia, which is based on Visual Studio Code, which is based on Electron.js new cross platform to build web-based desktop apps, which is based on Google Chrome(actually Chromium) browser and Node.js. So, VSCode extension app can be plugged into new WebIDE, which is aligned with new developer tooling strategy for both cloud and on-prem.
• PlanViz has been built in 2011, and it required big refactoring to accomodate multiple SQL engines. We decided to build from the scratch for this major change.

Features

SQL Analyzer for Visual Studio Code is still under heavy development. Here are some highlighted features:

• Live connection support (Note: connection details will be stored in SecretStorage.)
• Load multiple PLV files and keep the history
• Visualize query plans in PLV into plan graph
• Quick analysis support
• Critical path visualization
• Bookmark and sharing (Note: Personal data can be anonymized and the comments can be deleted by users.)
• Recommendations
• Advanced UX

Known Limitations

The following features are NOT impleneted yet:

• Plan Trace view
• Plan Comparison view

How To Install

Until we release this software via Visual Studio Code Marketplace this year, you need to install the extension file manually.

1. Install Visual Studio Code if not installed already (>= 1.53.0 is required because the extension is relying on the APIs from that version).
2. Open VSCode and click Extensions tab (puzzle icon) from the left side menu bar
3. Search for 'SAP HANA SQL Analyzer' and install Visual Studio Code Extension file (vsc-extension-sa-.vsix) of this new SQL Analyzer from VSCode Marketplace.
4. Once the installation is completed, the new SQL Analyzer icon will be added in the left side menu.

How To Use

1. Go to SQL Analyzer extension (by clicking the last extension icon from the left side menu)
2. Click (+) icon from the top PLAN GRAPHS section in the left side panel.
3. Select a PLV file from the file open dialog to show the visualized plan.

Documentation

SQL Analyzer Extension - SAP Help Portal

Release Notes

Here is the brief history of releases.

1.2.20

Fix plv parsing pausing issue when it has jeReduction plan

1.2.17

Restore badge displaying, file exporting feature Fix config panel option selection issue

1.2.13

• Replace parser from node-expat to sax
• Enable column filter and search feature in operator list

1.2.11

• Supprot electron v13 for Mac

1.2.9

• Recover lost edges in specific cases

1.2.5

• Support electron v13 which is enabled from vscode 1.59

1.2.3

• Provide CPU Time based analysis for HEX Plan.
• Support side panel to describe node/edge properties. Callout is deprecated
• Auto expanding initial nodes when opening plv file.
• Allow plv extension to export plangraph.
• Support SessionVariable tag parsing. It will be shown in SQL pane.

1.1.9

• Update TimelineChart to handle multiple compile time that each innper plan has.
• Support file export of inner plan with communication data.
• Filter access table which shows outmost operator among same table name

1.0.3

• First official release

Feedbacks

Please provide your feedbacks thru "DL Database_SEL_Tool DL_5D1C6525F0CD7F027FD1B8B4@global.corp.sap"