Class QueryJobConfiguration.Builder
- Enclosing class:
- QueryJobConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionaddNamedParameter
(String name, QueryParameterValue value) Adds a named query parameter to the set of query parameters.Adds a positional query parameter to the list of query parameters.addTableDefinition
(String tableName, ExternalTableDefinition tableDefinition) Adds a new external table definition.build()
Creates an object.setAllowLargeResults
(Boolean allowLargeResults) Sets whether the job is enabled to create arbitrarily large results.setClustering
(Clustering clustering) Sets the clustering specification for the destination table.setConnectionProperties
(List<ConnectionProperty> connectionProperties) A connection-level property to customize query behavior.setCreateDisposition
(JobInfo.CreateDisposition createDisposition) Sets whether the job is allowed to create tables.setCreateSession
(Boolean createSession) Sets whether to create a new session.setDefaultDataset
(DatasetId defaultDataset) Sets the default dataset.setDefaultDataset
(String defaultDataset) Sets the default dataset.setDestinationEncryptionConfiguration
(EncryptionConfiguration encryptionConfiguration) setDestinationTable
(TableId destinationTable) Sets the table where to put query results.Sets whether the job has to be dry run or not.setFlattenResults
(Boolean flattenResults) Sets whether nested and repeated fields should be flattened.setJobTimeoutMs
(Long jobTimeoutMs) [Optional] Job timeout in milliseconds.The labels associated with this job.setMaximumBillingTier
(Integer maximumBillingTier) Limits the billing tier for this job.setMaximumBytesBilled
(Long maximumBytesBilled) Limits the bytes billed for this job.setMaxResults
(Long maxResults) This is only supported in the fast query path [Optional] The maximum number of rows of data to return per page of results.setNamedParameters
(Map<String, QueryParameterValue> values) Sets the query parameters to a set of named query parameters to use in the query.setParameterMode
(String parameterMode) Standard SQL only.Sets the query parameters to a list of positional query parameters to use in the query.setPriority
(QueryJobConfiguration.Priority priority) Sets a priority for the query.Sets the BigQuery SQL query to execute.setRangePartitioning
(RangePartitioning rangePartitioning) Range partitioning specification for this table.setSchemaUpdateOptions
(List<JobInfo.SchemaUpdateOption> schemaUpdateOptions) [Experimental] Sets options allowing the schema of the destination table to be updated as a side effect of the query job.setTableDefinitions
(Map<String, ExternalTableDefinition> tableDefinitions) Sets the external tables definitions.setTimePartitioning
(TimePartitioning timePartitioning) Sets the time partitioning specification for the destination table.setUseLegacySql
(Boolean useLegacySql) Sets whether to use BigQuery's legacy SQL dialect for this query.setUseQueryCache
(Boolean useQueryCache) Sets whether to look for the result in the query cache.setUserDefinedFunctions
(List<UserDefinedFunction> userDefinedFunctions) Sets user defined function resources that can be used by this query.setWriteDisposition
(JobInfo.WriteDisposition writeDisposition) Sets the action that should occur if the destination table already exists.
-
Method Details
-
setQuery
Sets the BigQuery SQL query to execute. -
addPositionalParameter
Adds a positional query parameter to the list of query parameters. SeesetPositionalParameters(Iterable)
for more details on the input requirements.A positional parameter cannot be added after named parameters have been added.
-
setParameterMode
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. -
setPositionalParameters
Sets the query parameters to a list of positional query parameters to use in the query.The set of query parameters must either be all positional or all named parameters. Positional parameters are denoted in the query with a question mark (?).
Additionally, useLegacySql must be set to false; query parameters cannot be used with legacy SQL.
The values parameter can be set to null to clear out the positional parameters so that named parameters can be used instead.
-
addNamedParameter
Adds a named query parameter to the set of query parameters. SeesetNamedParameters(Map)
for more details on the input requirements.A named parameter cannot be added after positional parameters have been added.
-
setNamedParameters
Sets the query parameters to a set of named query parameters to use in the query.The set of query parameters must either be all positional or all named parameters. Named parameters are denoted using an @ prefix, e.g. @myParam for a parameter named "myParam".
Additionally, useLegacySql must be set to false; query parameters cannot be used with legacy SQL.
The values parameter can be set to null to clear out the named parameters so that positional parameters can be used instead.
-
setDestinationTable
Sets the table where to put query results. If not provided a new table is created. This value is required ifsetAllowLargeResults(Boolean)
is set totrue
. -
setDestinationEncryptionConfiguration
public QueryJobConfiguration.Builder setDestinationEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration) -
setTableDefinitions
public QueryJobConfiguration.Builder setTableDefinitions(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 fortableName
it is updated.- Parameters:
tableName
- name of the tabletableDefinition
- external data configuration for the table used by this query
-
setUserDefinedFunctions
public QueryJobConfiguration.Builder setUserDefinedFunctions(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)
. -
setCreateDisposition
public QueryJobConfiguration.Builder setCreateDisposition(JobInfo.CreateDisposition createDisposition) Sets whether the job is allowed to create tables.- See Also:
-
setWriteDisposition
Sets the action that should occur if the destination table already exists.- See Also:
-
setDefaultDataset
Sets the default dataset. This dataset is used for all unqualified table names used in the query. -
setDefaultDataset
Sets the default dataset. This dataset is used for all unqualified table names used in the query. -
setPriority
Sets a priority for the query. If not specified the priority is assumed to beQueryJobConfiguration.Priority.INTERACTIVE
. -
setCreateSession
Sets whether to create a new session. Iftrue
a random session id will be generated by BigQuery. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode." -
setAllowLargeResults
Sets 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. Iftrue
setDestinationTable(TableId)
must be provided.- See Also:
-
setUseQueryCache
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 whensetDestinationTable(TableId)
is not set.- See Also:
-
setFlattenResults
Sets whether nested and repeated fields should be flattened. If set tofalse
setAllowLargeResults(Boolean)
must betrue
. By default results are flattened.- See Also:
-
setDryRun
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. -
setUseLegacySql
Sets 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 ofsetAllowLargeResults(Boolean)
andsetFlattenResults(Boolean)
are ignored; query will be run as ifsetAllowLargeResults(Boolean)
istrue
andsetFlattenResults(Boolean)
isfalse
.If set to
null
ortrue
, legacy SQL dialect is used. This property is experimental and might be subject to change. -
setMaximumBillingTier
Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.- Parameters:
maximumBillingTier
- maximum billing tier for this job
-
setMaximumBytesBilled
Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.- Parameters:
maximumBytesBilled
- maximum bytes billed for this job
-
setSchemaUpdateOptions
public QueryJobConfiguration.Builder setSchemaUpdateOptions(List<JobInfo.SchemaUpdateOption> schemaUpdateOptions) [Experimental] Sets 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. -
setTimePartitioning
Sets the time partitioning specification for the destination table. -
setClustering
Sets the clustering specification for the destination table. -
setJobTimeoutMs
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.- Parameters:
jobTimeoutMs
- jobTimeoutMs ornull
for none
-
setLabels
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.- Parameters:
labels
- labels ornull
for none
-
setRangePartitioning
Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.- Parameters:
rangePartitioning
- rangePartitioning ornull
for none
-
setConnectionProperties
public QueryJobConfiguration.Builder setConnectionProperties(List<ConnectionProperty> connectionProperties) A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently, the only supported connection property is "time_zone", whose value represents the default timezone used to run the query. Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key is an error.- Parameters:
connectionProperties
- connectionProperties ornull
for none
-
setMaxResults
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.- Parameters:
maxResults
- maxResults ornull
for none
-
build
Description copied from class:JobConfiguration.Builder
Creates an object.- Specified by:
build
in classJobConfiguration.Builder<QueryJobConfiguration,
QueryJobConfiguration.Builder>
-