在 DeepSeek Harness (DSH) 的開發流程中,直接處理原始 SQL 字符串時,往往缺乏統一的格式標準。dsh-sql-format 插件專注於解決 SQL 輸出的可讀性問題,通過格式化工具將雜亂的 SQL 轉換爲結構清晰、關鍵字大寫的文本。
插件定位¶
該插件由用戶 istone 維護,屬於客戶端插件。它並不涉及數據庫連接或語義分析,僅對 SQL 字符串進行排版處理。
核心功能¶
插件提供以下能力:
- format_sql:核心工具,用於執行 SQL 格式化。
- SQL 子句換行:將長 SQL 拆分爲多行,提升視覺閱讀體驗。
- 關鍵字大寫:統一 SQL 關鍵詞的大小寫,便於識別。
安裝與啓用¶
安裝插件後,需要在項目的配置文件中聲明啓用。
- 執行安裝命令:
dsh plugin add github:uckkk/dsh-sql-format
- 打開 profile 的
package.json文件。 - 在
dsh.profile.bundles配置項中添加"dsh-sql-format"。
典型用法¶
安裝並在會話中加載插件後,直接調用 format_sql 函數,傳入待格式化的 SQL 字符串即可。
示例:
format_sql(sql="select * from users where age > 18 order by id desc")
注意事項¶
- 純 Node 實現:插件不解析 SQL 的語義或語法邏輯,僅做字符串排版。
- 代碼執行權限:安裝即在本機運行第三方代碼。請務必在安裝前審閱源碼與許可證。