google.cloud.bigquery.external_config.BigtableOptions#

Methods

from_api_repr(resource)

Factory: construct a BigtableOptions instance given its API representation.

to_api_repr()

Build an API representation of this object.

Attributes

column_families

List of column families to expose in the table schema along with their types.

ignore_unspecified_column_families

If True, ignore columns not specified in column_families list.

read_rowkey_as_string

If True, rowkey column families will be read and converted to string.


class google.cloud.bigquery.external_config.BigtableOptions[source]#

Bases: object

Options that describe how to treat Bigtable tables as BigQuery tables.

property column_families#

List of column families to expose in the table schema along with their types.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.columnFamilies https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies

Type

List[BigtableColumnFamily]

classmethod from_api_repr(resource)[source]#

Factory: construct a BigtableOptions instance given its API representation.

Parameters

resource (Dict[str, Any]) – Definition of a BigtableOptions instance in the same representation as is returned from the API.

Returns

Configuration parsed from resource.

Return type

BigtableOptions

property ignore_unspecified_column_families#

If True, ignore columns not specified in column_families list. Defaults to False.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.ignoreUnspecifiedColumnFamilies https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.ignoreUnspecifiedColumnFamilies

Type

bool

property read_rowkey_as_string#

If True, rowkey column families will be read and converted to string. Defaults to False.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).bigtableOptions.readRowkeyAsString https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.readRowkeyAsString

Type

bool

to_api_repr()[source]#

Build an API representation of this object.

Returns

A dictionary in the format used by the BigQuery API.

Return type

Dict[str, Any]