Class BigtableOptions (3.19.0)

BigtableOptions()

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

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

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

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

Methods

from_api_repr

from_api_repr(
    resource: dict,
) -> google.cloud.bigquery.external_config.BigtableOptions

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

Parameter
NameDescription
resource Dict[str, Any]

Definition of a .external_config.BigtableOptions instance in the same representation as is returned from the API.

Returns
TypeDescription
BigtableOptionsConfiguration parsed from resource.

to_api_repr

to_api_repr() -> dict

Build an API representation of this object.

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