com.google.cloud.bigquery

Class QueryJobConfiguration

java.lang.Object

com.google.cloud.bigquery.JobConfiguration

com.google.cloud.bigquery.QueryJobConfiguration

All Implemented Interfaces:

Serializable

public final class QueryJobConfiguration
extends JobConfiguration

Google BigQuery Query Job configuration. A Query Job runs a query against BigQuery data. Query job configurations have JobConfiguration.Type.QUERY type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryJobConfiguration.Builder
static class	QueryJobConfiguration.Priority Priority levels for a query.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	allowLargeResults() Returns whether the job is enabled to create arbitrarily large results.
static QueryJobConfiguration.Builder	builder(String query) Creates a builder for a BigQuery Query Job given the query to be run.
JobInfo.CreateDisposition	createDisposition() Returns whether the job is allowed to create new tables.
DatasetId	defaultDataset() Returns the default dataset.
TableId	destinationTable() Returns the table where to put query results.
Boolean	dryRun() Returns whether the job has to be dry run or not.
boolean	equals(Object obj)
Boolean	flattenResults() Returns whether nested and repeated fields should be flattened.
int	hashCode()
static QueryJobConfiguration	of(String query) Returns a BigQuery Copy Job for the given the query to be run.
QueryJobConfiguration.Priority	priority() Returns the query priority.
String	query() Returns the Google BigQuery SQL query.
Map<String,ExternalTableDefinition>	tableDefinitions() Returns the external tables definitions.
QueryJobConfiguration.Builder	toBuilder() Returns a builder for the object.
Boolean	useLegacySql() Returns whether to use BigQuery's legacy SQL dialect for this query.
Boolean	useQueryCache() Returns whether to look for the result in the query cache.
List<UserDefinedFunction>	userDefinedFunctions() Returns user defined function resources that can be used by this query.
JobInfo.WriteDisposition	writeDisposition() Returns the action that should occur if the destination table already exists.

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

toString, type

Methods inherited from class java.lang.Object

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

Method Detail

allowLargeResults

public Boolean allowLargeResults()

Returns 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. the query is allowed to create large results at a slight cost in performance.

See Also:

Returning Large Query Results

createDisposition

public JobInfo.CreateDisposition createDisposition()

Returns whether the job is allowed to create new tables.

See Also:

Create Disposition

defaultDataset

public DatasetId defaultDataset()

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

destinationTable

public TableId destinationTable()

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

flattenResults

public Boolean flattenResults()

Returns whether nested and repeated fields should be flattened. If set to false QueryJobConfiguration.Builder.allowLargeResults(Boolean) must be true.

See Also:

Flatten

priority

public QueryJobConfiguration.Priority priority()

Returns the query priority.

query

public String query()

Returns the Google BigQuery SQL query.

tableDefinitions

public Map<String,ExternalTableDefinition> tableDefinitions()

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

useQueryCache

public Boolean useQueryCache()

Returns 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 QueryJobConfiguration.Builder.destinationTable(TableId) is not set.

See Also:

Query Caching

userDefinedFunctions

public List<UserDefinedFunction> userDefinedFunctions()

Returns user defined function resources that can be used by this query. Function resources can either be defined inline (UserDefinedFunction.Type.INLINE) or loaded from a Google Cloud Storage URI (UserDefinedFunction.Type.FROM_URI.

writeDisposition

public JobInfo.WriteDisposition writeDisposition()

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

See Also:

Write Disposition

dryRun

public Boolean dryRun()

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

useLegacySql

public Boolean useLegacySql()

Returns whether to use BigQuery's legacy SQL dialect for this query. If set to false, the query will use BigQuery's Standard SQL. When set to false, the values of allowLargeResults() and flattenResults() are ignored; query will be run as if allowLargeResults() is true and flattenResults() is false. If not set, legacy SQL dialect is used. This property is experimental and might be subject to change.

toBuilder

public QueryJobConfiguration.Builder toBuilder()

Description copied from class: JobConfiguration

Returns a builder for the object.

Specified by:

toBuilder in class JobConfiguration

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static QueryJobConfiguration.Builder builder(String query)

Creates a builder for a BigQuery Query Job given the query to be run.

of

public static QueryJobConfiguration of(String query)

Returns a BigQuery Copy Job for the given the query to be run. Job's id is chosen by the service.