As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

google.cloud.bigquery.external_config.ExternalConfig

class google.cloud.bigquery.external_config.ExternalConfig(source_format)

Description of an external data source.

Parameters

source_format (ExternalSourceFormat) – See source_format.

__init__(source_format)

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

Methods

__init__(source_format)	Initialize self.
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.
hive_partitioning	[Beta] When set, it configures hive partitioning support.
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.

property autodetect

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

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.autodetect

Type

bool

property compression

The compression type of the data source.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.compression

Type

str

classmethod from_api_repr(resource)

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 hive_partitioning

[Beta] When set, it configures hive partitioning support.

Note

Experimental. This feature is experimental and might change or have limited support.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.hive_partitioning_options

Type

Optional[HivePartitioningOptions]

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/tables#ExternalDataConfiguration.FIELDS.ignore_unknown_values

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/tables#ExternalDataConfiguration.FIELDS.max_bad_records

Type

int

property options

Source-specific options.

Type

Optional[Dict[str, Any]]

property schema

The schema for the data.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.schema

Type

List[SchemaField]

property source_format

ExternalSourceFormat: Format of external source.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_format

property source_uris

URIs that point to your data in Google Cloud.

See https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_uris

Type

List[str]

to_api_repr()

Build an API representation of this object.

Returns

A dictionary in the format used by the BigQuery API.

Return type

Dict[str, Any]