ExternalDataConfiguration class

external_data_configuration block (max=1). Configures a federated external table — BigQuery reads data in-place from the source store (GCS / Bigtable / Drive / S3 via connection) at query time rather than ingesting it.

autodetect and sourceUris are required by the schema. The format-specific sub-blocks (csvOptions / googleSheetsOptions / hivePartitioningOptions / parquetOptions / avroOptions / jsonOptions) are mutually exclusive with respect to sourceFormat; the wrapper does not enforce that — pass at most one sub-block matching the chosen format.

bigtableOptions is exposed as a Map<String, Object?>? placeholder because the underlying schema (nested column_families with nested column lists) is heavy enough to warrant its own pass; callers using Bigtable today can pass the snake-case map directly.

Annotations
  • @immutable

Constructors

ExternalDataConfiguration({required bool autodetect, required List<String> sourceUris, ExternalDataSourceFormat? sourceFormat, ExternalDataCompression? compression, FileSetSpecType? fileSetSpecType, bool? ignoreUnknownValues, int? maxBadRecords, String? referenceFileSchemaUri, String? schema, String? connectionId, MetadataCacheMode? metadataCacheMode, ObjectMetadata? objectMetadata, String? jsonExtension, List<String>? decimalTargetTypes, CsvOptions? csvOptions, GoogleSheetsOptions? googleSheetsOptions, HivePartitioningOptions? hivePartitioningOptions, ParquetOptions? parquetOptions, AvroOptions? avroOptions, JsonOptions? jsonOptions, Map<String, Object?>? bigtableOptions})
const

Properties

autodetect bool
final
avroOptions AvroOptions?
final
bigtableOptions Map<String, Object?>?
final
compression ExternalDataCompression?
final
connectionId String?
final
csvOptions CsvOptions?
final
decimalTargetTypes List<String>?
final
fileSetSpecType FileSetSpecType?
final
googleSheetsOptions GoogleSheetsOptions?
final
hashCode int
The hash code for this object.
no setterinherited
hivePartitioningOptions HivePartitioningOptions?
final
ignoreUnknownValues bool?
final
jsonExtension String?
final
jsonOptions JsonOptions?
final
maxBadRecords int?
final
metadataCacheMode MetadataCacheMode?
final
objectMetadata ObjectMetadata?
final
parquetOptions ParquetOptions?
final
referenceFileSchemaUri String?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
schema String?
final
sourceFormat ExternalDataSourceFormat?
final
sourceUris List<String>
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toArgMap() Map<String, Object?>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited