ContextQMD
Back to Influxdb

bigtable.from() function

content/flux/v0/stdlib/experimental/bigtable/from.md

latest1.9 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/experimental/bigtable/bigtable.flux#L42-L44 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

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

Function type signature
js
(instance: string, project: string, table: string, token: string) => stream[A] where A: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

token

({{< req >}}) Google Cloud IAM token to use to access the Cloud Bigtable database.

For more information, see the following:

project

({{< req >}}) Cloud Bigtable project ID.

instance

({{< req >}}) Cloud Bigtable instance ID.

table

({{< req >}}) Cloud Bigtable table name.

Examples

Query Google Cloud Bigtable

js
import "experimental/bigtable"

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