SQL Server

您可以使用 SQL Server 連接器，對 SQL Server 資料庫執行插入、刪除、更新和讀取作業。

支援的版本

SQL Server 版本：2008、2012、2014、2016、2017、2019 和 2022

事前準備

使用 SQL Server 連接器前，請先完成下列工作：

• 在 Google Cloud 專案中：
  • 確認已設定網路連線。如要瞭解網路模式，請參閱「網路連線」。
  • 將 roles/connectors.admin IAM 角色授予設定連線器的使用者。
  • 將下列 IAM 角色授予要用於連接器的服務帳戶：
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    服務帳戶是特殊的 Google 帳戶類型，主要用於代表需要驗證且必須取得授權才能存取 Google API 資料的非人類使用者。如果您沒有服務帳戶，請務必建立服務帳戶。詳情請參閱「建立服務帳戶」。

  • 啟用下列服務：
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    如要瞭解如何啟用服務，請參閱「啟用服務」。

  如果專案先前未啟用這些服務或權限，系統會在設定連結器時提示您啟用。

設定連接器

連線專屬於資料來源。也就是說，如果您有多個資料來源，則必須為每個資料來源建立個別的連線。如要建立連線，請按照下列步驟操作：

1. 在 Cloud 控制台中，前往「Integration Connectors」>「Connections」頁面，然後選取或建立 Google Cloud 專案。

   前往「Connections」(連線) 頁面

2. 按一下「+ 建立新連線」，開啟「建立連線」頁面。
3. 在「位置」部分中，選擇連線位置。
   1. 區域：從下拉式清單中選取位置。

      如需所有支援的地區清單，請參閱「位置」一文。

   2. 點選「下一步」。
4. 在「連線詳細資料」部分，完成下列步驟：
   1. 連接器：從可用連接器的下拉式清單中選取「SQL Server」。
   2. 連接器版本：從可用版本的下拉式清單中選取連接器版本。
   3. 在「連線名稱」欄位中，輸入連線執行個體的名稱。

      連線名稱必須符合下列條件：

      • 連線名稱可使用英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱開頭須為英文字母，結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個字元。
   4. 視需要輸入連線執行個體的「Description」(說明)。
   5. 或者，可啟用 Cloud Logging，然後選取記錄層級。記錄層級預設為 Error。
   6. 服務帳戶：選取具備必要角色的服務帳戶。
   7. 視需要設定「連線節點設定」：
      • 節點數量下限：輸入連線節點數量下限。
      • 節點數量上限：輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。連線處理的交易量越多，就需要越多節點；反之，處理的交易量越少，需要的節點就越少。如要瞭解節點對連線器定價的影響，請參閱「 連線節點定價」。如未輸入任何值，系統預設會將節點下限設為 2 (提高可用性)，節點上限則設為 50。

   注意：只有預付方案客戶可以自訂連線節點值。
   8. (選用) 在「進階設定」部分，選取「使用 Proxy」核取方塊，為連線設定 Proxy 伺服器，並設定下列值：
   • Proxy Auth Scheme：選取與 Proxy 伺服器進行驗證的驗證類型。系統支援下列驗證類型：
     • 基本：基本 HTTP 驗證。
     • 摘要：摘要 HTTP 驗證。
   • Proxy 使用者：用於向 Proxy 伺服器驗證的使用者名稱。
   • Proxy Password：使用者的密碼 Secret Manager 密鑰。
   • Proxy SSL Type：連線至 Proxy 伺服器時要使用的 SSL 類型。系統支援下列驗證類型：
     • 自動：預設設定。如果網址是 HTTPS 網址，則會使用「Tunnel」(通道) 選項。如果網址是 HTTP 網址，系統會使用「永不」選項。
     • 「Always」(一律)：連線一律啟用 SSL。
     • 「永不」：連線未啟用 SSL。
     • 通道：連線是透過通道 Proxy 建立。Proxy 伺服器會開啟與遠端主機的連線，流量會透過 Proxy 來回傳送。
   • 在「Proxy 伺服器」部分中，輸入 Proxy 伺服器的詳細資料。
     1. 按一下「+ 新增目的地」。
     2. 選取「目的地類型」。
        • 主機位址：指定目的地的 IP 位址或主機名稱。

          如要與後端系統建立私人連線，請按照下列步驟操作：

          • 建立 PSC 服務連結。
          • 建立端點連結，然後在「主機地址」欄位中輸入端點連結的詳細資料。
   9. ApplicationIntent：應用程式意圖連線字串屬性會表示用戶端應用程式的要求，即將要求導向可用性群組資料庫的讀寫或唯讀版本。如要使用唯讀轉送，用戶端必須在連線至可用性群組接聽程式時，於連線字串中使用唯讀應用程式意圖。如果沒有唯讀應用程式意圖，連線到可用性群組接聽程式時，系統會將連線導向主要副本上的資料庫。
   10. ApplicationName：應用程式名稱連線字串屬性會表示用戶端應用程式的名稱。
   11. 資料庫：SQL Server 資料庫的名稱。
   12. 加密：這個欄位會設定是否啟用 SSL。
   13. (選用) 按一下「+ 新增標籤」，以鍵/值組合的形式為連線新增標籤。
   14. 如要使用 SSL，請選取「啟用 SSL」(選用)。系統隨即顯示 SSL 設定詳細資料。
       1. 選取信任儲存區類型。可以是「公開」、「私人」或「不安全連線」。
       2. 根據信任存放區選取項目，選取顯示的憑證。
       3. 如果您使用 mTLS，請在「金鑰儲存區」部分選取金鑰儲存區憑證。
       注意：

       • 所有憑證都必須是 X.509 憑證，且必須採用 PEM (隱私強化郵件) 格式。
       • 設定 SSL 時，您無法直接選取憑證。您必須將所有憑證和私密金鑰儲存為 Secret Manager 密鑰，然後在 SSL 設定期間選取所需密鑰。
   15. 點選「下一步」。
