com.google.cloud.bigquery

Class ExternalTableDefinition

java.lang.Object

com.google.cloud.bigquery.TableDefinition

com.google.cloud.bigquery.ExternalTableDefinition

All Implemented Interfaces:

Serializable

public 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 , Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalTableDefinition.Builder

Nested classes/interfaces inherited from class com.google.cloud.bigquery.TableDefinition

TableDefinition.Type

Method Summary

Methods

Modifier and Type	Method and Description
static ExternalTableDefinition.Builder	builder(List<String> sourceUris, Schema schema, FormatOptions format) Creates a builder for an ExternalTableDefinition object.
static ExternalTableDefinition.Builder	builder(String sourceUri, Schema schema, FormatOptions format) Creates a builder for an ExternalTableDefinition object.
String	compression() Returns the compression type of the data source.
boolean	equals(Object obj)
<F extends FormatOptions> F	formatOptions() Returns the source format, and possibly some parsing options, of the external data.
int	hashCode()
Boolean	ignoreUnknownValues() Returns whether BigQuery should allow extra values that are not represented in the table schema.
Integer	maxBadRecords() Returns the maximum number of bad records that BigQuery can ignore when reading data.
static ExternalTableDefinition	of(List<String> sourceUris, Schema schema, FormatOptions format) Creates an ExternalTableDefinition object.
static ExternalTableDefinition	of(String sourceUri, Schema schema, FormatOptions format) Creates an ExternalTableDefinition object.
List<String>	sourceUris() Returns the fully-qualified URIs that point to your data in Google Cloud Storage.
ExternalTableDefinition.Builder	toBuilder() Returns a builder for the ExternalTableDefinition object.

Methods inherited from class com.google.cloud.bigquery.TableDefinition

schema, toString, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

compression

public String compression()

Returns the compression type of the data source.

See Also:

Compression

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 formatOptions() determines what BigQuery treats as an extra value.

See Also:

Ignore Unknown Values

maxBadRecords

public Integer maxBadRecords()

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.

sourceUris

public List<String> sourceUris()

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

formatOptions

public <F extends FormatOptions> F formatOptions()

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

toBuilder

public ExternalTableDefinition.Builder toBuilder()

Returns a builder for the ExternalTableDefinition object.

Specified by:

toBuilder in class TableDefinition

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

builder

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

Creates a builder for an ExternalTableDefinition object.

Parameters:

sourceUris - 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 - the schema for the external data

format - the source format of the external data

Returns:

a builder for an ExternalTableDefinition object given source URIs, schema and format

See Also:

Quota, Source Format

builder

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

Creates a builder for an ExternalTableDefinition object.

Parameters:

sourceUri - 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 - the schema for the external data

format - the source format of the external data

Returns:

a builder for an ExternalTableDefinition object given source URI, schema and format

See Also:

Quota, Source Format

of

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

Creates an ExternalTableDefinition object.

Parameters:

sourceUris - 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 - the schema for the external data

format - the source format of the external data

Returns:

an ExternalTableDefinition object given source URIs, schema and format

See Also:

Quota, Source Format

of

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

Creates an ExternalTableDefinition object.

Parameters:

sourceUri - 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 - the schema for the external data

format - the source format of the external data

Returns:

an ExternalTableDefinition object given source URIs, schema and format

See Also:

Quota, Source Format