Como usar o Cloud SQL para PostgreSQL

Nesta página, mostramos como se conectar a uma instância do Cloud SQL para PostgreSQL de um aplicativo do App Engine e como fazer leituras e gravações no Cloud SQL. O Cloud SQL é um banco de dados SQL que reside na nuvem do Google.

Para saber mais, consulte a documentação do Cloud SQL. Para informações sobre preços e limites do Cloud SQL, consulte a página de preços do Cloud SQL. Os aplicativos do App Engine também estão sujeitos às cotas dessa plataforma.

Antes de começar

  1. Crie ou selecione um projeto do GCP no console do GCP e verifique se o projeto inclui um aplicativo do App Engine e se o faturamento está ativado:
    Acessar o App Engine

    O Painel será aberto se houver um aplicativo do App Engine no projeto e o faturamento estiver ativado. Caso contrário, siga as instruções para escolher uma região e ativar o faturamento.

  2. Ativar Cloud SQL API.

    Ativar a a API

  3. Para implantar o aplicativo com a ferramenta gcloud, faça o download, instale e inicialize o Google Cloud SDK:
    Fazer o download do SDK

Como configurar a instância do Cloud SQL

Para criar e configurar uma instância do Cloud SQL, siga estas etapas:

  1. Crie uma instância do Cloud SQL para PostgreSQL.
  2. Defina a senha do usuário padrão na instância do Cloud SQL, se ainda não fez isso:
    gcloud sql users set-password postgres no-host --instance [INSTANCE_NAME] --password [PASSWORD]
    
  3. Para se conectar com um usuário diferente do padrão, crie-o.
  4. Registre o nome da conexão da instância:
    gcloud sql instances describe [INSTANCE_NAME]
    

    Por exemplo:

    connectionName: project1:us-central1:instance1
    

    Você também encontra esse valor na página Detalhes da instância no console do Google Cloud Platform.

  5. Crie um banco de dados na instância do Cloud SQL.
    gcloud sql databases create [DATABASE_NAME] --instance=[INSTANCE_NAME]
    
    Para mais informações sobre como criar e gerenciar bancos de dados, consulte a documentação do Cloud SQL.

Como configurar o ambiente local

Depois de implantado, o aplicativo usa o Cloud SQL Proxy incorporado ao ambiente de execução do App Engine para se comunicar com a instância do Cloud SQL. No entanto, para testar o aplicativo no local, é necessário instalar e usar uma cópia local do Cloud SQL Proxy no ambiente de desenvolvimento.

Para executar tarefas administrativas básicas na instância do Cloud SQL, use o cliente de administração do banco de dados ou o console do GCP.

  1. Autentique a ferramenta gcloud para usar o proxy na conexão da sua máquina local:

    gcloud auth application-default login
    
  2. Instale o Cloud SQL Proxy:

    Linux de 64 bits

    1. Faça o download do proxy:
      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
      
    2. Torne o proxy executável:
      chmod +x cloud_sql_proxy
      

    Linux de 32 bits

    1. Faça o download do proxy:
      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy
      
    2. Torne o proxy executável:
      chmod +x cloud_sql_proxy
      

    macOS de 64 bits

    1. Faça o download do proxy:
      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64
      
    2. Torne o proxy executável:
      chmod +x cloud_sql_proxy
      

    macOS de 32 bits

    1. Faça o download do proxy:
      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386
      
    2. Torne o proxy executável:
      chmod +x cloud_sql_proxy
      

    Windows de 64 bits

    Clique com o botão direito em https://dl.google.com/cloudsql/cloud_sql_proxy_x64.exe e selecione "Salvar link como..." para fazer o download do proxy, renomeando-o como cloud_sql_proxy.exe.

    Windows de 32 bits

    Clique com o botão direito em https://dl.google.com/cloudsql/cloud_sql_proxy_x86.exe e selecione "Salvar link como…" para fazer o download do proxy, renomeando-o como cloud_sql_proxy.exe.
    Caso seu sistema operacional não esteja incluído aqui, compile o proxy com base na origem.

  3. Execute o proxy:

    Dependendo da linguagem e do ambiente, inicie o proxy usando os soquetes TCP ou Unix.

    Soquetes TCP

    1. Copie o nome de conexão da instância na página Detalhes da instância.
    2. Se você estiver usando uma conta de serviço para autenticar o proxy, anote o local em que a chave privada foi criada na máquina cliente durante a criação da conta de serviço.
    3. Inicie o proxy.

      Algumas strings possíveis de chamada do proxy:

      • Usando autenticação do Cloud SDK:
        ./cloud_sql_proxy -instances=<INSTANCE_CONNECTION_NAME>=tcp:5432
        
        A porta especificada não pode estar em uso, por exemplo, por um servidor de banco de dados local.
      • Usando uma conta de serviço e a especificação explícita de uma instância (recomendado para ambientes de produção):
        ./cloud_sql_proxy -instances=<INSTANCE_CONNECTION_NAME>=tcp:5432 \
                          -credential_file=<PATH_TO_KEY_FILE> &
        

      Para mais informações sobre as opções de proxy, consulte Opções de autenticação do proxy e Opções de especificação de instâncias.

    Soquetes Unix

    1. Se estiver usando a especificação explícita de instâncias, copie o nome de conexão da instância da página Detalhes da instância.
    2. Crie o diretório em que os soquetes do proxy ficarão:
      sudo mkdir /cloudsql; sudo chmod 777 /cloudsql
    3. Se você estiver usando uma conta de serviço para autenticar o proxy, anote o local em que a chave privada foi criada na máquina cliente durante a criação da conta de serviço.
    4. Abra uma nova janela de terminal e inicie o proxy.

      Algumas strings possíveis de chamada do proxy:

      • Usando uma conta de serviço e a especificação explícita de uma instância (recomendado para ambientes de produção):
        ./cloud_sql_proxy -dir=/cloudsql -instances=<INSTANCE_CONNECTION_NAME> \
                          -credential_file=<PATH_TO_KEY_FILE> &
      • Usando a autenticação do Cloud SDK e a descoberta automática de instâncias:
        ./cloud_sql_proxy -dir=/cloudsql &

      É melhor iniciar o proxy em seu próprio terminal, assim você pode monitorar a saída dele sem misturá-la com a saída de outros programas.

      Para mais informações sobre as opções de proxy, consulte Opções de autenticação do proxy e Opções de especificação de instâncias.

  4. Para usar o cliente de administração, instale uma cópia local e conecte-se usando o proxy ou endereços IP.

    Para mais informações, consulte Como conectar o cliente psql usando o Cloud SQL Proxy e Como conectar o cliente psql usando endereços IP.

