JDBC

Apps Script kann über den JDBC-Dienst eine Verbindung zu externen Datenbanken herstellen, einem Wrapper für die standardmäßige Java Database Connectivity-Technologie. Der JDBC-Dienst unterstützt Google Cloud SQL for MySQL, MySQL, Microsoft SQL Server und Oracle Datenbanken.

Zum Aktualisieren einer externen Datenbank mit JDBC muss Ihr Skript eine Verbindung zur Datenbank öffnen und dann Änderungen vornehmen, indem Sie SQL-Anweisungen senden.

Google Cloud SQL-Datenbanken

Mit Google Cloud SQL können Sie relationale Datenbanken erstellen, die in der Cloud von Google sind. Beachten Sie, dass bei Cloud SQL je nach Nutzung Gebühren anfallen können.

Sie können eine Google Cloud SQL-Instanz erstellen, indem Sie der Anleitung in der Cloud SQL-Kurzanleitung folgen.

Google Cloud SQL-Verbindungen erstellen

Es gibt zwei Möglichkeiten, eine Verbindung zu einer Google Cloud SQL-Datenbank mit dem JDBC-Dienst von Apps Script herzustellen:

Diese Methoden werden unten erläutert. Beide sind gültig, aber bei der zweiten Methode müssen Sie eine Reihe von IP-Bereichen für den Zugriff auf die Datenbank autorisieren.

Diese Methode erstellt mithilfe der Methode Jdbc.getCloudSqlConnection(url) eine Verbindung zu einer Google Cloud SQL-MySQL-Instanz. Die Datenbank-URL hat das Format jdbc:google:mysql://subname, wobei subname der Instanzverbindungsname von MySQL ist, der auf der Seite Übersicht der Cloud SQL-Instanz in der Google Cloud Console aufgeführt ist.

Informationen zum Herstellen einer Verbindung zu Cloud SQL SQL Server finden Sie unter Jdbc.getConnection(url).

Jdbc.getConnection(url) verwenden

Damit Sie diese Methode verwenden können, müssen Sie bestimmte CIDR-Adressbereiche (Classless Inter-Domain Routing) autorisieren, damit die Server von Apps Script eine Verbindung zu Ihrer Datenbank herstellen können. Führen Sie die folgenden Schritte aus, bevor Sie das Skript ausführen:

  1. Autorisieren Sie in Ihrer Google Cloud SQL-Instanz die IP-Bereiche nacheinander aus dieser Datenquelle.

  2. Kopieren Sie die URL, die Ihrer Datenbank zugewiesen wurde. Sie sollte das Format jdbc:mysql:subname haben.

Nachdem Sie diese IP-Bereiche autorisiert haben, können Sie mit der Methode Jdbc.getConnection(url) und der oben kopierten URL Verbindungen zu Ihrer Google Cloud SQL-Instanz erstellen.

Andere Datenbanken

Wenn Sie bereits eine eigene MySQL-, Microsoft SQL Server- oder Oracle-Datenbank haben, können Sie über den JDBC-Dienst von Apps Script eine Verbindung herstellen.

Weitere Datenbankverbindungen erstellen

Wenn Sie eine Datenbankverbindung mit dem JDBC-Dienst von Apps Script erstellen möchten, müssen Sie in Ihren Datenbankeinstellungen IP-Bereiche aus dieser Datenquelle autorisieren.

Sobald diese Zulassungslisten vorhanden sind, können Sie mit einer der Methoden Jdbc.getConnection(url) und der URL der Datenbank eine Verbindung zur Datenbank herstellen.

Beispielcode

Im Beispielcode wird davon ausgegangen, dass Sie eine Verbindung zu einer Google Cloud SQL-Datenbank herstellen und Datenbankverbindungen mit der Methode Jdbc.getCloudSqlConnection(url) herstellen. Für andere Datenbanken müssen Sie die Methode Jdbc.getConnection(url) verwenden, um Datenbankverbindungen zu erstellen.

Weitere Informationen zu den JDBC-Methoden finden Sie in der Java-Dokumentation für JDBC.

Datenbank, Nutzer und Tabelle erstellen

Die meisten Entwickler verwenden das MySQL-Befehlszeilentool, um Datenbanken, Nutzer und Tabellen zu erstellen. Mit Apps Script ist das jedoch möglich. Es empfiehlt sich, mindestens einen weiteren Nutzer zu erstellen, damit nicht immer eine Verbindung zur Datenbank als root hergestellt werden muss.

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

In die Datenbank schreiben

Die folgenden Beispiele zeigen, wie ein einzelner Datensatz in einen Batch mit 500 Einträgen in die Datenbank geschrieben wird. Die Batchverarbeitung ist für Bulk-Vorgänge unerlässlich.

Beachten Sie auch die Verwendung parametrisierter Anweisungen, in denen die Variablen durch ? gekennzeichnet sind. Um SQL-Injection-Angriffe zu verhindern, sollten Sie parametrisierte Anweisungen verwenden, um alle vom Nutzer bereitgestellten Daten zu maskieren.

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

Aus der Datenbank lesen

Dieses Beispiel zeigt, wie eine große Anzahl von Datensätzen aus der Datenbank gelesen und die Ergebnismenge nach Bedarf als Schleife wiedergegeben wird.

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

Verbindungen schließen

JDBC-Verbindungen werden automatisch geschlossen, wenn die Ausführung eines Skripts abgeschlossen ist. Hinweis: Ein einzelner google.script.run-Aufruf gilt als vollständige Ausführung, auch wenn die HTML-Dienstseite, die den Aufruf ausgeführt hat, geöffnet bleibt.

Wenn Sie jedoch wissen, dass Sie eine Verbindung, eine Anweisung oder eine Ergebnismenge vor dem Ende des Skripts abgeschlossen haben, sollten Sie diese manuell schließen, indem Sie JdbcConnection.close(), JdbcStatement.close() oder JdbcResultSet.close() aufrufen.

Wenn ein Benachrichtigungs- oder Aufforderungsdialogfeld angezeigt wird, werden auch alle offenen JDBC-Verbindungen beendet. Andere Elemente der Benutzeroberfläche, z. B. benutzerdefinierte Menüs oder Dialogfelder und Seitenleisten mit benutzerdefinierten Inhalten, sind jedoch nicht sichtbar.

Google, Google Workspace sowie zugehörige Warenzeichen und Logos sind Marken von Google LLC. Alle anderen Firmen- und Produktnamen sind Marken der jeweiligen Unternehmen.