com.google.cloud.bigquery

Class QueryRequest.Builder

java.lang.Object

com.google.cloud.bigquery.QueryRequest.Builder

Enclosing class:

QueryRequest

public static final class QueryRequest.Builder
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
QueryRequest	build()
QueryRequest.Builder	defaultDataset(DatasetId defaultDataset) Sets the default dataset to assume for any unqualified table names in the query.
QueryRequest.Builder	defaultDataset(String defaultDataset) Sets the default dataset to assume for any unqualified table names in the query.
QueryRequest.Builder	dryRun(Boolean dryRun) Sets whether the query has to be dry run or not.
QueryRequest.Builder	maxWaitTime(Long maxWaitTime) Sets how long to wait for the query to complete, in milliseconds, before the request times out and returns.
QueryRequest.Builder	pageSize(Long pageSize) Sets the maximum number of rows of data to return per page of results.
QueryRequest.Builder	query(String query) Sets the BigQuery query to be executed.
QueryRequest.Builder	useLegacySql(Boolean useLegacySql) Sets whether to use BigQuery's legacy SQL dialect for this query.
QueryRequest.Builder	useQueryCache(Boolean useQueryCache) Sets whether to look for the result in the query cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

query

public QueryRequest.Builder query(String query)

Sets the BigQuery query to be executed.

pageSize

public QueryRequest.Builder pageSize(Long pageSize)

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

defaultDataset

public QueryRequest.Builder defaultDataset(DatasetId defaultDataset)

Sets the default dataset to assume for any unqualified table names in the query.

defaultDataset

public QueryRequest.Builder defaultDataset(String defaultDataset)

Sets the default dataset to assume for any unqualified table names in the query.

maxWaitTime

public QueryRequest.Builder maxWaitTime(Long maxWaitTime)

Sets how long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the QueryResponse.jobCompleted() set to false. If not set, a wait time of 10000 milliseconds (10 seconds) is used.

dryRun

public QueryRequest.Builder dryRun(Boolean dryRun)

Sets whether the query has to be dry run or not. If set, the query is not executed. If the query is valid statistics are returned on how many bytes would be processed. If the query is invalid an error is returned. If not set the query is executed.

useQueryCache

public QueryRequest.Builder useQueryCache(Boolean useQueryCache)

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. If not specified the query cache is used.

See Also:

Query Caching

useLegacySql

public QueryRequest.Builder useLegacySql(Boolean useLegacySql)

Sets whether to use BigQuery's legacy SQL dialect for this query. If set to 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.

build

public QueryRequest build()