JDBC

Die Versionen 1.0 und 1.1 des TLS-Sicherheitsprotokolls sind deaktiviert. Verwenden Sie TLS 1.2 oder höher, um Verbindungen herzustellen.

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-, Oracle- und PostgreSQL-Datenbanken.

Wenn Ihre Tabelle zu groß wird oder bei komplexen Berechnungen Zeitüberschreitungen auftreten, kann das Verschieben Ihrer Daten in eine externe Datenbank die Leistung und Zuverlässigkeit erheblich verbessern.

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 Cloud von Google erstellen. Für Cloud SQL können je nach Nutzung Gebühren anfallen.

Erstellen Sie eine Google Cloud SQL-Instanz. Folgen Sie dazu der Anleitung im Cloud SQL-Schnellstart.

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:

Beide Methoden sind gültig. Bei der zweiten Methode müssen Sie jedoch eine Reihe von IP-Bereichen für den Zugriff auf Ihre Datenbank autorisieren.

Mit dieser Methode wird eine Verbindung zu einer Google Cloud SQL for MySQL-Instanz mit der Jdbc.getCloudSqlConnection hergestellt. Die Datenbank-URL hat das Format jdbc:google:mysql://subname, wobei subname der MySQL Verbindungsname der Instanz 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 for SQL Server finden Sie unter Jdbc.getConnection.

Jdbc.getConnection verwenden

Um diese Methode verwenden zu können, müssen Sie bestimmte Classless Inter-Domain Routing (CIDR) IP-Adressbereiche 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 in Ihrer Google Cloud SQL-Instanz die IP-Bereiche, 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, stellen Sie mit einer der Jdbc.getConnection Methoden und der zuvor kopierten URL Verbindungen zu Ihrer Google Cloud SQL-Instanz her.

Andere Datenbanken

Wenn Sie bereits eine eigene MySQL-, Microsoft SQL Server-, Oracle- oder PostgreSQL-Datenbank haben, stellen Sie über den JDBC-Dienst von Apps Script eine Verbindung zu ihr her.

Andere Datenbankverbindungen erstellen

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

Der JDBC-Dienst kann nur eine Verbindung zu Ports ab 1025 herstellen. Achten Sie darauf, dass Ihre Datenbank nicht über einen niedrigeren Port bereitgestellt wird.

Nachdem Sie diese Zulassungslisten eingerichtet haben, stellen Sie mit einer der Jdbc.getConnection Methoden und der URL Ihrer Datenbank eine Verbindung zur Datenbank her.

Beispielcode

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

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

Datenbank, Nutzer und Tabelle erstellen

Die meisten Entwickler verwenden das MySQL-Befehlszeilentool, um Datenbanken, Nutzer und Tabellen zu erstellen. Sie können aber auch in Apps Script dasselbe tun, wie im folgenden Beispiel gezeigt. Erstellen Sie mindestens einen weiteren Nutzer, 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

Die folgenden Beispiele zeigen, wie Sie einen einzelnen Datensatz und einen Batch mit 500 Datensätzen in die Datenbank schreiben. Batching ist für Bulk-Vorgänge unerlässlich.

Es werden parametrisierte Anweisungen verwendet, in denen die Variablen durch ? gekennzeichnet sind. Um SQL-Injection-Angriffe zu verhindern, verwenden Sie parametrisierte Anweisungen, 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);
  }
}

/**
 * Write 500 rows of data to a table in a single batch.
 * Recommended for faster writes
 */
function writeManyRecordsUsingExecuteBatch() {
  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 (?, ?)",
    );
    const params = [];
    for (let i = 0; i < 500; i++) {
      params.push([`Name ${i}`, `Hello, world ${i}`]);
    }

    const batch = stmt.executeBatch(params);
    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 Sie eine große Anzahl von Datensätzen aus der Datenbank lesen und das Ergebnisset nach Bedarf durchlaufen.

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

/**
 * Read up to 1000 rows of data from the table and log them.
 * Recommended for faster reads
 */
function readFromTableUsingGetRows() {
  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();
    const getRowArgs = [];
    for (let col = 0; col < numCols; col++) {
      getRowArgs.push(`getString(${col + 1})`);
    }
    const rows = results.getRows(getRowArgs.join(","));
    for (let i = 0; i < rows.length; i++) {
      console.log(rows[i].join("\t"));
    }

    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. (Einzelne google.script.run-Aufrufe gelten 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, eine Anweisung oder ein Ergebnisset vor dem Ende des Skripts nicht mehr benötigen, schließen Sie sie manuell mit JdbcConnection.close, JdbcStatement.close, oder JdbcResultSet.close.

Wenn Sie ein Warn- oder Eingabefeld anzeigen, werden auch alle offenen JDBC-Verbindungen beendet. Bei anderen UI-Elementen wie benutzerdefinierten Menüs oder Dialogfeldern und Seitenleisten mit benutzerdefinierten Inhalten ist das nicht der Fall.

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