概述

PawSQL Advisor是由PawSQL團隊開發的，面向數據庫應用開發人員的自動化、智能化SQL優化工具, 它融合了業界關于數據庫優化的最佳實踐, 從正確性和性能兩個方面對SQL進行審查和重寫優化；并基于SQL查詢的結構、數據庫對象的定義及統計信息，提供智能索引推薦功能，幫助數據應用開發人員一鍵提升應用性能。

核心功能

• 基于規則的SQL審查，包括正確性審查和性能優化審查規則。
• 基于規則的重寫優化，推薦語義等價、但執行效率更高的SQL。
• 智能索引推薦，滿足各種SQL語法組合的場景下，推薦最優的索引組合。
• 基于代價的優化驗證，確保基于SQL重寫和索引推薦的新方案有著更好的性能。
• 索引分析引擎，對已有的索引進行分析，識別冗余索引。

支持數據庫

PawSQL基于自研的SQL解析器，支持多種數據庫類型以及SQL方言，當前支持的數據庫列表如下，還在不斷增加中...

• MySQL 5.6及以上 (official)
• PostgreSQL 9.1及以上 (official)
• openGauss 1.0及以上 (official)
• MariaDB 5.6及以上（β測試）
• Oracle 9i及以上（β測試）
• KingbaseES V8（β測試）

使用手冊

1、插件安裝

PawSQL Advisor是基于IntelliJ的IDE插件，支持的Jetbrain工具包括IntelliJ IDEA，DataGrip，PyCharm，Android Studio, AppCode, DataSpell, GoLand, PhpStorm, WebStorm等, 可以通過Jetbrain應用市場安裝。

2、配置頁面

PawSQL Advisor提供一個項目級的配置頁面，供用戶進行優化任務輸入、輸出、數據源以及執行過程的參數配置。

（1）優化配置

• 輸入類型，指定輸入待分析SQL的類型，目前支持以下兩種格式，

• SQL 文件，代表待優化的SQL來自原生SQL文件， 支持ANSI標準的SQL語法及多種SQL方言，多個SQL之間通過;分割。
• Mapper 文件，從Mybatis的mapper配置文件里提取SQL, 并通過解析獲取所有可能的SQL組合。然后對mapper文件中的占位符根據其上下文推斷其數據類型并對其賦于一個合法的常量，從而使其能夠生產合法的SQL語句，以便進行后續的查詢語句結構分析。

注意：Mapper文件作為輸入對于應用開發人員非常重要，因為在應用開發初期，開發人員對于前端的輸入組合無法完全掌握，所能組合的SQL業務無法確定，此選項可以確保對于所有的組合，都能夠合適的索引推薦出來以提升性能。但是由于Mapper配置文件可能書寫不夠規范，導致組合出的某些SQL語句在真實的場景下永遠不會出現，進而推薦出無用的索引。

• 結果展示，用來設定輸出的SQL優化建議的語言，目前支持中文及英文兩種。
• 是否啟用重寫優化，此選項控制是否啟用重寫優化，在SQL以及上線的情況下，修改SQL可能無法立即實施，在此情況下，可以禁用此選項，來獲取索引推薦的建議，快速進行性能優化。
• 是否啟用What-If性能驗證，此選項控制是否對推薦的優化建議進行性能驗證，如果啟用此選項，PawSQL在優化詳情中會提供SQL優化前后的執行計劃及代價信息，從而確保推薦的優化建議（重寫優化及索引推薦）能夠真實提升數據庫性能。
• 性能驗證時是否執行SQL，如果啟用此選項，則在進行What-If性能驗證時獲取SQL的真實解析及執行時間，避免了MySQL對中間結果表explain的缺陷，代價估算更加精確。

注意：最后兩個性能驗證的選項應避免在生產庫上使用，因為對于沒有內置what-if(內置虛擬索引)的數據庫(MySQL/Postgres皆是)來說，性能驗證是通過創建推薦索引并進行explain分析執行計劃，然后刪除推薦索引的方式來做的。這個過程在生產庫上會消耗一定的資源，且執行時間可能會比較長，可能對生產庫上的業務運行產生影響。

（2）數據庫配置

在PawSQL Advisor中，數據庫連接信息作用有兩個：一用來獲取SQL對應的數據庫對象，包括數據庫表、視圖、列、索引信息。二是用來對優化建議進行What-If性能驗證，以確保優化建議能夠提升SQL的查詢性能。

• 數據庫類型，指定連接的數據庫類型，目前支持MySQL，PostgreSQL，Opengauss, Oracle, MariaDB, KingbaseES六種數據庫.
• 地址，數據庫地址。
• 端口，數據庫端口。
• 用戶，數據庫用戶。
• 密碼，數據庫用戶密碼。
• 默認數據庫，默認數據庫名稱，鏈接默認的數據庫名稱。
• 數據庫或是模式列表，數據庫列表(MySQL)或是模式列表(PostgreSQL/Opengauss)，PawSQL會將列表項下的表、視圖、索引及其對應的統計信息作為SQL性能優化的輸入。

