使用 PostgreSQL 適用的 Cloud SQL

本頁面說明如何從 App Engine 應用程式連線到 PostgreSQL 適用的 Cloud SQL 執行個體,以及如何讀取及寫入 Cloud SQL。Cloud SQL 是存放在 Google 雲端系統的 SQL 資料庫。

如需進一步瞭解 Cloud SQL,請參閱 Cloud SQL 說明文件。如要瞭解 Cloud SQL 定價和相關限制,請參閱 Cloud SQL 定價頁面。App Engine 應用程式也會受到 App Engine 配額的限制。

事前準備

  1. 在 GCP 主控台建立或選取 GCP 專案,然後確認該專案包含 App Engine 應用程式且啟用了計費功能:
    前往 App Engine

    如果您的專案中已存在 App Engine 應用程式且已經啟用計費功能,系統就會開啟資訊主頁。否則,請按照提示選取地區,然後啟用計費功能。

  2. 啟用Cloud SQL API。

    啟用 API

  3. 如要使用 gcloud 工具部署應用程式,您必須下載、安裝並初始化 Cloud SDK:
    下載 SDK

設定 Cloud SQL 執行個體

如何建立和設定 Cloud SQL 執行個體:

  1. 建立 PostgreSQL 適用的 Cloud SQL 執行個體
  2. 如果您尚未在 Cloud SQL 執行個體上設定預設使用者的密碼,請先完成設定作業:
    gcloud sql users set-password postgres no-host --instance [INSTANCE_NAME] --password [PASSWORD]
    
  3. 如果您不想要使用預設的使用者來連線,請建立使用者
  4. 記錄該執行個體的連線名稱:
    gcloud sql instances describe [INSTANCE_NAME]
    

    例如:

    connectionName: project1:us-central1:instance1
    

    在 Google Cloud Platform 主控台的「執行個體詳細資料」頁面也可以找到此值。

  5. 在 Cloud SQL 執行個體上建立資料庫。
    gcloud sql databases create [DATABASE_NAME] --instance=[INSTANCE_NAME]
    
    如需進一步瞭解如何建立和管理資料庫,請參閱 Cloud SQL 說明文件

設定您的本機環境

您的應用程式在部署後,就會使用內建於 App Engine 執行階段環境的 Cloud SQL Proxy 與您的 Cloud SQL 執行個體通訊。不過,如要在本機測試應用程式,您就必須在開發環境安裝並使用 Cloud SQL Proxy 本機副本。

