Class BigtableOptions (1.17.0)

Version 1.17.0

• 3.21.0 (latest)
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

BigtableOptions()

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

Inheritance

builtins.object > BigtableOptions

Properties

column_families

List[.external_config.BigtableColumnFamily]: 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

ignore_unspecified_column_families

bool: If :data:True, ignore columns not specified in column_families list. Defaults to :data: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

read_rowkey_as_string

bool: If :data:True, rowkey column families will be read and converted to string. Defaults to :data: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

Methods

__init__

__init__()

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

from_api_repr

from_api_repr(resource)

Factory: construct a .external_config.BigtableOptions instance given its API representation.

Parameter

Name	Description
resource	Dict[str, Any] Definition of a .external_config.BigtableOptions instance in the same representation as is returned from the API.

Returns

Type	Description
`.external_config.BigtableOptions`	Configuration parsed from ``resource``.

to_api_repr

to_api_repr()

Build an API representation of this object.

Returns

Type	Description
Dict[str, Any]	A dictionary in the format used by the BigQuery API.