com.google.cloud.bigquery

Class QueryJobConfiguration.Builder

java.lang.Object

com.google.cloud.bigquery.JobConfiguration.Builder<QueryJobConfiguration,QueryJobConfiguration.Builder>

com.google.cloud.bigquery.QueryJobConfiguration.Builder

Enclosing class:

QueryJobConfiguration

public static final class QueryJobConfiguration.Builder
extends JobConfiguration.Builder<QueryJobConfiguration,QueryJobConfiguration.Builder>

Method Summary

Methods

Modifier and Type	Method and Description
QueryJobConfiguration.Builder	addTableDefinition(String tableName, ExternalTableDefinition tableDefinition) Adds a new external table definition.
QueryJobConfiguration.Builder	allowLargeResults(Boolean allowLargeResults) Sets whether the job is enabled to create arbitrarily large results.
QueryJobConfiguration	build() Creates an object.
QueryJobConfiguration.Builder	createDisposition(JobInfo.CreateDisposition createDisposition) Sets whether the job is allowed to create tables.
QueryJobConfiguration.Builder	defaultDataset(DatasetId defaultDataset) Sets the default dataset.
QueryJobConfiguration.Builder	defaultDataset(String defaultDataset) Sets the default dataset.
QueryJobConfiguration.Builder	destinationTable(TableId destinationTable) Sets the table where to put query results.
QueryJobConfiguration.Builder	dryRun(Boolean dryRun) Sets whether the job has to be dry run or not.
QueryJobConfiguration.Builder	flattenResults(Boolean flattenResults) Sets whether nested and repeated fields should be flattened.
QueryJobConfiguration.Builder	priority(QueryJobConfiguration.Priority priority) Sets a priority for the query.
QueryJobConfiguration.Builder	query(String query) Sets the BigQuery SQL query to execute.
QueryJobConfiguration.Builder	tableDefinitions(Map<String,ExternalTableDefinition> tableDefinitions) Sets the external tables definitions.
QueryJobConfiguration.Builder	useQueryCache(Boolean useQueryCache) Sets whether to look for the result in the query cache.
QueryJobConfiguration.Builder	userDefinedFunctions(List<UserDefinedFunction> userDefinedFunctions) Sets user defined function resources that can be used by this query.
QueryJobConfiguration.Builder	writeDisposition(JobInfo.WriteDisposition writeDisposition) Sets the action that should occur if the destination table already exists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

query

public QueryJobConfiguration.Builder query(String query)

Sets the BigQuery SQL query to execute.

destinationTable

public QueryJobConfiguration.Builder destinationTable(TableId destinationTable)

Sets the table where to put query results. If not provided a new table is created. This value is required if allowLargeResults(Boolean) is set to true.

tableDefinitions

public QueryJobConfiguration.Builder tableDefinitions(Map<String,ExternalTableDefinition> tableDefinitions)

Sets the external tables definitions. If querying external data sources outside of BigQuery, this value describes the data format, location and other properties of the data sources. By defining these properties, the data sources can be queried as if they were standard BigQuery tables.

addTableDefinition

public QueryJobConfiguration.Builder addTableDefinition(String tableName,
                                               ExternalTableDefinition tableDefinition)

Adds a new external table definition. If a definition already exists for tableName it is updated.

Parameters:

tableName - name of the table

tableDefinition - external data configuration for the table used by this query

userDefinedFunctions

public QueryJobConfiguration.Builder userDefinedFunctions(List<UserDefinedFunction> userDefinedFunctions)

Sets user defined function resources that can be used by this query. Function resources can either be defined inline (UserDefinedFunction.inline(String)) or loaded from a Google Cloud Storage URI (UserDefinedFunction.fromUri(String).

createDisposition

public QueryJobConfiguration.Builder createDisposition(JobInfo.CreateDisposition createDisposition)

Sets whether the job is allowed to create tables.

See Also:

Create Disposition

writeDisposition

public QueryJobConfiguration.Builder writeDisposition(JobInfo.WriteDisposition writeDisposition)

Sets the action that should occur if the destination table already exists.

See Also:

Write Disposition

defaultDataset

public QueryJobConfiguration.Builder defaultDataset(DatasetId defaultDataset)

Sets the default dataset. This dataset is used for all unqualified table names used in the query.

defaultDataset

public QueryJobConfiguration.Builder defaultDataset(String defaultDataset)

Sets the default dataset. This dataset is used for all unqualified table names used in the query.

priority

public QueryJobConfiguration.Builder priority(QueryJobConfiguration.Priority priority)

Sets a priority for the query. If not specified the priority is assumed to be QueryJobConfiguration.Priority.INTERACTIVE.

allowLargeResults

public QueryJobConfiguration.Builder allowLargeResults(Boolean allowLargeResults)

Sets whether the job is enabled to create arbitrarily large results. If true the query is allowed to create large results at a slight cost in performance. If true destinationTable(TableId) must be provided.

See Also:

Returning Large Query Results

useQueryCache

public QueryJobConfiguration.Builder useQueryCache(Boolean useQueryCache)

Sets whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when destinationTable(TableId) is not set.

See Also:

Query Caching

flattenResults

public QueryJobConfiguration.Builder flattenResults(Boolean flattenResults)

Sets whether nested and repeated fields should be flattened. If set to false allowLargeResults(Boolean) must be true. By default results are flattened.

See Also:

Flatten

dryRun

public QueryJobConfiguration.Builder dryRun(Boolean dryRun)

Sets whether the job has to be dry run or not. If set, the job is not executed. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run.

build

public QueryJobConfiguration build()

Description copied from class: JobConfiguration.Builder

Creates an object.

Specified by:

build in class JobConfiguration.Builder<QueryJobConfiguration,QueryJobConfiguration.Builder>