如要在 Cloud SQL 執行個體上執行基本的管理工作,可以使用資料庫的管理用戶端或 GCP 主控台。

  1. 驗證 gcloud 工具,以便使用 Proxy 從您的本機電腦連線:

    gcloud auth application-default login
    
  2. 安裝 Cloud SQL Proxy:

    Linux 64 位元

    1. 下載 Proxy:
      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
      
    2. 將 Proxy 設定為可執行:
      chmod +x cloud_sql_proxy
      

    Linux 32 位元

    1. 下載 Proxy:
      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy
      
    2. 將 Proxy 設定為可執行:
      chmod +x cloud_sql_proxy
      

    macOS 64 位元

    1. 下載 Proxy:
      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64
      
    2. 將 Proxy 設定為可執行:
      chmod +x cloud_sql_proxy
      

    macOS 32 位元

    1. 下載 Proxy:
      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386
      
    2. 將 Proxy 設定為可執行:
      chmod +x cloud_sql_proxy
      

    Windows 64 位元

    https://dl.google.com/cloudsql/cloud_sql_proxy_x64.exe 上按一下滑鼠右鍵,然後選取 [另存連結為...] 來下載 Proxy,並將這個程式重新命名為 cloud_sql_proxy.exe

    Windows 32 位元

    https://dl.google.com/cloudsql/cloud_sql_proxy_x86.exe 上按一下滑鼠右鍵,然後選取 [另存連結為...] 來下載 Proxy,並將這個程式重新命名為 cloud_sql_proxy.exe
    如果您的作業系統不包含在內,您也可以從來源編譯 Proxy

  3. 執行 Proxy:

    根據您的語言與環境,您可以使用 TCP 通訊端或 Unix 通訊端啟動 Proxy。

    TCP 通訊端

    1. 從「執行個體詳細資料」頁面複製您的執行個體連線名稱。
    2. 如果您是使用服務帳戶來驗證 Proxy,請記下您建立服務帳戶時所建立的私密金鑰檔案的用戶端機器位置。
    3. 啟動 Proxy。

      下列為部分可能使用的 Proxy 叫用字串:

      • 使用 Cloud SDK 驗證:
        ./cloud_sql_proxy -instances=<INSTANCE_CONNECTION_NAME>=tcp:5432
        
        不能指定使用中的通訊埠,例如由本機資料庫伺服器使用中的通訊埠。
      • 使用服務帳戶並明確指定執行個體 (建議用於實際工作環境):
        ./cloud_sql_proxy -instances=<INSTANCE_CONNECTION_NAME>=tcp:5432 \
                          -credential_file=<PATH_TO_KEY_FILE> &
        

      如要進一步瞭解 Proxy 選項,請參閱驗證 Proxy 的選項指定執行個體的選項

    Unix 通訊端

    1. 如果您要明確指定執行個體,請從「執行個體詳細資料」頁面複製執行個體連線名稱。
    2. 建立要讓 Proxy 通訊端運作的目錄:
      sudo mkdir /cloudsql; sudo chmod 777 /cloudsql
    3. 如果您是使用服務帳戶來驗證 Proxy,請記下您建立服務帳戶時所建立的私密金鑰檔案的用戶端機器位置。
    4. 開啟新的終端機視窗並啟動 Proxy。

      下列為部分可能使用的 Proxy 叫用字串:

      • 使用服務帳戶並明確指定執行個體 (建議用於實際工作環境):
        ./cloud_sql_proxy -dir=/cloudsql -instances=<INSTANCE_CONNECTION_NAME> \
                          -credential_file=<PATH_TO_KEY_FILE> &
      • 使用 Cloud SDK 驗證及自動探索執行個體功能:
        ./cloud_sql_proxy -dir=/cloudsql &

      建議您在 Proxy 本身的終端機上啟動 Proxy。如此一來,您可以監控 Proxy 的輸出,而不會使其混入其他程式的輸出。

      如要進一步瞭解 Proxy 選項,請參閱驗證 Proxy 的選項指定執行個體的選項

  4. 如要使用管理用戶端,您可以安裝本機副本,然後使用 Proxy 或 IP 位址進行連線。

    詳情請參閱使用 Cloud SQL Proxy 連結 psql 用戶端使用 IP 位址連結 psql 用戶端

設定連線字串及新增程式庫

  1. 設定本機環境以支援本機測試的連線。

    以下列提供的範例程式碼為例:

    export POSTGRES_USER=[YOUR_USER]
    export POSTGRES_PASSWORD=[YOUR_PASSWORD]
    export POSTGRES_DATABASE=[YOUR_DATABASE]
    export POSTGRES_SOCKET_PATH=/cloudsql/[YOUR_INSTANCE_CONNECTION_NAME]
    

  2. 為了讓應用程式在部署後可連線到 Cloud SQL 執行個體,請在 Cloud SQL 上將使用者、密碼、資料庫和執行個體連線名稱變數新增至 app.yaml 檔案的相關環境變數:

    env_variables:
      POSTGRES_USER: [YOUR_USER]
      POSTGRES_PASSWORD: [YOUR_PASSWORD]
      POSTGRES_DATABASE: [YOUR_DATABASE]
      POSTGRES_SOCKET_PATH: /cloudsql/[YOUR_INSTANCE_CONNECTION_NAME]
  3. 使用您的 Cloud SQL 執行個體連線名稱,在 app.yaml 中新增 beta_settings 區段。

    beta_settings:
      cloud_sql_instances: [YOUR_INSTANCE_CONNECTION_NAME]

  4. 在應用程式的 Gemfile 中新增 Ruby PostgreSQL 用戶端程式庫。例如,範例中的程式碼會使用 Sequel 搭配 Pg 做為驅動程式:

    source "https://rubygems.org"
    
    gem "pg"
    gem "sequel"

  5. 安裝應用程式依附元件:

    bundle install
    

    如要進一步瞭解 Bundler,請參閱使用 Ruby 程式庫

