MySQL 適用的 Cloud SQL

MySQL 連接器可讓您在 MySQL 資料庫中插入、讀取、更新及刪除資料列。

支援的版本

MySQL 5.0 到 8.0 版

事前準備

使用 MySQL 適用的 Cloud SQL 連接器前,請先執行下列工作:

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

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

    • 啟用下列服務:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (連接器 API)

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

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

  • 啟用 sqladmin.googleapis.com (Cloud SQL Admin API) 服務。

設定連接器

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

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

    前往「連線」頁面

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

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

    2. 點按「下一步」
  4. 在「連線詳細資料」部分中,完成下列操作:
    1. 連接器:從可用連接器的下拉式清單中選取「Cloud SQL for MySQL」
    2. 連接器版本:從可用版本的下拉式清單中選取連接器版本。
    3. 在「Connection Name」欄位中,輸入連線例項的名稱。

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

      • 連線名稱可以包含英文字母、數字或連字號。
      • 字母必須為小寫。
      • 連線名稱的開頭必須為英文字母,結尾則須為英文字母或數字。
      • 連結名稱不得超過 49 個半形字元。
    4. 視需要輸入連線例項的「Description」(說明)
    5. 您可以選擇啟用 Cloud Logging,然後選取記錄層級。根據預設,記錄層級會設為 Error
    6. 服務帳戶:選取具備必要角色的服務帳戶。
    7. 視需要設定連線節點設定

      • 節點數量下限:輸入連線節點數量下限。
      • 節點數量上限:輸入連線節點數量上限。

      節點是用來處理交易的連線單位 (或備用資源)。處理的交易量越多,就需要越多節點;反之,處理的交易量越少,就需要越少節點。如要瞭解節點對連接器定價的影響,請參閱「 連線節點的定價」。如果您未輸入任何值,系統會預設將最小節點設為 2 (以提高可用性),並將最大節點設為 50。

    8. 專案 ID:CloudSQL 執行個體所在的 Google Cloud 專案 ID。
    9. 資料庫區域:CloudSQL 執行個體所在區域的名稱。
    10. Instance ID:要連線的 CloudSQL 執行個體 ID。
    11. 資料庫名稱:要連線的 Mysql 資料庫名稱。
    12. 您可以按一下「+ 新增標籤」,以鍵/值組合的形式為連線新增標籤。
    13. 點按「下一步」
  5. 在「目的地」部分中,輸入要連線的遠端主機 (後端系統) 詳細資料。
    1. 目的地類型:選取目的地類型
      • 從清單中選取「主機位址」,指定目的地的主機名稱或 IP 位址。
      • 如果您想建立與後端系統的私人連線,請從清單中選取「Endpoint attachment」,然後從「Endpoint Attachment」清單中選取所需的端點附件。

      如果您想建立與後端系統的公開連線,並提供額外的安全性,建議您為連線設定靜態外連 IP 位址,然後設定防火牆規則,只允許特定靜態 IP 位址進入白名單。

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

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

      MySQL 適用的 Cloud SQL 連線支援下列驗證類型:

      • 使用者名稱和密碼
    2. 如要瞭解如何設定這些驗證類型,請參閱「設定驗證」。

    3. 點按「下一步」
  7. 查看:查看連線和驗證詳細資料。
  8. 按一下 [建立]。

設定驗證機制

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

  • 使用者名稱和密碼
    • 使用者名稱:用於連線的 MySQL 使用者名稱。
    • 密碼:Secret Manager 密鑰,內含與 Mysql 使用者名稱相關聯的密碼。

實體、作業和動作

所有整合連接器都為已連結應用程式的物件提供一層抽象層。您只能透過這個抽象層級存取應用程式的物件。抽象概念會以實體、作業和動作的形式提供給您。

  • 實體: 實體可視為已連結應用程式或服務中的物件或屬性集合。實體的定義與連接器至連接器的定義不同。舉例來說,在資料庫連接器中,資料表是實體;在檔案伺服器連接器中,資料夾是實體;在訊息系統連接器中,佇列是實體。

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

  • 作業: 作業是指您可對實體執行的活動。您可以對實體執行下列任一操作:

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

  • 動作: 動作是透過連接器介面提供給整合項目的一流函式。動作可讓您變更實體或多個實體,而這些變更會因連接器而異。通常,動作會有一些輸入參數和輸出參數。不過,連接器可能不支援任何動作,在這種情況下,Actions 清單會為空白。

系統限制

MySQL 適用的 Cloud SQL 連接器可處理每個節點每秒 10 筆交易,並限制超過此限制的任何交易。根據預設,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. 在「Action」清單中,選取「Execute custom query」,然後按一下「Done」

      顯示「execute-custom-query-action」的圖片 顯示「execute-custom-query-action」的圖片

    4. 展開「Task input」部分,然後執行下列操作:
      1. 在「Timeout after」欄位中,輸入要等待多久時間才執行查詢。

        預設值:180 秒。

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

        預設值:25

      3. 如要更新自訂查詢,請按一下「編輯自訂指令碼」。系統會開啟「Script editor」對話方塊。

        顯示自訂 SQL 查詢的圖片 顯示自訂 SQL 查詢的圖片

      4. 在「Script editor」對話方塊中輸入 SQL 查詢,然後按一下「Save」

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

        SELECT * FROM Employees where LastName=?

      5. 如果您在 SQL 查詢中使用了問號,請按一下每個問號旁的「+ 新增參數名稱」,新增參數。執行整合作業時,這些參數會依序取代 SQL 查詢中的問號 (?)。舉例來說,如果您新增了三個問號 (?),就必須依序新增三個參數。

        顯示 add-query-param 的圖片 顯示 add-query-param 的圖片

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

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

