Class ExternalDataConfiguration

Inheritance
object
ExternalDataConfiguration
Implements
Inherited Members
Namespace: Google.Apis.Bigquery.v2.Data
Assembly: Google.Apis.Bigquery.v2.dll
Syntax
public class ExternalDataConfiguration : IDirectResponseSchema

Properties

Autodetect

Try to detect schema and format options automatically. Any option specified explicitly will be honored.

Declaration
[JsonProperty("autodetect")]
public virtual bool? Autodetect { get; set; }
Property Value
Type Description
bool?

AvroOptions

Optional. Additional properties to set if sourceFormat is set to AVRO.

Declaration
[JsonProperty("avroOptions")]
public virtual AvroOptions AvroOptions { get; set; }
Property Value
Type Description
AvroOptions

BigtableOptions

Optional. Additional options if sourceFormat is set to BIGTABLE.

Declaration
[JsonProperty("bigtableOptions")]
public virtual BigtableOptions BigtableOptions { get; set; }
Property Value
Type Description
BigtableOptions

Compression

Optional. The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats. An empty string is an invalid value.

Declaration
[JsonProperty("compression")]
public virtual string Compression { get; set; }
Property Value
Type Description
string

ConnectionId

Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form {project_id}.{location_id};{connection_id} or projects/{project_id}/locations/{location_id}/connections/{connection_id}.

Declaration
[JsonProperty("connectionId")]
public virtual string ConnectionId { get; set; }
Property Value
Type Description
string

CsvOptions

Optional. Additional properties to set if sourceFormat is set to CSV.

Declaration
[JsonProperty("csvOptions")]
public virtual CsvOptions CsvOptions { get; set; }
Property Value
Type Description
CsvOptions

DateFormat

Optional. Format used to parse DATE values. Supports C-style and SQL-style values.

Declaration
[JsonProperty("dateFormat")]
public virtual string DateFormat { get; set; }
Property Value
Type Description
string

DatetimeFormat

Optional. Format used to parse DATETIME values. Supports C-style and SQL-style values.

Declaration
[JsonProperty("datetimeFormat")]
public virtual string DatetimeFormat { get; set; }
Property Value
Type Description
string

DecimalTargetTypes

Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: * (38,9) -> NUMERIC; * (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -> BIGNUMERIC; * (77,38) -> BIGNUMERIC (error if value exceeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

Declaration
[JsonProperty("decimalTargetTypes")]
public virtual IList<string> DecimalTargetTypes { get; set; }
Property Value
Type Description
IList<string>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FileSetSpecType

Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.

Declaration
[JsonProperty("fileSetSpecType")]
public virtual string FileSetSpecType { get; set; }
Property Value
Type Description
string

GoogleSheetsOptions

Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.

Declaration
[JsonProperty("googleSheetsOptions")]
public virtual GoogleSheetsOptions GoogleSheetsOptions { get; set; }
Property Value
Type Description
GoogleSheetsOptions

HivePartitioningOptions

Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.

Declaration
[JsonProperty("hivePartitioningOptions")]
public virtual HivePartitioningOptions HivePartitioningOptions { get; set; }
Property Value
Type Description
HivePartitioningOptions

IgnoreUnknownValues

Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored. ORC: This setting is ignored. Parquet: This setting is ignored.

Declaration
[JsonProperty("ignoreUnknownValues")]
public virtual bool? IgnoreUnknownValues { get; set; }
Property Value
Type Description
bool?

JsonExtension

Optional. Load option to be used together with source_format newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and source_format must be set to NEWLINE_DELIMITED_JSON).

Declaration
[JsonProperty("jsonExtension")]
public virtual string JsonExtension { get; set; }
Property Value
Type Description
string

JsonOptions

Optional. Additional properties to set if sourceFormat is set to JSON.

Declaration
[JsonProperty("jsonOptions")]
public virtual JsonOptions JsonOptions { get; set; }
Property Value
Type Description
JsonOptions

MaxBadRecords

Optional. The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.

Declaration
[JsonProperty("maxBadRecords")]
public virtual int? MaxBadRecords { get; set; }
Property Value
Type Description
int?

MetadataCacheMode

Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

Declaration
[JsonProperty("metadataCacheMode")]
public virtual string MetadataCacheMode { get; set; }
Property Value
Type Description
string

ObjectMetadata

Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.

Declaration
[JsonProperty("objectMetadata")]
public virtual string ObjectMetadata { get; set; }
Property Value
Type Description
string

ParquetOptions

Optional. Additional properties to set if sourceFormat is set to PARQUET.

Declaration
[JsonProperty("parquetOptions")]
public virtual ParquetOptions ParquetOptions { get; set; }
Property Value
Type Description
ParquetOptions

ReferenceFileSchemaUri

Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.

Declaration
[JsonProperty("referenceFileSchemaUri")]
public virtual string ReferenceFileSchemaUri { get; set; }
Property Value
Type Description
string

Schema

Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats.

Declaration
[JsonProperty("schema")]
public virtual TableSchema Schema { get; set; }
Property Value
Type Description
TableSchema

SourceFormat

[Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Declaration
[JsonProperty("sourceFormat")]
public virtual string SourceFormat { get; set; }
Property Value
Type Description
string

SourceUris

[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

Declaration
[JsonProperty("sourceUris")]
public virtual IList<string> SourceUris { get; set; }
Property Value
Type Description
IList<string>

TimeFormat

Optional. Format used to parse TIME values. Supports C-style and SQL-style values.

Declaration
[JsonProperty("timeFormat")]
public virtual string TimeFormat { get; set; }
Property Value
Type Description
string

TimeZone

Optional. Time zone used when parsing timestamp values that do not have specific time zone information (e.g. 2024-04-20 12:34:56). The expected format is a IANA timezone string (e.g. America/Los_Angeles).

Declaration
[JsonProperty("timeZone")]
public virtual string TimeZone { get; set; }
Property Value
Type Description
string

TimestampFormat

Optional. Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.

Declaration
[JsonProperty("timestampFormat")]
public virtual string TimestampFormat { get; set; }
Property Value
Type Description
string

Implements