google.cloud.bigquery.external_config.ExternalConfig#

Methods

from_api_repr(resource)

Factory: construct an ExternalConfig instance given its API representation.

to_api_repr()

Build an API representation of this object.

Attributes

autodetect

If True, try to detect schema and format options automatically.

compression

The compression type of the data source.

ignore_unknown_values

If True, extra values that are not represented in the table schema are ignored.

max_bad_records

The maximum number of bad records that BigQuery can ignore when reading data.

options

Source-specific options.

schema

The schema for the data.

source_format

ExternalSourceFormat: Format of external source.

source_uris

URIs that point to your data in Google Cloud.


class google.cloud.bigquery.external_config.ExternalConfig(source_format)[source]#

Bases: object

Description of an external data source.

Parameters

source_format (ExternalSourceFormat) – See source_format.

property autodetect#

If True, try to detect schema and format options automatically.

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

Type

bool

property compression#

The compression type of the data source.

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

Type

str

classmethod from_api_repr(resource)[source]#

Factory: construct an ExternalConfig instance given its API representation.

Parameters

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

Returns

Configuration parsed from resource.

Return type

ExternalConfig

property ignore_unknown_values#

If True, extra values that are not represented in the table schema are ignored. Defaults to False.

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

Type

bool

property max_bad_records#

The maximum number of bad records that BigQuery can ignore when reading data.

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

Type

int

property options#

Source-specific options.

Type

Dict[str, Any]

property schema#

The schema for the data.

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

Type

List[SchemaField]

property source_format#

ExternalSourceFormat: Format of external source.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.sourceFormat

property source_uris#

URIs that point to your data in Google Cloud.

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

Type

List[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]