Package com.google.cloud.bigquery
Class QueryJobConfiguration
java.lang.Object
com.google.cloud.bigquery.JobConfiguration
com.google.cloud.bigquery.QueryJobConfiguration
- All Implemented Interfaces:
Serializable
Google BigQuery Query Job configuration. A Query Job runs a query against BigQuery data. Query
job configurations have
JobConfiguration.Type.QUERY
type.- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
static enum
Priority levels for a query.Nested classes/interfaces inherited from class com.google.cloud.bigquery.JobConfiguration
JobConfiguration.Type
-
Method Summary
Modifier and TypeMethodDescriptionReturns whether the job is enabled to create arbitrarily large results.Returns whether to create a new session.dryRun()
Returns whether the job has to be dry run or not.boolean
Returns whether nested and repeated fields should be flattened.Returns the clustering specification for the destination table.Returns the connection properties for connection string with this jobReturns whether the job is allowed to create new tables.Returns the default dataset.Returns the table where to put query results.Returns the timeout associated with this jobReturns the labels associated with this jobReturns the optional billing tier limit for this job.Returns the optional bytes billed limit for this job.This is only supported in the fast query path [Optional] The maximum number of rows of data to return per page of results.Returns the named query parameters to use for the query.Returns the positional query parameters to use for the query.Returns the query priority.getQuery()
Returns the Google BigQuery SQL query.Returns the range partitioning specification for the table[Experimental] Returns options allowing the schema of the destination table to be updated as a side effect of the query job.Returns the external tables definitions.Returns the time partitioning specification for the destination table.Returns user defined function resources that can be used by this query.Returns the action that should occur if the destination table already exists.int
hashCode()
newBuilder
(String query) Creates a builder for a BigQuery Query Job given the query to be run.static QueryJobConfiguration
Returns a BigQuery Copy Job for the given the query to be run.Returns a builder for the object.Returns whether to use BigQuery's legacy SQL dialect for this query.Returns whether to look for the result in the query cache.Methods inherited from class com.google.cloud.bigquery.JobConfiguration
getType, toString
-
Method Details
-
allowLargeResults
Returns whether the job is enabled to create arbitrarily large results. Iftrue
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:
-
createSession
Returns whether to create a new session.- See Also:
-
getCreateDisposition
Returns whether the job is allowed to create new tables.- See Also:
-
getDefaultDataset
Returns the default dataset. This dataset is used for all unqualified table names used in the query. -
getDestinationTable
Returns the table where to put query results. If not provided a new table is created. This value is required ifallowLargeResults()
istrue
. -
getDestinationEncryptionConfiguration
-
flattenResults
Returns whether nested and repeated fields should be flattened. If set tofalse
QueryJobConfiguration.Builder.setAllowLargeResults(Boolean)
must betrue
.- See Also:
-
getPriority
Returns the query priority. -
getQuery
Returns the Google BigQuery SQL query. -
getPositionalParameters
Returns the positional query parameters to use for the query. -
getNamedParameters
Returns the named query parameters to use for the query. -
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. -
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 whenQueryJobConfiguration.Builder.setDestinationTable(TableId)
is not set.- See Also:
-
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
. -
getWriteDisposition
Returns the action that should occur if the destination table already exists.- See Also:
-
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
Returns whether to use BigQuery's legacy SQL dialect for this query. By default this property is set tofalse
. If set tofalse
, the query will use BigQuery's Standard SQL. When set tofalse
, the values ofallowLargeResults()
andflattenResults()
are ignored; query will be run as ifallowLargeResults()
istrue
andflattenResults()
isfalse
. If set tonull
ortrue
, legacy SQL dialect is used. This property is experimental and might be subject to change. -
getMaximumBillingTier
Returns the optional billing tier limit for this job. -
getMaximumBytesBilled
Returns the optional bytes billed limit for this job. -
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. -
getTimePartitioning
Returns the time partitioning specification for the destination table. -
getClustering
Returns the clustering specification for the destination table. -
getJobTimeoutMs
Returns the timeout associated with this job -
getLabels
Returns the labels associated with this job -
getRangePartitioning
Returns the range partitioning specification for the table -
getConnectionProperties
Returns the connection properties for connection string with this job -
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:
- value or
null
for none
-
toBuilder
Description copied from class:JobConfiguration
Returns a builder for the object.- Specified by:
toBuilder
in classJobConfiguration
-
equals
-
hashCode
public int hashCode() -
newBuilder
Creates a builder for a BigQuery Query Job given the query to be run. -
of
Returns a BigQuery Copy Job for the given the query to be run. Job's id is chosen by the service.
-