JDBC

Apps Script puede conectarse a bases de datos externas a través del servicio de JDBC, un wrapper de la tecnología estándar de conectividad a bases de datos de Java. El servicio de JDBC es compatible con las bases de datos de Google Cloud SQL para MySQL, MySQL, Microsoft SQL Server y Oracle.

Para actualizar una base de datos externa con JDBC, tu secuencia de comandos debe abrir una conexión a la base de datos y, luego, realizar cambios mediante el envío de instrucciones de SQL.

Bases de datos de Google Cloud SQL

Google Cloud SQL te permite crear bases de datos relacionales que se alojan en la nube de Google. Ten en cuenta que Cloud SQL puede generar cargos según tu uso.

Para crear una instancia de Google Cloud SQL, sigue los pasos que se indican en la guía de inicio rápido de Cloud SQL.

Crea conexiones de Google Cloud SQL

Hay dos formas de establecer una conexión con una base de datos de Google Cloud SQL mediante el servicio de JDBC de Apps Script:

Estos métodos se explican a continuación. Ambos son válidos, pero el segundo método requiere que autorices un conjunto de rangos de IP para acceder a tu base de datos.

Este método crea una conexión a una instancia de MySQL en Google Cloud SQL mediante el método Jdbc.getCloudSqlConnection(url). La URL de la base de datos tiene el formato jdbc:google:mysql://subname, en el que subname es el nombre de la conexión de la instancia de MySQL que aparece en la página Descripción general de la instancia de Cloud SQL en la consola de Google Cloud.

Para conectarte a SQL Server de Cloud SQL, consulta Jdbc.getConnection(url).

Con Jdbc.getConnection(url)

Para utilizar este método, debes autorizar ciertos rangos de direcciones IP de Enrutamiento entre dominios sin clases (CIDR) para que los servidores de Apps Script puedan conectarse a tu base de datos. Antes de ejecutar la secuencia de comandos, completa los siguientes pasos:

  1. En tu instancia de Google Cloud SQL, autoriza los rangos de IP, uno a la vez, desde esta fuente de datos.

  2. Copia la URL que se asignó a tu base de datos; debe tener el formato jdbc:mysql:subname.

Una vez que hayas autorizado estos rangos de IP, puedes crear conexiones a tu instancia de Google Cloud SQL mediante uno de los métodos Jdbc.getConnection(url) y la URL que copiaste antes.

Otras bases de datos

Si ya tienes tu propia base de datos MySQL, Oracle o Microsoft SQL Server, puedes conectarte a ella a través del servicio JDBC de Apps Script.

Crea otras conexiones de bases de datos

Para crear una conexión de base de datos mediante el servicio de JDBC de Apps Script, en la configuración de tu base de datos debes autorizar rangos de IP desde esta fuente de datos.

Una vez implementadas estas listas, puedes crear una conexión a la base de datos mediante uno de los métodos Jdbc.getConnection(url) y la URL de tu base de datos.

Código de muestra

El siguiente código de muestra supone que te conectas a una base de datos de Google Cloud SQL y crea conexiones de bases de datos con el método Jdbc.getCloudSqlConnection(url). Para otras bases de datos, debes usar el método Jdbc.getConnection(url) para crear conexiones de base de datos.

Para obtener más información sobre los métodos de JDBC, consulta la documentación de Java para JDBC.

Crea una base de datos, un usuario y una tabla

La mayoría de los desarrolladores usan la herramienta de línea de comandos de MySQL para crear bases de datos, usuarios y tablas. Sin embargo, es posible hacer lo mismo en Apps Script, como se muestra a continuación. Se recomienda crear al menos un usuario más para que la secuencia de comandos no siempre tenga que conectarse a la base de datos 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);
  }
}

Realiza operaciones de escritura en la base de datos

En los siguientes ejemplos, se muestra cómo escribir un solo registro en la base de datos y un lote de 500 registros. La agrupación en lotes es fundamental para las operaciones masivas.

Observa también el uso de declaraciones con parámetros, en las que las variables se denotan con ?. A fin de evitar los ataques de inyección de SQL, debes usar instrucciones parametrizadas para escapar todos los datos proporcionados por el usuario.

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);
  }
}

Realiza operaciones de lectura desde la base de datos

En este ejemplo, se muestra cómo leer una gran cantidad de registros desde la base de datos y aplicar un bucle al conjunto de resultados según sea necesario.

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);
  }
}

Cierra conexiones

Las conexiones de JDBC se cierran automáticamente cuando una secuencia de comandos termina de ejecutarse. Ten en cuenta que una sola llamada a google.script.run cuenta como una ejecución completa, incluso si la página de servicio HTML que realizó la llamada permanece abierta.

No obstante, si sabes que ya terminaste con una conexión, una declaración o un conjunto de resultados antes del final de la secuencia de comandos, se recomienda cerrarlos de forma manual. Para ello, llama a JdbcConnection.close(), JdbcStatement.close() o JdbcResultSet.close().

Si muestras un diálogo de alerta o mensaje, también se finalizará cualquier conexión JDBC abierta. Sin embargo, otras acciones que muestren elementos de la IU, como menús o diálogos personalizados y barras laterales con contenido personalizado, no lo hacen.

Google, Google Workspace y las marcas y los logotipos relacionados son marcas de Google LLC. Todos los demás nombres de productos y empresas son marcas de las empresas con las que están asociados.