Add or update a single record with Data Stores API on BigQuery - Query Results from Google Cloud API

Pipedream makes it easy to connect APIs for Data Stores, Google Cloud and 1400+ other apps remarkably fast.

Trigger workflow on

BigQuery - Query Results from the Google Cloud API

Next, do this

Add or update a single record with the Data Stores API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Cloud trigger and Data Stores action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the BigQuery - Query Results trigger
1. Connect your Google Cloud account
2. Configure Polling interval
3. Configure Event Size
4. Select a Dataset ID
5. Configure SQL Query
6. Optional- Configure De-duplication Key
Configure the Add or update a single record action
1. Connect your Data Stores account
2. Configure Data Store
3. Select a Key
4. Configure Value
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

BigQuery - Query Results on Google Cloud

Description:Emit new events with the results of an arbitrary query

Version:0.1.4

Key:google_cloud-bigquery-query-results

View on GitHub

Google Cloud Overview#

The Google Cloud API allows developers to access a variety of Google Cloud
services from their own applications. Services that can be accessed include
Google Cloud Storage, Google Cloud Datastore, Google Cloud Functions, and
Google Cloud Pub/Sub. With the Google Cloud API, developers can build a variety
of applications that take advantage of Google Cloud services.

Trigger Code#

import crypto from "crypto";
import { v4 as uuidv4 } from "uuid";
import common from "../common/bigquery.mjs";

export default {
  ...common,
  key: "google_cloud-bigquery-query-results",
  // eslint-disable-next-line pipedream/source-name
  name: "BigQuery - Query Results",
  description: "Emit new events with the results of an arbitrary query",
  version: "0.1.4",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    sqlQuery: {
      type: "string",
      label: "SQL Query",
      description: "Your SQL query",
    },
    dedupeKey: {
      type: "string",
      label: "De-duplication Key",
      description: `
        The name of a column in the table to use for deduplication. See [the
        docs](https://github.com/PipedreamHQ/pipedream/tree/master/components/google_cloud/sources/bigquery-query-results#technical-details)
        for more info.
      `,
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getQueryOpts() {
      return {
        query: this.sqlQuery,
      };
    },
    generateMeta(row, ts) {
      const { [this.dedupeKey]: id = uuidv4() } = row;
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
    generateMetaForCollection(rows, ts) {
      const hash = crypto.createHash("sha1");
      rows
        .map((i) => i[this.dedupeKey] || uuidv4())
        .map((i) => i.toString())
        .forEach((i) => hash.update(i));
      const id = hash.digest("base64");
      const summary = `New event (ID: ${id})`;
      return {
        id,
        summary,
        ts,
      };
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Cloud	`googleCloud`	`app`	This component uses the Google Cloud app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	How often to run your query
Event Size	`eventSize`	`integer`	The number of rows to include in a single event (by default, emits 1 event per row)
Dataset ID	`datasetId`	`string`	Select a value from the drop down menu.
SQL Query	`sqlQuery`	`string`	Your SQL query
De-duplication Key	`dedupeKey`	`string`	`The name of a column in the table to use for deduplication. See [the docs](https://github.com/PipedreamHQ/pipedream/tree/master/components/google_cloud/sources/bigquery-query-results#technical-details) for more info.`

Trigger Authentication#

Google Cloud uses API keys for authentication. When you connect your Google Cloud account, Pipedream securely stores the keys so you can easily authenticate to Google Cloud APIs in both code and no-code steps.

Create a service account in GCP and set the permissions you need for Pipedream workflows.
Generate a service account key
Download the key details in JSON format
Open the JSON in a text editor, and copy and paste its contents here.

About Google Cloud#

The Google Cloud Platform, including BigQuery

Action#

Add or update a single record on Data Stores

Description:Add or update a single record in your [Pipedream Data Store](https://pipedream.com/data-stores/).

Version:0.0.9

Key:data_stores-add-update-record

View on GitHub

Data Stores Overview#

With the Data Stores API, you can build applications that:

Store data for later retrieval
Retrieve data from a store
Update data in a store
Delete data from a store

Action Code#

import app from "../../data_stores.app.mjs";

export default {
  key: "data_stores-add-update-record",
  name: "Add or update a single record",
  description: "Add or update a single record in your [Pipedream Data Store](https://pipedream.com/data-stores/).",
  version: "0.0.9",
  type: "action",
  props: {
    app,
    dataStore: {
      propDefinition: [
        app,
        "dataStore",
      ],
    },
    key: {
      propDefinition: [
        app,
        "key",
        ({ dataStore }) => ({
          dataStore,
        }),
      ],
      description: "Enter a key for the record you'd like to create or select an existing key to update.",
    },
    value: {
      propDefinition: [
        app,
        "value",
      ],
    },
  },
  async run({ $ }) {
    const {
      key,
      value,
    } = this;
    const exists = await this.dataStore.has(key);
    const parsedValue = this.app.parseValue(value);
    await this.dataStore.set(key, parsedValue);
    // eslint-disable-next-line multiline-ternary
    $.export("$summary", `Successfully ${exists ? "updated the record for" : "added a new record with the"} key, \`${key}\`.`);
    return {
      key,
      value: parsedValue,
    };
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Data Stores	`app`	`app`	This component uses the Data Stores app.
Data Store	`dataStore`	`data_store`	Select an existing Data Store or create a new one.
Key	`key`	`string`	Select a value from the drop down menu.
Value	`value`	`any`	Enter a string, object, or array.