行動號召範例

範例:找出較大值

本例說明如何執行使用者定義函式。這個範例中的 find_greater 函式會比較兩個整數,並傳回較大的整數。

  1. Configure connector task 對話方塊中,按一下 Actions
  2. 選取 find_greater 動作,然後按一下「Done」
  3. 在「Connectors」任務的「Task Input」部分,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似以下的值:
    {
    "$1": 1.0,
    "$2": 5.0
    }
  4. 如果動作執行成功,連接器任務的 connectorOutputPayload 欄位會包含類似以下的值:

    [{
    "bignum": 5.0
    }]

實體操作範例

範例:列出實體的記錄

本範例會列出 Users 實體的記錄。

  1. Configure connector task 對話方塊中,按一下 Entities
  2. Entity 清單中選取 Users
  3. 選取 List 作業,然後按一下「Done」
  4. 在「Connector」工作中的「Task Input」部分,您可以根據需求設定「filterClause」

    舉例來說,如果將篩選條件子句設為 employeeCode='5100' and startDate='2010-01-01 00:00:00',系統就只會列出 employeeCode 為 5100 且 startDate 為 2010-01-01 00:00:00 的記錄。

範例:從實體取得單一記錄

這個範例會從 Users 實體擷取記錄。

  1. Configure connector task 對話方塊中,按一下 Entities
  2. Entity 清單中選取 User
  3. 選取 Get 作業,然後按一下「Done」
  4. 在「Connectors」任務的「Task Input」部分,按一下「entityId」,然後在「Default Value」欄位中輸入 103032

    其中 103032Users 實體的主鍵值。

範例:刪除實體中的記錄

這個範例會從 Users 實體中刪除記錄。

  1. Configure connector task 對話方塊中,按一下 Entities
  2. Entity 清單中選取 Users
  3. 選取 Delete 作業,然後按一下「Done」
  4. 在「Connectors」任務的「Task Input」部分,點選「entityId」,然後在「Default Value」欄位中輸入 113132

    或者,如果實體具有複合式主鍵,而非指定 entityId,您可以設定 filterClause。例如:employeeCode='5100' and startDate='2010-01-01 00:00:00'

範例:在實體中建立記錄

這個範例會在 Users 實體中建立記錄。

  1. Configure connector task 對話方塊中,按一下 Entities
  2. Entity 清單中選取 Users
  3. 選取 Create 運算,然後按一下「Done」
  4. 在「Connectors」任務的「Task Input」部分,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似以下的值:
    {
    "employeeCode": "5100",
    "startDate": "2010-01-01 00:00:00.0",
    "country": "US"
    }
  5. 如果整合成功,連接器工作 connectorOutputPayload 欄位就會包含建立作業的回應。

範例:更新實體中的記錄

這個範例會更新 Users 實體中的記錄。

  1. Configure connector task 對話方塊中,按一下 Entities
  2. Entity 清單中選取 Users
  3. 選取 Update 運算,然後按一下「Done」
  4. 在「Connectors」任務的「Task Input」部分,按一下 connectorInputPayload,然後在 Default Value 欄位中輸入類似以下的值:
    {
    "country": "IN"
    }
  5. 在「Connectors」任務的「Task Input」部分,點選「entityId」,然後在「Default Value」欄位中輸入 113132

    或者,如果實體具有複合式主鍵,而非指定 entityId,您可以設定 filterClause。例如:employeeCode='5100' and startDate='2010-01-01 00:00:00'

  6. 如果整合成功,連接器工作 connectorOutputPayload 欄位就會包含更新作業的回應。

使用 Terraform 建立連線

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

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

如要查看建立連線的範例 Terraform 範本,請參閱範例範本

使用 Terraform 建立這項連線時,請務必在 Terraform 設定檔中設定下列變數:

參數名稱 資料類型 必填 說明
project_id STRING 包含 Cloud SQL 執行個體的專案 ID,例如 myproject。
database_region STRING 執行個體的雲端區域,例如 us-central1。
instance_id STRING 資料庫執行個體 ID。這不包含專案 ID,例如 myinstance。
database_name STRING 執行個體中的資料庫名稱,例如 mydatabase。

在整合中使用 MySQL 適用的 Cloud SQL 連線

建立連線後,即可在 Apigee Integration 和 Application Integration 中使用。您可以透過「連接器」工作,在整合中使用連線。

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

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

向 Google Cloud 社群尋求協助

如有任何問題,歡迎在 Cloud 論壇中發問並討論這個連接器。

後續步驟