（3）索引推薦配置

• 是否和現有索引去重，此選項表示推薦索引時，是否考慮現有索引，并把現有索引能夠覆蓋的推薦索引排除掉。啟用此選項的場景是不考慮刪除現有的索引，因為輸入的SQL只是并不能代表這個數據庫上所有的SQL場景，所以只考慮新增對輸入SQL有幫助的索引。如果能夠確保輸入的SQL包含此數據庫所有的查詢，那么只保留推薦的索引就可以了，這種情況下可以不選擇此選項，并且使用新推薦的索引代替現有的索引。
• 是否推薦覆蓋索引，此選項表示推薦索引時是否考慮覆蓋索引策略。覆蓋索引可以讓查詢只訪問索引而不需要訪問數據表（請參考《高效索引的準則》），在一些場景下，覆蓋索引能夠大幅提示查詢性能。但是覆蓋索引會包含查詢條件中沒有使用的列，從而增加索引所占的磁盤空間大小。
• 覆蓋索引的最大列數，此項設置表示在進行覆蓋索引推薦時，索引的最大列數限制。如以上所述，覆蓋索引會包含查詢條件中沒有使用的列，從而增加索引所占的磁盤空間大小。此選項可以控制覆蓋索引所占空間的大小，讓PawSQL能夠為用戶提供一定空間限制的情況下利用覆蓋索引的非回表特性。
• 索引的最大列數，此選項限制索引的最大列數，索引會占用一定的磁盤空間，且太多列的索引會讓索引樹的層級加深，從而增加索引訪問的代價。用戶可以通過此項設置控制索引的最大列數。
• 單表最大索引數目，如《高效索引的準則》中所述，索引不是免費的午餐，它會占用磁盤空間，并對對DML操作產生負面影響，因為對于數據庫管理器寫入表的每一行，它還必須更新任何受影響的索引。因此，PawSQL通過此選項來審查單表的索引數量，并進行警告提示。

3、執行優化

（1）對文件/文件夾中的SQL進行優化

右鍵點擊需要進行分析的SQL文件或是文件夾，點擊PawSQL Advisor->Optimize，啟動對此文件或是文件夾中的所有SQL語句的優化。

您也可以點擊PawSQL Advisor->Optimize Config...，此按鈕將調出參數配置頁面，方便您在執行前對執行參數進行配置，并立即進行優化執行。

（2）對選中的SQL文本進行優化

在IDE的文本/代碼編輯器中選中待優化的SQL，點擊右鍵，點擊PawSQL Advisor->Optimize Selected.

同樣的，您也可以點擊PawSQL Advisor->Optimize Selected Config...，此按鈕將調出參數配置頁面，方便您在執行前對執行參數進行配置，并立即進行優化執行。

（3）優化過程日志

查詢優化的執行過程可以通過下方的日志終端查看。

4、執行結果解讀

當優化完成后，PawSQL會生成一個優化匯總信息文件，并自動打開該文件。此文件是以pawTunningSummary結尾的markdown文件，建議您安裝Markdown插件（在應用市場搜索"Markdown"進行安裝），以便能夠通過超鏈接查看單SQL的優化詳情。

（1）整體優化建議

查看pawTuningSummary文件獲取優化的整體信息，主要包括三部分。

• 整體優化概要
• 推薦索引信息
• SQL優化列表

4.2 單SQL優化詳情

點擊整體優化建議pawTunningSummary中的SQL優化列表中具體的SQL名稱，可以進入到單SQL的優化詳情文件。此文件中的內容主要包括：

• 原始SQL
• 重寫優化

• 重寫后的SQL
• 重寫所應用的優化策略，
• 重寫優化對應的SQL片段

規則審查情況：

• 違反的審查規則
• 違反規則的SQL片段

索引推薦情況：

• 推薦的索引
• 索引推薦的依據

索引分析：

• 各個表上的索引列表
• 索引如何幫助此SQL執行
• 冗余索引分析
• 單表索引個數超過閾值提示

性能驗證：

• 性能提升比
• 驗證生效的推薦索引
• 優化之前的執行計劃
• 優化之后的執行計劃

關于PawSQL

PawSQL專注數據庫性能優化的自動化和智能化，支持MySQL，PostgreSQL，Opengauss等，提供的SQL優化產品包括

• PawSQL Cloud，在線自動化SQL優化工具，支持SQL審查，智能查詢重寫、基于代價的索引推薦，適用于數據庫管理員及數據應用開發人員。
• PawSQL Advisor，IntelliJ 插件, 適用于數據應用開發人員，可以IDEA/DataGrip應用市場通過名稱搜索“PawSQL Advisor”安裝。
• PawSQL Engine, 是PawSQL系列產品的后端優化引擎，可以獨立安裝部署，并通過http/json的接口提供SQL優化服務。PawSQL Engine以docker鏡像的方式提供部署安裝。