docs-v2/content/v2.0/reference/flux/stdlib/experimental/bigtable/from.md

1.8 KiB

title description menu weight
bigtable.from() function The `bigtable.from()` function retrieves data from a Google Cloud Bigtable data source.
v2_0_ref
name parent
bigtable.from Bigtable
401

The bigtable.from() function retrieves data from a Google Cloud Bigtable data source.

Function type: Input

import "experimental/bigtable"

bigtable.from(
  token: "mySuPeRseCretTokEn",
  project: "exampleProjectID",
  instance: "exampleInstanceID",
  table: "example-table"
)

Parameters

token

The Google Cloud IAM token to use to access the Cloud Bigtable database.

For more information, see the following:

Data type: String

project

The project ID of the Cloud Bigtable project to retrieve data from.

Data type: String

instance

The instance ID of the Cloud Bigtable instance to retrieve data from.

Data type: String

table

The name of the Cloud Bigtable table to retrieve data from.

Data type: String

Examples

{{% note %}} The example below uses InfluxDB secrets to populate sensitive connection credentials. {{% /note %}}

import "experimental/bigtable"
import "influxdata/influxdb/secrets"

bigtable_token = secrets.get(key: "BIGTABLE_TOKEN")
bigtable_project = secrets.get(key: "BIGTABLE_PROJECT_ID")
bigtable_instance = secrets.get(key: "BIGTABLE_INSTANCE_ID")

bigtable.from(
  token: bigtable_token,
  project: bigtable_project,
  instance: bigtable_instance,
  table: "example-table"
)