samples/append_rows_proto2.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_raw_proto2]
  const {adapt, managedwriter} = require('@google-cloud/bigquery-storage');
  const {WriterClient, Writer} = managedwriter;

  const sample_data_pb = require('./sample_data_pb.js');
  const {SampleData} = sample_data_pb;

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

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

    // So that BigQuery knows how to parse the serialized_rows, create a
    // protocol buffer representation of your message descriptor.
    const root = protobufjs.loadSync('./sample_data.json');
    const descriptor = root.lookupType('SampleData').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 streamId = await writeClient.createWriteStream({
        streamType,
        destinationTable,
      });
      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,
        boolCol: true,
        bytesCol: Buffer.from('hello world'),
        float64Col: parseFloat('+123.45'),
        int64Col: 123,
        stringCol: 'omg',
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 2
      row = {
        rowNum: 2,
        boolCol: false,
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 3
      row = {
        rowNum: 3,
        bytesCol: Buffer.from('later, gator'),
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 4
      row = {
        rowNum: 4,
        float64Col: 987.654,
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 5
      row = {
        rowNum: 5,
        int64Col: 321,
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 6
      row = {
        rowNum: 6,
        stringCol: 'octavia',
      };
      serializedRows.push(SampleData.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);

      // Reset rows.
      serializedRows = [];

      // Row 7
      const days = new Date('2019-02-07').getTime() / (1000 * 60 * 60 * 24);
      row = {
        rowNum: 7,
        dateCol: days, // The value is the number of days since the Unix epoch (1970-01-01)
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 8
      row = {
        rowNum: 8,
        datetimeCol: '2019-02-17 11:24:00.000',
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 9
      row = {
        rowNum: 9,
        geographyCol: 'POINT(5 5)',
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 10
      row = {
        rowNum: 10,
        numericCol: '123456',
        bignumericCol: '99999999999999999999999999999.999999999',
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 11
      row = {
        rowNum: 11,
        timeCol: '18:00:00',
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 12
      const timestamp = new Date('2022-01-09T03:49:46.564Z').getTime();
      row = {
        rowNum: 12,
        timestampCol: timestamp * 1000, // The value is given in microseconds since the Unix epoch (1970-01-01)
      };
      serializedRows.push(SampleData.encode(row).finish());

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

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

      serializedRows = [];

      // Row 13
      row = {
        rowNum: 13,
        int64List: [1999, 2001],
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 14
      row = {
        rowNum: 14,
        structCol: {
          subIntCol: 99,
        },
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 15
      row = {
        rowNum: 15,
        structList: [{subIntCol: 100}, {subIntCol: 101}],
      };
      serializedRows.push(SampleData.encode(row).finish());

      // Row 16
      const timestampStart = new Date('2022-01-09T03:49:46.564Z').getTime();
      const timestampEnd = new Date('2022-01-09T04:49:46.564Z').getTime();
      row = {
        rowNum: 16,
        rangeCol: {
          start: timestampStart * 1000,
          end: timestampEnd * 1000,
        },
      };
      serializedRows.push(SampleData.encode(row).finish());

      offsetValue = 12;

      // 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_raw_proto2]
  appendRowsProto2();
}
process.on('unhandledRejection', err => {
  console.error(err.message);
  process.exitCode = 1;
});
main(...process.argv.slice(2));