5. 在「目的地」部分，輸入要連線的遠端主機 (後端系統) 詳細資料。
   1. 目的地類型：選取目的地類型。
      • 如要指定目的地主機名稱或 IP 位址，請選取「主機地址」，然後在「主機 1」欄位中輸入地址。
      • 如要建立私人連線，請選取「Endpoint attachment」(端點連結)，然後從「Endpoint Attachment」(端點連結) 清單中選擇所需連結。
        注意： 如要瞭解如何建立端點連結，請參閱 PSC 服務連結和端點連結。建立端點連結後，該連結會顯示在「端點連結」清單中。

      如要建立與後端系統的公開連線，並加強安全性，建議為連線設定靜態輸出 IP 位址，然後設定防火牆規則，只允許特定靜態 IP 位址。

      如要輸入其他目的地，請按一下「+新增目的地」。

   2. 點選「下一步」。
6. 在「Authentication」(驗證) 部分，輸入驗證詳細資料。
   1. 選取「驗證類型」並輸入相關詳細資料。

      SQL Server 連線支援下列驗證類型：

      • 使用者名稱和密碼

   如要瞭解如何設定這些驗證類型，請參閱「設定驗證」。

   2. 點選「下一步」。
7. 檢查：檢查連線和驗證詳細資料。
8. 點選「建立」。

設定驗證機制

根據要使用的驗證方式輸入詳細資料。

• 使用者名稱和密碼
  • 使用者名稱：連接器的使用者名稱
  • 密碼：Secret Manager 密鑰，內含與連接器相關聯的密碼。
  • 驗證機制：用於驗證的機制

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

注意：您可以在「連線器工作」中查看連線器的實體、作業和動作。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

注意： 所有實體和動作都會有相關聯的結構定義。舉例來說，動作結構定義會包含參數詳細資料，例如參數名稱和對應的資料型別。連線會在執行階段從後端擷取實體和動作的結構定義 (中繼資料)。如果架構有任何更新，現有連線不會自動反映這些更新，您必須手動重新整理架構。如要重新整理連線的結構定義，請開啟連線的「連線詳細資料」頁面，然後按一下「重新整理連線結構定義」。

系統限制

SQL Server 連接器每個節點每秒最多可處理 90 筆交易，並節流任何超出此限制的交易。根據預設，Integration Connectors 會為連線分配 2 個節點 (提高可用性)。

如要瞭解 Integration Connectors 適用的限制，請參閱「限制」一文。

注意：整合連接器節點的數量會根據用量自動動態調整。不過，如要為大量資料保留容量，不必等待自動調度資源，可以調整連線的節點數量下限。如要處理連線的更多交易，就需要更多節點。反之，如果連線處理的交易較少，則需要的節點也較少。如要設定節點值，請按照下列步驟操作：

• 如果您是隨用隨付方案客戶，請在編輯連線頁面中設定節點的最小值和最大值。
• 如果您是訂閱型客戶，請與支援團隊聯絡。

節點可處理的最大交易量取決於多項因素。因此，建議您先檢查後端系統是否已完成最佳化設定，可處理所需流量，再調整節點下限以提升輸送量。

支援的資料類型

這個連接器支援的資料類型如下：

• BIGINT
• BINARY
• BIT
• BOOLEAN
• CHAR
• DATE
• DECIMAL
• DOUBLE
• FLOAT
• INTEGER
• LONGN VARCHAR
• LONG VARCHAR
• NCHAR
• NUMERIC
• NVARCHAR
• REAL
• SMALL INT
• 時間
• TIMESTAMP
• TINY INT
• VARBINARY
• VARCHAR

動作

這個連結器支援執行下列動作：

