魔筆平臺提供了強大的數據庫集成功能,允許用戶通過簡單的配置,實現對 MySQL 數據庫的便捷連接和數據操作。本文檔將指導您如何創建和使用數據庫集成。
功能介紹
魔筆平臺的數據庫集成功能支持以下特點:
動態 SQL 支持:在 SQL 語句中支持使用 JavaScript 表達式,為動態查詢提供便利。
自定義觸發方式:集成操作可以設置為手動觸發或自動運行,滿足不同的業務場景需求。
回調和數據轉換:支持在查詢成功或失敗時執行特定的集成操作事件,以及對返回的數據進行自定義處理。
高級設置:提供防抖和禁止執行條件的高級配置,以優化集成操作的執行。
事件相關內容可參考:集成操作事件
創建數據庫集成
1. 創建數據庫集成
登錄魔筆平臺,進入管控臺。
導航至“資源”->“集成”,點擊“創建集成”。
選擇“數據庫類型的集成”(當前支持 MySQL),并填寫集成名稱及描述。
配置不同環境的數據庫連接信息,包括
host
、port
、數據庫名稱、用戶名和密碼。自定義參數中支持使用serverTimezone
指定數據庫時區,例如使用GMT%2B8
指定東八區。說明自定義參數需要使用 URL 編碼,例如
GMT+8
需要使用GMT%2B8
。若賬號下已有阿里云 RDS MySQL 數據庫,可選擇“從當前云賬號錄入”,快捷選擇已有的數據庫資源。
點擊“確定”以創建數據庫集成。
2. 在應用內部創建集成操作
打開“代碼”面板,點擊對應作用域的“+”后選中“集成操作”。
選擇之前創建的數據庫集成作為資源,輸入 SQL 查詢語句后,根據需求,選擇集成操作的觸發方式。
點擊“運行”預覽查詢效果。
配置面板詳解
通用配置
參數:定義查詢所需的參數,包括類型、默認值和描述。在查詢語句中,可通過
{{ varName }}
的方式引用參數。動態 SQL 語句:打開此開關后,可以在 SQL 語句中使用
{{ varName }}
引用 SQL 語句。如下圖所示,此時在 SQL 語句和引用的 SQL 語句參數中不支持嵌套其他{{}}
的動態參數。重要啟用動態 SQL 語句可能導致 SQL 注入,請謹慎操作。動態 SQL 語句不支持嵌套參數引用,請注意。
SQL 語句:編寫發送到數據庫的 SQL 語句。在語句中,可使用
{{}}
來編寫 JS 表達式,例如SELECT * FROM test WHERE name={{input1.value}}
,其中input1
是輸入框組件,input1.value
是輸入框組件中的內容。注意,對于可能引起 SQL 注入的部分(如表名),使用{{}}
可能導致執行失敗。觸發方式:選擇手動觸發或自動運行。手動觸發僅在觸發集成操作事件或通過 API 調用
action.trigger
方法時執行。自動運行則在初次加載和依賴項變更時自動執行,例如當{{input1.value}}
改變時。超時時間:配置操作的最大執行時間。
描述:為集成操作提供詳細描述。
回調配置
數據轉換:對接口返回的數據進行處理,默認為
return data
,即不進行處理。成功回調:配置接口調用成功時觸發的事件。
失敗回調:配置接口調用失敗時觸發的事件。
高級配置
防抖:設置防抖表達式,避免接口的頻繁調用。
禁止執行條件:根據條件表達式確定是否執行此集成操作。
手動觸發數據庫集成
事件觸發
在需要觸發集成操作的組件中,配置事件處理器。
將動作類型設置為集成操作,并選擇相應的集成。
以對象形式填寫已配置的參數。
API 觸發
若此集成操作的名稱為action1
,則在任何可以執行腳本的地方,可以使用action.trigger()
方法觸發集成操作,若集成操作配置了參數,則需要以對象形式填寫已配置的參數。