Class ExternalTableDefinition (2.36.0)

public abstract class ExternalTableDefinition extends TableDefinition

Google BigQuery external table definition. BigQuery's external tables are tables whose data reside outside of BigQuery but can be queried as normal BigQuery tables. External tables are experimental and might be subject to change or removed. See Also: Federated Data Sources

Inheritance

java.lang.Object > TableDefinition > ExternalTableDefinition

Inherited Members

TableDefinition.getSchema()

TableDefinition.getType()

TableDefinition.toBuilder()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder(String sourceUri, FormatOptions format)

public static ExternalTableDefinition.Builder newBuilder(String sourceUri, FormatOptions format)

Creates a builder for an ExternalTableDefinition object. See Also: Source Format, Quota

Parameters
Name	Description
`sourceUri`	`String` the fully-qualified URIs that point to your data in Google Cloud. 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. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
`format`	`FormatOptions` the source format of the external data

Returns
Type	Description
`ExternalTableDefinition.Builder`	a builder for an ExternalTableDefinition object given source URIs and format

newBuilder(String sourceUri, Schema schema, FormatOptions format)

public static ExternalTableDefinition.Builder newBuilder(String sourceUri, Schema schema, FormatOptions format)

Creates a builder for an ExternalTableDefinition object. See Also: Source Format, Quota

Parameters
Name	Description
`sourceUri`	`String` a fully-qualified URI that points to your data in Google Cloud Storage. The URI can contain one '*' wildcard character that must come after the bucket's name. Size limits related to load jobs apply to external data sources.
`schema`	`Schema` the schema for the external data
`format`	`FormatOptions` the source format of the external data

Returns
Type	Description
`ExternalTableDefinition.Builder`	a builder for an ExternalTableDefinition object given source URI, schema and format

newBuilder(List<String> sourceUris, Schema schema, FormatOptions format)

public static ExternalTableDefinition.Builder newBuilder(List<String> sourceUris, Schema schema, FormatOptions format)

Creates a builder for an ExternalTableDefinition object. See Also: Source Format, Quota

Parameters
Name	Description
`sourceUris`	`List<String>` the fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character that must come after the bucket's name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
`schema`	`Schema` the schema for the external data
`format`	`FormatOptions` the source format of the external data

Returns
Type	Description
`ExternalTableDefinition.Builder`	a builder for an ExternalTableDefinition object given source URIs, schema and format

of(String sourceUri, FormatOptions format)

public static ExternalTableDefinition of(String sourceUri, FormatOptions format)

Creates a builder for an ExternalTableDefinition object. See Also: Source Format, Quota

Parameters
Name	Description
`sourceUri`	`String` the fully-qualified URIs that point to your data in Google Cloud. 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. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
`format`	`FormatOptions` the source format of the external data

Returns
Type	Description
`ExternalTableDefinition`	a builder for an ExternalTableDefinition object given source URIs and format

of(String sourceUri, Schema schema, FormatOptions format)

public static ExternalTableDefinition of(String sourceUri, Schema schema, FormatOptions format)

Creates an ExternalTableDefinition object. See Also: Source Format, Quota

Parameters
Name	Description
`sourceUri`	`String` a fully-qualified URI that points to your data in Google Cloud Storage. The URI can contain one '*' wildcard character that must come after the bucket's name. Size limits related to load jobs apply to external data sources.
`schema`	`Schema` the schema for the external data
`format`	`FormatOptions` the source format of the external data

Returns
Type	Description
`ExternalTableDefinition`	an ExternalTableDefinition object given source URIs, schema and format

of(List<String> sourceUris, Schema schema, FormatOptions format)

public static ExternalTableDefinition of(List<String> sourceUris, Schema schema, FormatOptions format)

Creates an ExternalTableDefinition object. See Also: Source Format, Quota

Parameters
Name	Description
`sourceUris`	`List<String>` the fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character that must come after the bucket's name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs.
`schema`	`Schema` the schema for the external data
`format`	`FormatOptions` the source format of the external data

Returns
Type	Description
`ExternalTableDefinition`	an ExternalTableDefinition object given source URIs, schema and format

Constructors

ExternalTableDefinition()

public ExternalTableDefinition()

Methods

<F>getFormatOptions()

public F <F>getFormatOptions()

Returns the source format, and possibly some parsing options, of the external data. Supported formats are CSV and NEWLINE_DELIMITED_JSON.

Returns
Type	Description
`F`

getAutodetect()

public abstract Boolean getAutodetect()

[Experimental] Returns whether automatic detection of schema and format options should be performed.

Returns
Type	Description
`Boolean`

getCompression()

public abstract String getCompression()

Returns the compression type of the data source. See Also: Compression

Returns
Type	Description
`String`

getConnectionId()

public abstract String getConnectionId()

Returns the connection ID used to connect to external data source. See Also: ConnectionId

Returns
Type	Description
`String`

getDecimalTargetTypes()

public abstract ImmutableList<String> getDecimalTargetTypes()

Returns
Type	Description
`com.google.common.collect.ImmutableList<String>`

getFileSetSpecType()

public String getFileSetSpecType()

Returns
Type	Description
`String`

getHivePartitioningOptions()

public HivePartitioningOptions getHivePartitioningOptions()

[Experimental] Returns the HivePartitioningOptions when the data layout follows Hive partitioning convention

Returns
Type	Description
`HivePartitioningOptions`

getIgnoreUnknownValues()

public abstract Boolean getIgnoreUnknownValues()

Returns
Type	Description
`Boolean`

getMaxBadRecords()

public abstract Integer getMaxBadRecords()

Returns 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.

Returns
Type	Description
`Integer`

getReferenceFileSchemaUri()

public abstract String getReferenceFileSchemaUri()

Returns
Type	Description
`String`

getSourceUris()

public List<String> getSourceUris()

Returns the fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character that must come after the bucket's name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs. See Also: Quota

Returns
Type	Description
`List<String>`

getSourceUrisImmut()

public abstract ImmutableList<String> getSourceUrisImmut()

Returns
Type	Description
`com.google.common.collect.ImmutableList<String>`

ignoreUnknownValues()

public Boolean ignoreUnknownValues()

Returns whether 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 value of <xref uid="com.google.cloud.bigquery.ExternalTableDefinition.<F>getFormatOptions()" data-throw-if-not-resolved="false">#getFormatOptions() determines what BigQuery treats as an extra value. See Also: Ignore Unknown Values

Returns
Type	Description
`Boolean`

toBuilder()

public abstract ExternalTableDefinition.Builder toBuilder()

Returns a builder for the ExternalTableDefinition object.

Returns
Type	Description
`ExternalTableDefinition.Builder`

Overrides

TableDefinition.toBuilder()