Como definir strings de conexão e adicionar uma biblioteca

  1. Configure o ambiente local para oferecer suporte a conexões de testes locais.

    Por exemplo, na amostra de código abaixo:

    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. Para permitir que o aplicativo se conecte à instância do Cloud SQL quando ele é implantado, adicione as variáveis de usuário, senha, banco de dados e nome de conexão da instância do Cloud SQL às variáveis de ambiente relacionadas no arquivo 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. Adicione a seção beta_settings ao app.yaml usando o nome de conexão da instância do Cloud SQL.

    beta_settings:
      cloud_sql_instances: [YOUR_INSTANCE_CONNECTION_NAME]

  4. Adicione uma biblioteca de cliente Ruby do PostgreSQL ao Gemfile do aplicativo. Por exemplo, a amostra de código inserida usa Sequel com Pg como o driver:

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

  5. Instale as dependências do aplicativo:

    bundle install
    

    Para mais informações sobre o Bundler, consulte Como usar bibliotecas Ruby.

Como executar o código de amostra

A amostra de app.rb abaixo usa a biblioteca Sinatra para criar um registro de visitantes em uma instância do Cloud SQL. Ela também usa Sequel, que lida com pool e consultas de conexão.

Antes de executar a amostra, crie as tabelas necessárias e verifique se o banco de dados está configurado corretamente:

bundle exec ruby create_tables.rb
A amostra a seguir grava as informações de visita ao Cloud SQL. Depois, ela lê e retorna as últimas dez visitas:
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

Como testar e implantar

  1. Para testar o aplicativo no local:

    bundle exec ruby app.rb
    

  2. Após os testes locais, implante o aplicativo no App Engine:

    gcloud app deploy
    

  3. Para iniciar o navegador e ver o aplicativo em http://[YOUR_PROJECT_ID].appspot.com, execute o seguinte comando:

    gcloud app browse
    

Como executar o Cloud SQL e o App Engine em projetos separados

Use uma conta de serviço para permitir o acesso do aplicativo do App Engine ao Cloud SQL, caso esse aplicativo e a instância do Cloud SQL estejam em projetos diferentes do Google Cloud Platform.

Essa conta de serviço representa o aplicativo do App Engine. Ela é gerada por padrão quando você cria um projeto do Google Cloud Platform.

  1. Se o aplicativo do App Engine estiver no mesmo projeto que a instância do Cloud SQL, ignore esta seção e vá para Como configurar o ambiente local. Caso contrário, prossiga para a próxima etapa.
  2. Identifique a conta de serviço associada ao aplicativo do App Engine. A conta padrão é denominada [PROJECT-ID]@appspot.gserviceaccount.com.

    É possível verificar a conta de serviço do App Engine na página Permissões de IAM. Lembre-se de selecionar o projeto do aplicativo do App Engine, e não a instância do Cloud SQL.

    Acessar a página "Permissões de IAM"

  3. Acesse a página Projetos do IAM e do administrador no Console do Google Cloud Platform.

    Acessar a página "Projetos do IAM e do administrador"

  4. Selecione o projeto que contém a instância do Cloud SQL.
  5. Procure o nome da conta de serviço.
  6. Se a conta de serviço já existir e tiver um papel que inclua a permissão cloudsql.instances.connect, prossiga para Como configurar o ambiente local.

    Os papéis Cloud SQL Client, Cloud SQL Editor e Cloud SQL Admin concedem a permissão necessária, assim como os papéis legados Editor e Owner do projeto.

  7. Caso contrário, clique em Adicionar para incluir a conta.
  8. Na caixa de diálogo Adicionar membros, insira o nome da conta de serviço e selecione um papel que inclua a permissão cloudsql.instances.connect. Qualquer papel predefinido do Cloud SQL funcionará, exceto Leitor.

    Também é possível usar o papel primitivo de editor ao selecionar Projeto > Editor. No entanto, ele inclui permissões no Google Cloud Platform.

    Se esses papéis não estiverem sendo exibidos, é provável que seu usuário do Google Cloud Platform não tenha a permissão resourcemanager.projects.setIamPolicy. Para verificar suas permissões, acesse a página de IAM no Console do Google Cloud Platform e procure sua ID de usuário.

  9. Clique em Adicionar.

    Você verá a conta de serviço listada com o papel especificado.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Ambiente flexível do App Engine para documentos do Ruby