Class QueryJobConfiguration (2.40.1)

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.

Inheritance

Object > JobConfiguration > QueryJobConfiguration

Static Methods

newBuilder(String query)

public static QueryJobConfiguration.Builder newBuilder(String query)

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

Parameter
Name Description
query String
Returns
Type Description
QueryJobConfiguration.Builder

of(String query)

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.

Parameter
Name Description
query String
Returns
Type Description
QueryJobConfiguration

Methods

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

Returns
Type Description
Boolean

createSession()

public Boolean createSession()

Returns whether to create a new session. See Also: Create Sessions

Returns
Type Description
Boolean

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.

Returns
Type Description
Boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

flattenResults()

public Boolean flattenResults()

Returns whether nested and repeated fields should be flattened. If set to false Builder#setAllowLargeResults(Boolean) must be true. See Also: Flatten

Returns
Type Description
Boolean

getClustering()

public Clustering getClustering()

Returns the clustering specification for the destination table.

Returns
Type Description
Clustering

getConnectionProperties()

public List<ConnectionProperty> getConnectionProperties()

Returns the connection properties for connection string with this job

Returns
Type Description
List<ConnectionProperty>

getCreateDisposition()

public JobInfo.CreateDisposition getCreateDisposition()

Returns whether the job is allowed to create new tables. See Also: Create Disposition

Returns
Type Description
JobInfo.CreateDisposition

getDefaultDataset()

public DatasetId getDefaultDataset()

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

Returns
Type Description
DatasetId

getDestinationEncryptionConfiguration()

public EncryptionConfiguration getDestinationEncryptionConfiguration()
Returns
Type Description
EncryptionConfiguration

getDestinationTable()

public TableId getDestinationTable()

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

Returns
Type Description
TableId

getJobTimeoutMs()

public Long getJobTimeoutMs()

Returns the timeout associated with this job

Returns
Type Description
Long

getLabels()

public Map<String,String> getLabels()

Returns the labels associated with this job

Returns
Type Description
Map<String,String>

getMaxResults()

public Long getMaxResults()

This is only supported in the fast query path [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.

Returns
Type Description
Long

value or null for none

getMaximumBillingTier()

public Integer getMaximumBillingTier()

Returns the optional billing tier limit for this job.

Returns
Type Description
Integer

getMaximumBytesBilled()

public Long getMaximumBytesBilled()

Returns the optional bytes billed limit for this job.

Returns
Type Description
Long

getNamedParameters()

public Map<String,QueryParameterValue> getNamedParameters()

Returns the named query parameters to use for the query.

Returns
Type Description
Map<String,QueryParameterValue>

getPositionalParameters()

public List<QueryParameterValue> getPositionalParameters()

Returns the positional query parameters to use for the query.

Returns
Type Description
List<QueryParameterValue>

getPriority()

public QueryJobConfiguration.Priority getPriority()

Returns the query priority.

Returns
Type Description
QueryJobConfiguration.Priority

getQuery()

public String getQuery()

Returns the Google BigQuery SQL query.

Returns
Type Description
String

getRangePartitioning()

public RangePartitioning getRangePartitioning()

Returns the range partitioning specification for the table

Returns
Type Description
RangePartitioning

getSchemaUpdateOptions()

public List<JobInfo.SchemaUpdateOption> getSchemaUpdateOptions()

[Experimental] Returns options allowing the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema.

Returns
Type Description
List<SchemaUpdateOption>

getTableDefinitions()

public Map<String,ExternalTableDefinition> getTableDefinitions()

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.

Returns
Type Description
Map<String,ExternalTableDefinition>

getTimePartitioning()

public TimePartitioning getTimePartitioning()

Returns the time partitioning specification for the destination table.

Returns
Type Description
TimePartitioning

getUserDefinedFunctions()

public List<UserDefinedFunction> getUserDefinedFunctions()

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.

Returns
Type Description
List<UserDefinedFunction>

getWriteDisposition()

public JobInfo.WriteDisposition getWriteDisposition()

Returns the action that should occur if the destination table already exists. See Also: Write Disposition

Returns
Type Description
JobInfo.WriteDisposition

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

toBuilder()

public QueryJobConfiguration.Builder toBuilder()

Returns a builder for the object.

Returns
Type Description
QueryJobConfiguration.Builder
Overrides

useLegacySql()

public Boolean useLegacySql()

Returns whether to use BigQuery's legacy SQL dialect for this query. By default this property is set to false. 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 set to null or true, legacy SQL dialect is used. This property is experimental and might be subject to change.

Returns
Type Description
Boolean

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 Builder#setDestinationTable(TableId) is not set. See Also: Query Caching

Returns
Type Description
Boolean