Package com.google.cloud.bigquery
Class ExternalTableDefinition.Builder
- java.lang.Object
-
- com.google.cloud.bigquery.TableDefinition.Builder<ExternalTableDefinition,ExternalTableDefinition.Builder>
-
- com.google.cloud.bigquery.ExternalTableDefinition.Builder
-
- Enclosing class:
- ExternalTableDefinition
public abstract static class ExternalTableDefinition.Builder extends TableDefinition.Builder<ExternalTableDefinition,ExternalTableDefinition.Builder>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract ExternalTableDefinition
build()
Creates anExternalTableDefinition
object.abstract ExternalTableDefinition.Builder
setAutodetect(Boolean autodetect)
[Experimental] Sets detection of schema and format options automatically.abstract ExternalTableDefinition.Builder
setCompression(String compression)
Sets compression type of the data source.abstract ExternalTableDefinition.Builder
setConnectionId(String connectionId)
[Optional, Trusted Tester] connectionId for external data source.abstract ExternalTableDefinition.Builder
setDecimalTargetTypes(List<String> decimalTargetTypes)
Defines the list of possible SQL data types to which the source decimal values are converted.ExternalTableDefinition.Builder
setFormatOptions(FormatOptions formatOptions)
Sets the source format, and possibly some parsing options, of the external data.ExternalTableDefinition.Builder
setHivePartitioningOptions(HivePartitioningOptions hivePartitioningOptions)
Sets the table Hive partitioning options.abstract ExternalTableDefinition.Builder
setIgnoreUnknownValues(Boolean ignoreUnknownValues)
Sets whether BigQuery should allow extra values that are not represented in the table schema.abstract ExternalTableDefinition.Builder
setMaxBadRecords(Integer maxBadRecords)
Sets the maximum number of bad records that BigQuery can ignore when reading data.abstract ExternalTableDefinition.Builder
setReferenceFileSchemaUri(String referenceFileSchemaUri)
When creating an external table, the user can provide a reference file with the table schema.abstract ExternalTableDefinition.Builder
setSchema(Schema schema)
Sets the table schema.ExternalTableDefinition.Builder
setSourceUris(List<String> sourceUris)
Sets the fully-qualified URIs that point to your data in Google Cloud Storage (e.g.abstract ExternalTableDefinition.Builder
setType(TableDefinition.Type type)
-
-
-
Method Detail
-
setSourceUris
public ExternalTableDefinition.Builder setSourceUris(List<String> sourceUris)
Sets the fully-qualified URIs that point to your data in Google Cloud Storage (e.g. gs://bucket/path). 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.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 backup URIs: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
- See Also:
- Quota
-
setFormatOptions
public ExternalTableDefinition.Builder setFormatOptions(FormatOptions formatOptions)
Sets the source format, and possibly some parsing options, of the external data. Supported formats areCSV
andNEWLINE_DELIMITED_JSON
.
-
setDecimalTargetTypes
public abstract ExternalTableDefinition.Builder setDecimalTargetTypes(List<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.- Parameters:
decimalTargetTypes
- decimalTargetType ornull
for none
-
setMaxBadRecords
public abstract ExternalTableDefinition.Builder setMaxBadRecords(Integer maxBadRecords)
Sets 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.
-
setIgnoreUnknownValues
public abstract ExternalTableDefinition.Builder setIgnoreUnknownValues(Boolean ignoreUnknownValues)
Sets 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 set withsetFormatOptions(FormatOptions)
property determines what BigQuery treats as an extra value.- See Also:
- Ignore Unknown Values
-
setCompression
public abstract ExternalTableDefinition.Builder setCompression(String compression)
Sets compression type of the data source. By default no compression is assumed.- See Also:
- Compression
-
setConnectionId
public abstract ExternalTableDefinition.Builder setConnectionId(String connectionId)
[Optional, Trusted Tester] connectionId for external data source. The value may benull
.
-
setAutodetect
public abstract ExternalTableDefinition.Builder setAutodetect(Boolean autodetect)
[Experimental] Sets detection of schema and format options automatically. Any option specified explicitly will be honored.
-
setType
public abstract ExternalTableDefinition.Builder setType(TableDefinition.Type type)
- Specified by:
setType
in classTableDefinition.Builder<ExternalTableDefinition,ExternalTableDefinition.Builder>
-
setSchema
public abstract ExternalTableDefinition.Builder setSchema(Schema schema)
Sets the table schema.- Specified by:
setSchema
in classTableDefinition.Builder<ExternalTableDefinition,ExternalTableDefinition.Builder>
-
setHivePartitioningOptions
public ExternalTableDefinition.Builder setHivePartitioningOptions(HivePartitioningOptions hivePartitioningOptions)
Sets the table Hive partitioning options.
-
setReferenceFileSchemaUri
public abstract ExternalTableDefinition.Builder setReferenceFileSchemaUri(String referenceFileSchemaUri)
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.- Parameters:
referenceFileSchemaUri
- ornull
for none
-
build
public abstract ExternalTableDefinition build()
Creates anExternalTableDefinition
object.- Specified by:
build
in classTableDefinition.Builder<ExternalTableDefinition,ExternalTableDefinition.Builder>
-
-