Class ExternalConfig (1.21.0)

Version 1.21.0

• 3.27.0 (latest)
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.1
• 3.22.0
• 3.21.0
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0

ExternalConfig(source_format)

Description of an external data source.

Parameter

Name	Description
source_format	ExternalSourceFormat See source_format.

Inheritance

builtins.object > ExternalConfig

Properties

autodetect

bool: If :data: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

compression

str: 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

ignore_unknown_values

bool: If :data:True, extra values that are not represented in the table schema are ignored. Defaults to :data: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

max_bad_records

int: 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

options

Dict[str, Any]: Source-specific options.

schema

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

source_format

.external_config.ExternalSourceFormat: Format of external source.

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

source_uris

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

Methods

__init__

__init__(source_format)

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

from_api_repr

from_api_repr(resource)

Factory: construct an .external_config.ExternalConfig instance given its API representation.

Parameter

Name	Description
resource	Dict[str, Any] Definition of an .external_config.ExternalConfig instance in the same representation as is returned from the API.

Returns

Type	Description
ExternalConfig	Configuration parsed from ``resource``.

to_api_repr

to_api_repr()

Build an API representation of this object.

Returns

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