執行範例程式碼

下面的 app.rb 範例使用 Sinatra 架構在 Cloud SQL 執行個體中建立訪客記錄檔,同時也會使用 Sequel 處理連線集區和查詢。

在執行這個範例之前,請先建立所需的資料表,以確保資料庫設定正確無誤:

bundle exec ruby create_tables.rb
以下範例會將造訪資料寫入 Cloud SQL,然後讀取並傳回最後十次的造訪:
require "digest/sha2"
require "sinatra"
require "sequel"

DB = Sequel.postgres user:     ENV["POSTGRES_USER"],
                     password: ENV["POSTGRES_PASSWORD"],
                     database: ENV["POSTGRES_DATABASE"],
                     host:     ENV["POSTGRES_SOCKET_PATH"]

get "/" do
  # Store a hash of the visitor's ip address
  visitor_ip = Digest::SHA256.hexdigest request.ip

  # Save visit in database
  DB[:visits].insert user_ip: visitor_ip, timestamp: Time.now

  # Retrieve the latest 10 visit records from the database
  visits = DB[:visits].limit(10).order Sequel.desc(:timestamp)

  response.write "Last 10 visits:\n"

  visits.each do |visit|
    response.write "Time: #{visit[:timestamp]} Addr: #{visit[:user_ip]}\n"
  end

  content_type "text/plain"
  status 200
end

測試與部署

  1. 如要在本機測試您的應用程式,請輸入:

    bundle exec ruby app.rb
    

  2. 本機測試後,請將您的應用程式部署至 App Engine

    gcloud app deploy
    

  3. 如要啟動瀏覽器並在 http://[YOUR_PROJECT_ID].appspot.com 查看應用程式,請執行以下指令:

    gcloud app browse
    

在不同的專案中執行 Cloud SQL 與 App Engine

如果您的 App Engine 應用程式和 Cloud SQL 執行個體位在不同的 Google Cloud Platform 專案中,您必須使用服務帳戶以允許 App Engine 應用程式存取 Cloud SQL。

這個服務帳戶代表您的 App Engine 應用程式,系統預設會在您建立 Google Cloud Platform 專案時一併建立此帳戶。

  1. 如果您的 App Engine 應用程式和 Cloud SQL 執行個體位於相同專案內,請略過此節並前往設定您的本機環境。否則,請繼續執行下一步。
  2. 找出與 App Engine 應用程式相關聯的服務帳戶。預設的 App Engine 服務帳戶名稱為 [PROJECT-ID]@appspot.gserviceaccount.com

    您可以在「IAM 權限」頁面中驗證該 App Engine 服務帳戶。請確認您選取的是 App Engine 應用程式的專案,而非 Cloud SQL 執行個體的專案。

    前往「IAM 權限」頁面

  3. 前往 Google Cloud Platform 主控台中的「IAM 與管理員」頁面。

    前往「IAM 與管理員」頁面

  4. 選取含有 Cloud SQL 執行個體的專案。
  5. 搜尋服務帳戶名稱。
  6. 如果該服務帳戶已存在,且擁有包含 cloudsql.instances.connect 權限的角色,您可以繼續設定您的本機環境

    與舊版 EditorOwner 專案角色一樣,Cloud SQL ClientCloud SQL EditorCloud SQL Admin 角色均會提供必要權限。

  7. 否則,請按一下 [新增] 以新增服務帳戶。
  8. 在「新增成員」對話方塊中,輸入服務帳戶的名稱,然後選取含有 cloudsql.instances.connect 權限的角色 (除了 [檢視者] 之外,每個 Cloud SQL 預先定義的角色皆有權限)。

    或者,您可以選取 [專案] > [編輯者] 來使用原始編輯者角色,不過編輯者角色包含 Google Cloud Platform 中的各種權限。

    如果您沒有看到這些角色,即表示您的 Google Cloud Platform 使用者可能沒有 resourcemanager.projects.setIamPolicy 權限。您可以前往 Google Cloud Platform 主控台的 IAM 頁面,然後搜尋您的使用者 ID,藉以檢查您的權限。

  9. 按一下 [新增]。

    此時畫面上應該會顯示服務帳戶並列出指定的角色。

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Ruby 適用的 App Engine 彈性環境文件