google_api_big_query v0.12.0 GoogleApi.BigQuery.V2.Model.QueryRequest View Source
Attributes
- defaultDataset (GoogleApi.BigQuery.V2.Model.DatasetReference.t): [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'. Defaults to
nil
. - dryRun (boolean()): [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. Defaults to
nil
. - kind (String.t): The resource type of the request. Defaults to
bigquery#queryRequest
. - location (String.t): The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. Defaults to
nil
. - maxResults (integer()): [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. Defaults to
nil
. - parameterMode (String.t): Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. Defaults to
nil
. - preserveNulls (boolean()): [Deprecated] This property is deprecated. Defaults to
nil
. - query (String.t): [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". Defaults to
nil
. - queryParameters (list(GoogleApi.BigQuery.V2.Model.QueryParameter.t)): Query parameters for Standard SQL queries. Defaults to
nil
. - timeoutMs (integer()): [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). Defaults to
nil
. - useLegacySql (boolean()): 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. Defaults to
true
. - useQueryCache (boolean()): [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. Defaults to
true
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %GoogleApi.BigQuery.V2.Model.QueryRequest{
defaultDataset: GoogleApi.BigQuery.V2.Model.DatasetReference.t(),
dryRun: boolean(),
kind: String.t(),
location: String.t(),
maxResults: integer(),
parameterMode: String.t(),
preserveNulls: boolean(),
query: String.t(),
queryParameters: [GoogleApi.BigQuery.V2.Model.QueryParameter.t()],
timeoutMs: integer(),
useLegacySql: boolean(),
useQueryCache: boolean()
}
t() :: %GoogleApi.BigQuery.V2.Model.QueryRequest{ defaultDataset: GoogleApi.BigQuery.V2.Model.DatasetReference.t(), dryRun: boolean(), kind: String.t(), location: String.t(), maxResults: integer(), parameterMode: String.t(), preserveNulls: boolean(), query: String.t(), queryParameters: [GoogleApi.BigQuery.V2.Model.QueryParameter.t()], timeoutMs: integer(), useLegacySql: boolean(), useQueryCache: boolean() }
Link to this section Functions
Link to this function
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.