JDBC

Apps Script kann Verbindungen zu externen Datenbanken über den JDBC-Dienst herstellen. Dies ist ein Wrapper für die Standardtechnologie der Java-Datenbankkonnektivität. Der JDBC-Dienst unterstützt Google Cloud SQL for MySQL-, MySQL-, Microsoft SQL Server- und Oracle-Datenbanken.

Wenn Sie eine externe Datenbank mit JDBC aktualisieren möchten, muss Ihr Skript eine Verbindung zur Datenbank öffnen und dann Änderungen vornehmen, indem es SQL-Anweisungen sendet.

Google Cloud SQL-Datenbanken

Mit Google Cloud SQL können Sie relationale Datenbanken in der Google Cloud erstellen. Für Cloud SQL können je nach Nutzung Kosten anfallen.

Sie können eine Google Cloud SQL-Instanz erstellen, indem Sie die Schritte in der Cloud SQL-Kurzanleitung ausführen.

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 im Folgenden erläutert. Beide sind gültig, aber für die zweite Methode müssen Sie eine Reihe von IP-Bereichen für den Zugriff auf Ihre Datenbank autorisieren.

Mit dieser Methode wird eine Verbindung zu einer Google Cloud SQL-MySQL-Instanz mit der Methode Jdbc.getCloudSqlConnection(url) hergestellt. Die Datenbank-URL hat das Format jdbc:google:mysql://subname, wobei subname der MySQL-Name der Instanzverbindung 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).

Mit Jdbc.getConnection(url)

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

  1. Autorisieren Sie die IP-Bereiche in Ihrer Google Cloud SQL-Instanz einzeln 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 einer der Jdbc.getConnection(url)-Methoden und der oben kopierten URL Verbindungen zu Ihrer Google Cloud SQL-Instanz herstellen.

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 dazu herstellen.

Andere Datenbankverbindungen erstellen

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

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

Beispielcode

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

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, wie unten gezeigt. Es empfiehlt sich, mindestens einen weiteren Nutzer zu erstellen, damit Ihr Skript nicht immer als root eine Verbindung zur Datenbank herstellen muss.

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

In die Datenbank schreiben

In den folgenden Beispielen wird gezeigt, wie ein einzelner Datensatz und ein Batch mit 500 Datensätzen in die Datenbank geschrieben werden. Batching 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.

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

Aus der Datenbank lesen

In diesem Beispiel wird gezeigt, wie eine große Anzahl von Datensätzen aus der Datenbank gelesen wird, wobei das Ergebnisset nach Bedarf durchlaufen wird.

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

Verbindungen schließen

JDBC-Verbindungen werden automatisch geschlossen, wenn die Ausführung eines Skripts abgeschlossen ist. Ein einzelner google.script.run-Aufruf gilt als vollständige Ausführung, auch wenn die HTML-Dienstseite, von der der Aufruf stammt, geöffnet bleibt.

Wenn Sie jedoch wissen, dass Sie eine Verbindung, Anweisung oder ein Ergebnis-Set vor dem Ende des Skripts nicht mehr benötigen, sollten Sie sie manuell schließen, indem Sie JdbcConnection.close(), JdbcStatement.close() oder JdbcResultSet.close() aufrufen.

Wenn ein Warn- oder Aufforderungsdialogfeld angezeigt wird, werden auch alle offenen JDBC-Verbindungen beendet. Andere UI-Elemente, die angezeigt werden, z. B. benutzerdefinierte Menüs oder Dialogfelder und Seitenleisten mit benutzerdefinierten Inhalten, sind davon jedoch nicht betroffen.

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