• 使用者定義的預存程序和函式。如果後端有任何預存程序和函式，這些項目會列在 Configure connector task 對話方塊的 Actions 欄中。
• 自訂 SQL 查詢。如要執行自訂 SQL 查詢，連接器提供「執行自訂查詢」動作。

  如要建立自訂查詢，請按照下列步驟操作：

  1. 請按照詳細說明 新增連接器工作。
  2. 設定連接器工作時，請在要執行的動作類型中選取「動作」。
  3. 在「動作」清單中，選取「執行自訂查詢」，然後按一下「完成」。

     

  4. 展開「Task input」(工作輸入) 區段，然後執行下列操作：
     1. 在「Timeout after」(逾時時間) 欄位中，輸入查詢執行前的等待秒數。

        預設值：180 秒。

     2. 在「資料列數量上限」欄位中，輸入要從資料庫傳回的資料列數量上限。

        預設值為 25。

     3. 如要更新自訂查詢，請按一下「編輯自訂指令碼」。「指令碼編輯器」對話方塊隨即開啟。

        

     4. 在「指令碼編輯器」對話方塊中輸入 SQL 查詢，然後按一下「儲存」。

        您可以在 SQL 陳述式中使用問號 (?) 代表單一參數，該參數必須在查詢參數清單中指定。舉例來說，下列 SQL 查詢會從 Employees 資料表選取與 LastName 資料欄指定值相符的所有資料列：

        SELECT * FROM Employees where LastName=?

        注意：支援資料操縱語言 (DML) 和資料定義語言 (DDL) 陳述式。
     5. 如果您在 SQL 查詢中使用問號，請為每個問號點按「+ 新增參數名稱」，加入參數。執行整合時，這些參數會依序取代 SQL 查詢中的問號 (?)。舉例來說，如果您新增了三個問號 (?)，就必須依序新增三個參數。

        

        如要新增查詢參數，請按照下列步驟操作：

        1. 在「類型」清單中，選取參數的資料類型。
        2. 在「值」欄位中輸入參數值。
        3. 如要新增多個參數，請按一下「+ 新增查詢參數」。

     「執行自訂查詢」動作不支援陣列變數。

使用 Terraform 建立連線

您可以使用 Terraform 資源建立新連線。

如要瞭解如何套用或移除 Terraform 設定，請參閱「基本 Terraform 指令」。

如要查看用於建立連線的 Terraform 範本範例，請參閱範本範例。

使用 Terraform 建立這項連線時，您必須在 Terraform 設定檔中設定下列變數：

參數名稱	資料類型	必填	說明
application_intent	STRING	否	應用程式意圖連線字串屬性會表示用戶端應用程式的要求，以便導向可用性群組資料庫的讀寫或唯讀版本。如要使用唯讀轉送，用戶端必須在連線至可用性群組接聽程式時，於連線字串中使用唯讀應用程式意圖。如果沒有唯讀應用程式意圖，連線到可用性群組接聽程式時，系統會將連線導向主要副本上的資料庫。
application_name	STRING	否	應用程式名稱連線字串屬性會表示用戶端應用程式的名稱。
資料庫	STRING	否	SQL Server 資料庫的名稱。
加密	BOOLEAN	否	這個欄位會設定是否啟用 SSL。
enable_logging	ENUM	否	選取 1 (最不詳細) 到 5 (最詳細) 之間的層級，即可在連線期間啟用記錄詳細程度。這項功能有助於排解錯誤訊息或其他非預期行為。不過請注意，這個選項會記錄連接器和後端之間的所有通訊詳細資料，包括要求、回應和 SSL 憑證。因此，不建議在實際工作環境中使用這項功能。支援的值為：1、2、3、4、5
proxy_enabled	BOOLEAN	否	選取這個核取方塊，即可設定連線的 Proxy 伺服器。
proxy_auth_scheme	ENUM	否	用於向 ProxyServer Proxy 驗證的驗證類型。支援的值包括：BASIC、DIGEST、NONE
proxy_user	STRING	否	用於向 ProxyServer Proxy 驗證的使用者名稱。
proxy_password	SECRET	否	用於向 ProxyServer 代理程式驗證的密碼。
proxy_ssltype	ENUM	否	連線至 ProxyServer Proxy 時要使用的 SSL 類型，支援的值包括：AUTO、ALWAYS、NEVER、TUNNEL

在整合中建立 SQL Server 連線

建立連線後，Apigee Integration 和 Application Integration 都會提供該連線。您可以在整合中透過「連接器」工作使用連線。

• 如要瞭解如何在 Apigee Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。
• 如要瞭解如何在 Application Integration 中建立及使用「連線器」工作，請參閱「連線器工作」。

此外，請參閱對 MySQL 資料庫執行 CRUD 作業教學課程，瞭解如何建立 MySQL 連線，並在整合功能中使用該連線執行讀取和寫入作業。

向 Google Cloud 社群尋求協助

如要發布問題及討論這個連接器，請前往 Cloud 論壇的 Google Cloud 社群。

後續步驟

• 瞭解如何暫停及恢復連線。
• 瞭解如何監控連結器用量。
• 瞭解如何查看連接器記錄。