Home Guides Reference Samples Support Policies Vendors

REST Resource: queries

Resource: Query

Returned when requested for a list of queries or a specific query.

JSON representation 
{
  "queryName": string,
  "queryString": string,
  "arguments": {
    string: {
      object(QueryArgument)
    },
    ...
  },
  "isGlobal": boolean,
  "inDevelopment": boolean
}
Fields
queryName

string

Query's unique name.

queryString

string

Query text.

arguments

map (key: string, value: object (QueryArgument))

Any additional arguments expected by the query. Maps each argument name to its argument type.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
isGlobal

boolean

True if the query is defined as global; otherwise the query can be used only by a particular customer (or set of customers).

inDevelopment

boolean

This field defines whether a query is still in development. If it is in development, it should not be executable except by admin user.

Methods

execute

 Executes a query and returns when it is complete.

list

 Retrieves every query that you have access to.

start

 Executes a query asynchronously and writes the results to the specified destination table in your BigQuery shared dataset.