google.cloud.bigquery.external_config.BigtableColumnFamily#

Methods

from_api_repr(resource)

Factory: construct a BigtableColumnFamily instance given its API representation.

to_api_repr()

Build an API representation of this object.

Attributes

columns

Lists of columns that should be exposed as individual fields.

encoding

The encoding of the values when the type is not STRING

family_id

Identifier of the column family.

only_read_latest

If this is set only the latest version of value are exposed for all columns in this column family.

type_

The type to convert the value in cells of this column family.


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

Bases: object

Options for a Bigtable column family.

property columns#

Lists of columns that should be exposed as individual fields.

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

Type

List[BigtableColumn]

property encoding#

The encoding of the values when the type is not STRING

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

Type

str

property family_id#

Identifier of the column family.

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

Type

str

classmethod from_api_repr(resource)[source]#

Factory: construct a BigtableColumnFamily instance given its API representation.

Parameters

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

Returns

Configuration parsed from resource.

Return type

BigtableColumnFamily

property only_read_latest#

If this is set only the latest version of value are exposed for all columns in this column family.

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

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]

property type_#

The type to convert the value in cells of this column family.

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

Type

str