samples/append_rows_pending.js

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

function main(
  projectId = 'my_project',
  datasetId = 'my_dataset',
  tableId = 'my_table',
) {
  // [START bigquerystorage_append_rows_pending]
  const {adapt, managedwriter} = require('@google-cloud/bigquery-storage');
  const {WriterClient, Writer} = managedwriter;

  const customer_record_pb = require('./customer_record_pb.js');
  const {CustomerRecord} = customer_record_pb;

  const protobufjs = require('protobufjs');
  require('protobufjs/ext/descriptor');

  async function appendRowsPending() {
    /**
     * If you make updates to the customer_record.proto protocol buffers definition,
     * run:
     *   pbjs customer_record.proto -t static-module -w commonjs -o customer_record.js
     *   pbjs customer_record.proto -t json --keep-case -o customer_record.json
     * from the /samples directory to generate the customer_record module.
     */

    // So that BigQuery knows how to parse the serialized_rows, create a
    // protocol buffer representation of your message descriptor.
    const root = protobufjs.loadSync('./customer_record.json');
    const descriptor = root.lookupType('CustomerRecord').toDescriptor('proto2');
    const protoDescriptor = adapt.normalizeDescriptor(descriptor).toJSON();

    /**
     * TODO(developer): Uncomment the following lines before running the sample.
     */
    // projectId = 'my_project';
    // datasetId = 'my_dataset';
    // tableId = 'my_table';

    const destinationTable = `projects/${projectId}/datasets/${datasetId}/tables/${tableId}`;
    const streamType = managedwriter.PendingStream;
    const writeClient = new WriterClient({projectId});
    try {
      const writeStream = await writeClient.createWriteStreamFullResponse({
        streamType,
        destinationTable,
      });
      const streamId = writeStream.name;
      console.log(`Stream created: ${streamId}`);

      const connection = await writeClient.createStreamConnection({
        streamId,
      });
      const writer = new Writer({
        connection,
        protoDescriptor,
      });

      let serializedRows = [];
      const pendingWrites = [];

      // Row 1
      let row = {
        rowNum: 1,
        customerName: 'Octavia',
      };
      serializedRows.push(CustomerRecord.encode(row).finish());

      // Row 2
      row = {
        rowNum: 2,
        customerName: 'Turing',
      };
      serializedRows.push(CustomerRecord.encode(row).finish());

      // Set an offset to allow resuming this stream if the connection breaks.
      // Keep track of which requests the server has acknowledged and resume the
      // stream at the first non-acknowledged message. If the server has already
      // processed a message with that offset, it will return an ALREADY_EXISTS
      // error, which can be safely ignored.

      // The first request must always have an offset of 0.
      let offsetValue = 0;

      // Send batch.
      let pw = writer.appendRows({serializedRows}, offsetValue);
      pendingWrites.push(pw);

      serializedRows = [];

      // Row 3
      row = {
        rowNum: 3,
        customerName: 'Bell',
      };
      serializedRows.push(CustomerRecord.encode(row).finish());

      // Offset must equal the number of rows that were previously sent.
      offsetValue = 2;

      // Send batch.
      pw = writer.appendRows({serializedRows}, offsetValue);
      pendingWrites.push(pw);

      const results = await Promise.all(
        pendingWrites.map(pw => pw.getResult()),
      );
      console.log('Write results:', results);

      const {rowCount} = await connection.finalize();
      console.log(`Row count: ${rowCount}`);

      const response = await writeClient.batchCommitWriteStream({
        parent: destinationTable,
        writeStreams: [streamId],
      });

      console.log(response);
    } catch (err) {
      console.log(err);
    } finally {
      writeClient.close();
    }
  }
  // [END bigquerystorage_append_rows_pending]
  appendRowsPending();
}
process.on('unhandledRejection', err => {
  console.error(err.message);
  process.exitCode = 1;
});
main(...process.argv.slice(2));