As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

google.cloud.bigquery.external_config.BigtableOptions

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

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

__init__()[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()

Initialize self.

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.
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/tables#BigtableOptions.FIELDS.column_families

Type

List[BigtableColumnFamily]

classmethod from_api_repr(resource: dict) → google.cloud.bigquery.external_config.BigtableOptions[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/tables#BigtableOptions.FIELDS.ignore_unspecified_column_families

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/tables#BigtableOptions.FIELDS.read_rowkey_as_string

Type

bool

to_api_repr() → dict[source]

Build an API representation of this object.

Returns

A dictionary in the format used by the BigQuery API.

Return type

Dict[str, Any]