JDBC

O Apps Script pode se conectar a bancos de dados externos por meio do serviço JDBC, um wrapper que usa a tecnologia Java Database Connectivity padrão. O serviço JDBC oferece suporte aos bancos de dados Google Cloud SQL para MySQL, MySQL, Microsoft SQL Server e Oracle.

Para atualizar um banco de dados externo com JDBC, seu script precisa abrir uma conexão com o banco de dados e fazer alterações enviando instruções SQL.

Bancos de dados do Google Cloud SQL

O Google Cloud SQL permite criar bancos de dados relacionais que residem na nuvem do Google. O Cloud SQL pode gerar cobranças com base no seu uso.

É possível criar uma instância do Google Cloud SQL seguindo as etapas listadas no Guia de início rápido do Cloud SQL.

Como criar conexões do Google Cloud SQL

Há duas maneiras de estabelecer uma conexão com um banco de dados do Google Cloud SQL usando o serviço JDBC do Apps Script:

Esses métodos são explicados a seguir. Ambos são válidos, mas o segundo método exige que você autorize um conjunto de intervalos de IP para acessar seu banco de dados.

Este método cria uma conexão com uma instância MySQL do Google Cloud SQL usando o método Jdbc.getCloudSqlConnection(url). O URL do banco de dados tem o formato jdbc:google:mysql://subname, em que subname é o Nome da conexão da instância do MySQL listado na página Visão geral da instância do Cloud SQL no console do Google Cloud.

Para se conectar ao Cloud SQL Server, consulte Jdbc.getConnection(url).

Como usar Jdbc.getConnection(url)

Para usar esse método, é preciso autorizar determinados intervalos de endereços IP de roteamento entre domínios sem classe (CIDR, na sigla em inglês) para que os servidores do Apps Script possam se conectar ao seu banco de dados. Antes de executar o script, siga estas etapas:

  1. Na instância do Google Cloud SQL, autorize os intervalos de IP, um por vez usando essa fonte de dados.

  2. Copie o URL que foi atribuído ao seu banco de dados. Ele precisa ter o formato jdbc:mysql:subname.

Depois de autorizar esses intervalos de IP, crie conexões com a instância do Google Cloud SQL usando um dos métodos Jdbc.getConnection(url) e o URL copiado acima.

Outros bancos de dados

Se você já tem um banco de dados MySQL, Microsoft SQL Server ou Oracle, pode se conectar a ele por meio do serviço JDBC do Apps Script.

Como criar outras conexões de banco de dados

Para criar uma conexão de banco de dados usando o serviço JDBC do Apps Script, é necessário autorizar intervalos de IP desta fonte de dados nas configurações do banco de dados.

Quando essas listas de permissões estiverem em vigor, será possível criar uma conexão com o banco de dados usando um dos métodos Jdbc.getConnection(url) e o URL do seu banco de dados.

Exemplo de código

O código de amostra abaixo pressupõe que você está se conectando a um banco de dados do Google Cloud SQL e cria conexões de banco de dados usando o método Jdbc.getCloudSqlConnection(url). Para outros bancos de dados, use o método Jdbc.getConnection(url) para criar conexões de banco de dados.

Para mais informações sobre os métodos do JDBC, consulte a documentação Java para JDBC.

Criar um banco de dados, usuário e tabela

A maioria dos desenvolvedores usa a ferramenta de linha de comando MySQL para criar bancos de dados, usuários e tabelas. No entanto, é possível fazer a mesma coisa no Apps Script, conforme mostrado abaixo. É uma boa ideia criar pelo menos um outro usuário para que o script não precise sempre se conectar ao banco de dados como root.

service/jdbc.gs
/**
 * Create a new database within a Cloud SQL instance.
 */
