JDBC

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

Para atualizar um banco de dados externo com JDBC, o 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 ficam na nuvem do Google. O Cloud SQL pode gerar cobranças com base no seu uso.

Para criar uma instância do Google Cloud SQL, siga 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 abaixo. Ambos são válidos, mas o segundo método exige que você autorize um conjunto de intervalos de IP para acessar o banco de dados.

Esse método cria uma conexão com uma instância do 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 para SQL Server, consulte Jdbc.getConnection(url).

Usando Jdbc.getConnection(url)

Para usar esse método, é necessário autorizar determinados intervalos de endereços IP do roteamento entre domínios sem classe (CIDR) 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 sua instância do Google Cloud SQL, autorize os intervalos de IP, um de cada vez, usando esta fonte de dados.

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

Depois de autorizar esses intervalos de IP, você poderá criar 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á tiver seu próprio banco de dados MySQL, Microsoft SQL Server ou Oracle, é possível se conectar a ele pelo serviço JDBC do Apps Script.

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, nas configurações do banco de dados, é necessário autorizar intervalos de IP da origem de dados.

Depois que 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 banco de dados.

Código de amostra

O código de exemplo 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 JDBC, consulte a documentação do Java para JDBC.

Criar um banco de dados, um usuário e uma tabela

A maioria dos desenvolvedores usa a ferramenta de linha de comando do MySQL para criar bancos de dados, usuários e tabelas. No entanto, é possível fazer o mesmo no Apps Script, conforme mostrado abaixo. É recomendável criar pelo menos um outro usuário para que o script não precise 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 de 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, percorrendo 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 um script termina de ser executado. Uma única chamada de google.script.run é contabilizada como uma execução completa, mesmo que a página de serviço HTML que fez a chamada permaneça aberta.

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

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

​Google, Google Workspace e marcas e 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.