public static final class QueryRequest.Builder extends Object
Modifier and Type | Method and Description |
---|---|
QueryRequest.Builder |
addNamedParameter(String name,
QueryParameterValue value)
Adds a named query parameter to the set of query parameters.
|
QueryRequest.Builder |
addPositionalParameter(QueryParameterValue value)
Adds a positional query parameter to the list of query parameters.
|
QueryRequest |
build() |
QueryRequest.Builder |
setDefaultDataset(DatasetId defaultDataset)
Sets the default dataset to assume for any unqualified table names in the query.
|
QueryRequest.Builder |
setDefaultDataset(String defaultDataset)
Sets the default dataset to assume for any unqualified table names in the query.
|
QueryRequest.Builder |
setDryRun(Boolean dryRun)
Sets whether the query has to be dry run or not.
|
QueryRequest.Builder |
setMaxWaitTime(Long maxWaitTime)
Sets how long to wait for the query to complete, in milliseconds, before the request times
out and returns.
|
QueryRequest.Builder |
setNamedParameters(Map<String,QueryParameterValue> values)
Sets the query parameters to a set of named query parameters to use in the query.
|
QueryRequest.Builder |
setPageSize(Long pageSize)
Sets the maximum number of rows of data to return per page of results.
|
QueryRequest.Builder |
setPositionalParameters(Iterable<QueryParameterValue> values)
Sets the query parameters to a list of positional query parameters to use in the query.
|
QueryRequest.Builder |
setQuery(String query)
Sets the BigQuery query to be executed.
|
QueryRequest.Builder |
setUseLegacySql(Boolean useLegacySql)
Sets whether to use BigQuery's legacy SQL dialect for this query.
|
QueryRequest.Builder |
setUseQueryCache(Boolean useQueryCache)
Sets whether to look for the result in the query cache.
|
public QueryRequest.Builder setQuery(String query)
public QueryRequest.Builder addPositionalParameter(QueryParameterValue value)
setPositionalParameters(Iterable)
for more details on the input requirements.
A positional parameter cannot be added after named parameters have been added.
public QueryRequest.Builder setPositionalParameters(Iterable<QueryParameterValue> values)
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.
public QueryRequest.Builder addNamedParameter(String name, QueryParameterValue value)
setNamedParameters(Map)
for more details on the input requirements.
A named parameter cannot be added after positional parameters have been added.
public QueryRequest.Builder setNamedParameters(Map<String,QueryParameterValue> values)
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.
public QueryRequest.Builder setPageSize(Long pageSize)
public QueryRequest.Builder setDefaultDataset(DatasetId defaultDataset)
public QueryRequest.Builder setDefaultDataset(String defaultDataset)
public QueryRequest.Builder setMaxWaitTime(Long maxWaitTime)
QueryResponse.jobCompleted()
set to false
. If not set, a wait time
of 10000 milliseconds (10 seconds) is used.public QueryRequest.Builder setDryRun(Boolean dryRun)
public QueryRequest.Builder setUseQueryCache(Boolean useQueryCache)
public QueryRequest.Builder setUseLegacySql(Boolean useLegacySql)
false
,
the query will use BigQuery's
Standard SQL. If not set, legacy SQL dialect is used. This property is experimental and
might be subject to change.public QueryRequest build()
Copyright © 2017 Google. All rights reserved.