73 lines
2.0 KiB
Markdown
73 lines
2.0 KiB
Markdown
---
|
|
title: bigtable.from() function
|
|
description: >
|
|
The `bigtable.from()` function retrieves data from a Google Cloud Bigtable data source.
|
|
aliases:
|
|
- /influxdb/v2.0/reference/flux/stdlib/experimental/bigtable/from/
|
|
- /influxdb/cloud/reference/flux/stdlib/experimental/bigtable/from/
|
|
menu:
|
|
flux_0_x_ref:
|
|
name: bigtable.from
|
|
parent: bigtable
|
|
weight: 401
|
|
flux/v0.x/tags: [inputs]
|
|
introduced: 0.45.0
|
|
---
|
|
|
|
The `bigtable.from()` function retrieves data from a [Google Cloud Bigtable](https://cloud.google.com/bigtable/)
|
|
data source.
|
|
|
|
```js
|
|
import "experimental/bigtable"
|
|
|
|
bigtable.from(
|
|
token: "mySuPeRseCretTokEn",
|
|
project: "exampleProjectID",
|
|
instance: "exampleInstanceID",
|
|
table: "example-table",
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
### token {data-type="string"}
|
|
The Google Cloud IAM token to use to access the Cloud Bigtable database.
|
|
|
|
_For more information, see the following:_
|
|
|
|
- [Cloud Bigtable Access Control](https://cloud.google.com/bigtable/docs/access-control)
|
|
- [Google Cloud IAM How-to guides](https://cloud.google.com/iam/docs/how-to)
|
|
- [Setting Up Authentication for Server to Server Production Applications on Google Cloud](https://cloud.google.com/docs/authentication/production)
|
|
|
|
### project {data-type="string"}
|
|
The project ID of the Cloud Bigtable project to retrieve data from.
|
|
|
|
### instance {data-type="string"}
|
|
The instance ID of the Cloud Bigtable instance to retrieve data from.
|
|
|
|
### table {data-type="string"}
|
|
The name of the Cloud Bigtable table to retrieve data from.
|
|
|
|
## Examples
|
|
|
|
{{% note %}}
|
|
The example below uses [InfluxDB secrets](/{{< latest "influxdb" >}}/security/secrets/)
|
|
to populate sensitive connection credentials.
|
|
{{% /note %}}
|
|
|
|
```js
|
|
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"
|
|
)
|
|
```
|