Class: Google::Apis::BigqueryV2::QueryRequest
- Inherits:
-
Object
- Object
- Google::Apis::BigqueryV2::QueryRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/bigquery_v2/classes.rb,
generated/google/apis/bigquery_v2/representations.rb,
generated/google/apis/bigquery_v2/representations.rb
Instance Attribute Summary collapse
-
#default_dataset ⇒ Google::Apis::BigqueryV2::DatasetReference
[Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query.
-
#dry_run ⇒ Boolean
(also: #dry_run?)
[Optional] If set to true, BigQuery doesn't run the job.
-
#kind ⇒ String
The resource type of the request.
-
#location ⇒ String
The geographic location where the job should run.
-
#max_results ⇒ Fixnum
[Optional] The maximum number of rows of data to return per page of results.
-
#parameter_mode ⇒ String
Standard SQL only.
-
#preserve_nulls ⇒ Boolean
(also: #preserve_nulls?)
[Deprecated] This property is deprecated.
-
#query ⇒ String
[Required] A query string, following the BigQuery query syntax, of the query to execute.
-
#query_parameters ⇒ Array<Google::Apis::BigqueryV2::QueryParameter>
Query parameters for Standard SQL queries.
-
#timeout_ms ⇒ Fixnum
[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns.
-
#use_legacy_sql ⇒ Boolean
(also: #use_legacy_sql?)
Specifies whether to use BigQuery's legacy SQL dialect for this query.
-
#use_query_cache ⇒ Boolean
(also: #use_query_cache?)
[Optional] Whether to look for the result in the query cache.
Instance Method Summary collapse
-
#initialize(**args) ⇒ QueryRequest
constructor
A new instance of QueryRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ QueryRequest
Returns a new instance of QueryRequest
3999 4000 4001 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3999 def initialize(**args) update!(**args) end |
Instance Attribute Details
#default_dataset ⇒ Google::Apis::BigqueryV2::DatasetReference
[Optional] Specifies the default datasetId and projectId to assume for any
unqualified table names in the query. If not set, all table names in the query
string must be qualified in the format 'datasetId.tableId'.
Corresponds to the JSON property defaultDataset
3916 3917 3918 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3916 def default_dataset @default_dataset end |
#dry_run ⇒ Boolean Also known as: dry_run?
[Optional] If set to true, BigQuery doesn't run the job. Instead, if the query
is valid, BigQuery returns statistics about the job such as how many bytes
would be processed. If the query is invalid, an error returns. The default
value is false.
Corresponds to the JSON property dryRun
3924 3925 3926 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3924 def dry_run @dry_run end |
#kind ⇒ String
The resource type of the request.
Corresponds to the JSON property kind
3930 3931 3932 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3930 def kind @kind end |
#location ⇒ String
The geographic location where the job should run. See details at https://cloud.
google.com/bigquery/docs/locations#specifying_your_location.
Corresponds to the JSON property location
3936 3937 3938 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3936 def location @location end |
#max_results ⇒ Fixnum
[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.
Corresponds to the JSON property maxResults
3945 3946 3947 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3945 def max_results @max_results end |
#parameter_mode ⇒ String
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or
to NAMED to use named (@myparam) query parameters in this query.
Corresponds to the JSON property parameterMode
3951 3952 3953 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3951 def parameter_mode @parameter_mode end |
#preserve_nulls ⇒ Boolean Also known as: preserve_nulls?
[Deprecated] This property is deprecated.
Corresponds to the JSON property preserveNulls
3956 3957 3958 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3956 def preserve_nulls @preserve_nulls end |
#query ⇒ String
[Required] A query string, following the BigQuery query syntax, of the query
to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]
".
Corresponds to the JSON property query
3964 3965 3966 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3964 def query @query end |
#query_parameters ⇒ Array<Google::Apis::BigqueryV2::QueryParameter>
Query parameters for Standard SQL queries.
Corresponds to the JSON property queryParameters
3969 3970 3971 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3969 def query_parameters @query_parameters end |
#timeout_ms ⇒ Fixnum
[Optional] 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 'jobComplete' flag
set to false. You can call GetQueryResults() to wait for the query to complete
and read the results. The default value is 10000 milliseconds (10 seconds).
Corresponds to the JSON property timeoutMs
3979 3980 3981 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3979 def timeout_ms @timeout_ms end |
#use_legacy_sql ⇒ Boolean Also known as: use_legacy_sql?
Specifies whether to use BigQuery's legacy SQL dialect for this query. The
default value is true. If set to false, the query will use BigQuery's standard
SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set
to false, the value of flattenResults is ignored; query will be run as if
flattenResults is false.
Corresponds to the JSON property useLegacySql
3988 3989 3990 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3988 def use_legacy_sql @use_legacy_sql end |
#use_query_cache ⇒ Boolean Also known as: use_query_cache?
[Optional] 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. The default value is true.
Corresponds to the JSON property useQueryCache
3996 3997 3998 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 3996 def use_query_cache @use_query_cache end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 |
# File 'generated/google/apis/bigquery_v2/classes.rb', line 4004 def update!(**args) @default_dataset = args[:default_dataset] if args.key?(:default_dataset) @dry_run = args[:dry_run] if args.key?(:dry_run) @kind = args[:kind] if args.key?(:kind) @location = args[:location] if args.key?(:location) @max_results = args[:max_results] if args.key?(:max_results) @parameter_mode = args[:parameter_mode] if args.key?(:parameter_mode) @preserve_nulls = args[:preserve_nulls] if args.key?(:preserve_nulls) @query = args[:query] if args.key?(:query) @query_parameters = args[:query_parameters] if args.key?(:query_parameters) @timeout_ms = args[:timeout_ms] if args.key?(:timeout_ms) @use_legacy_sql = args[:use_legacy_sql] if args.key?(:use_legacy_sql) @use_query_cache = args[:use_query_cache] if args.key?(:use_query_cache) end |