google.cloud.bigquery.external_config.BigtableColumn#

Methods

from_api_repr(resource)

Factory: construct a BigtableColumn instance given its API representation.

to_api_repr()

Build an API representation of this object.

Attributes

encoding

The encoding of the values when the type is not STRING

field_name

An identifier to use if the qualifier is not a valid BigQuery field identifier

only_read_latest

If this is set, only the latest version of value in this column are exposed.

qualifier_encoded

The qualifier encoded in binary.

qualifier_string

A valid UTF-8 string qualifier

type_

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


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

Bases: object

Options for a Bigtable column.

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.%28key%29.bigtableOptions.columnFamilies.columns.encoding https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.bigtableOptions.columnFamilies.columns.encoding

Type

str

property field_name#

An identifier to use if the qualifier is not a valid BigQuery field identifier

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

Type

str

classmethod from_api_repr(resource)[source]#

Factory: construct a BigtableColumn instance given its API representation.

Parameters

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

Returns

Configuration parsed from resource.

Return type

BigtableColumn

property only_read_latest#

If this is set, only the latest version of value in this column are exposed.

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

Type

bool

property qualifier_encoded#

The qualifier encoded in binary.

The type is str (Python 2.x) or bytes (Python 3.x). The module will handle base64 encoding for you.

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

Type

Union[str, bytes]

property qualifier_string#

A valid UTF-8 string qualifier

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

Type

str

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.

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

Type

str