function createDatabase() {
  try {
    const conn = Jdbc.getCloudSqlConnection(instanceUrl, root, rootPwd);
    conn.createStatement().execute('CREATE DATABASE ' + db);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

/**
 * Create a new user for your database with full privileges.
 */
function createUser() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, root, rootPwd);

    const stmt = conn.prepareStatement('CREATE USER ? IDENTIFIED BY ?');
    stmt.setString(1, user);
    stmt.setString(2, userPwd);
    stmt.execute();

    conn.createStatement().execute('GRANT ALL ON `%`.* TO ' + user);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

/**
 * Create a new table in the database.
 */
function createTable() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);
    conn.createStatement().execute('CREATE TABLE entries ' +
      '(guestName VARCHAR(255), content VARCHAR(255), ' +
      'entryID INT NOT NULL AUTO_INCREMENT, PRIMARY KEY(entryID));');
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

Gravar no banco de dados

Os exemplos abaixo demonstram como gravar um único registro no banco de dados, bem como um lote de 500 registros. O agrupamento é vital para operações em massa.

Observe também o uso de instruções parametrizadas, em que as variáveis são indicadas por ?. Para evitar ataques de injeção de SQL, use instruções parametrizadas para escapar todos os dados fornecidos pelo usuário.

service/jdbc.gs
/**
 * Write one row of data to a table.
 */
function writeOneRecord() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);

    const stmt = conn.prepareStatement('INSERT INTO entries ' +
      '(guestName, content) values (?, ?)');
    stmt.setString(1, 'First Guest');
    stmt.setString(2, 'Hello, world');
    stmt.execute();
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

/**
 * Write 500 rows of data to a table in a single batch.
 */
function writeManyRecords() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);
    conn.setAutoCommit(false);

    const start = new Date();
    const stmt = conn.prepareStatement('INSERT INTO entries ' +
      '(guestName, content) values (?, ?)');
    for (let i = 0; i < 500; i++) {
      stmt.setString(1, 'Name ' + i);
      stmt.setString(2, 'Hello, world ' + i);
      stmt.addBatch();
    }

    const batch = stmt.executeBatch();
    conn.commit();
    conn.close();

    const end = new Date();
    console.log('Time elapsed: %sms for %s rows.', end - start, batch.length);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

Ler do banco de dados

Este exemplo demonstra como ler um grande número de registros do banco de dados, repetindo o conjunto de resultados conforme necessário.

service/jdbc.gs
/**
 * Read up to 1000 rows of data from the table and log them.
 */
function readFromTable() {
  try {
    const conn = Jdbc.getCloudSqlConnection(dbUrl, user, userPwd);
    const start = new Date();
    const stmt = conn.createStatement();
    stmt.setMaxRows(1000);
    const results = stmt.executeQuery('SELECT * FROM entries');
    const numCols = results.getMetaData().getColumnCount();

    while (results.next()) {
      let rowString = '';
      for (let col = 0; col < numCols; col++) {
        rowString += results.getString(col + 1) + '\t';
      }
      console.log(rowString);
    }

    results.close();
    stmt.close();

    const end = new Date();
    console.log('Time elapsed: %sms', end - start);
  } catch (err) {
    // TODO(developer) - Handle exception from the API
    console.log('Failed with an error %s', err.message);
  }
}

Como fechar conexões

As conexões JDBC são fechadas automaticamente quando a execução de um script é concluída. Lembre-se de que uma única chamada google.script.run conta como uma execução completa, mesmo que a página do serviço HTML que fez a chamada permaneça aberta.

No entanto, se você sabe que concluiu uma conexão, instrução ou conjunto de resultados antes do final do script, é recomendável encerrá-los manualmente chamando JdbcConnection.close(), JdbcStatement.close() ou JdbcResultSet.close().

Mostrar uma caixa de diálogo de alerta ou prompt também encerra todas as conexões JDBC abertas. No entanto, outros elementos da interface, como menus ou caixas de diálogo personalizados e barras laterais com conteúdo personalizado, não.

Google, Google Workspace e as marcas e os logotipos relacionados são marcas registradas da Google LLC. Todos os outros nomes de empresas e produtos são marcas registradas das empresas a que estão associados.