Update docs for v1.5.3
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index b90faa4..23ae6e6 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -165,6 +165,31 @@
"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
+ "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
@@ -214,6 +239,9 @@
},
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
@@ -293,9 +321,43 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
+ "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ {
+ "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
+ "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
+ },
+ ],
+ "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
@@ -358,12 +420,7 @@
},
},
},
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
- {
- "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- },
- ],
+ "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
},
"id": "A String", # [Output-only] Opaque ID field of the job
@@ -441,6 +498,31 @@
"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
+ "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
@@ -490,6 +572,9 @@
},
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
@@ -569,9 +654,43 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
+ "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ {
+ "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
+ "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
+ },
+ ],
+ "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
@@ -634,12 +753,7 @@
},
},
},
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
- {
- "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- },
- ],
+ "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
},
"id": "A String", # [Output-only] Opaque ID field of the job
@@ -774,6 +888,31 @@
"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
+ "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
@@ -823,6 +962,9 @@
},
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
@@ -902,9 +1044,43 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
+ "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ {
+ "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
+ "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
+ },
+ ],
+ "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
@@ -967,12 +1143,7 @@
},
},
},
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
- {
- "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- },
- ],
+ "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
},
"id": "A String", # [Output-only] Opaque ID field of the job
@@ -1041,6 +1212,31 @@
"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
+ "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
@@ -1090,6 +1286,9 @@
},
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
@@ -1169,9 +1368,43 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
+ "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ {
+ "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
+ "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
+ },
+ ],
+ "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
@@ -1234,12 +1467,7 @@
},
},
},
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
- {
- "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- },
- ],
+ "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
},
"id": "A String", # [Output-only] Opaque ID field of the job
@@ -1331,6 +1559,31 @@
"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.
"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.
"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.
+ "undeclaredQueryParameters": [ # [Output-only, Experimental] Standard SQL only: list of undeclared query parameters detected during a dry run validation.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"numDmlAffectedRows": "A String", # [Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
"billingTier": 42, # [Output-only] Billing tier for the job.
"referencedTables": [ # [Output-only, Experimental] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
@@ -1380,6 +1633,9 @@
},
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"maxBadRecords": 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the load job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"allowJaggedRows": True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
"skipLeadingRows": 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.
@@ -1459,9 +1715,43 @@
"tableId": "A String", # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
"datasetId": "A String", # [Required] The ID of the dataset containing this table.
},
+ "schemaUpdateOptions": [ # [Experimental] Allows the schema of the desitination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
+ "A String",
+ ],
"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
"writeDisposition": "A String", # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
"allowLargeResults": True or False, # If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.
+ "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
+ {
+ "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
+ "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
+ },
+ ],
+ "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"createDisposition": "A String", # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
"query": "A String", # [Required] BigQuery SQL query to execute.
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
@@ -1524,12 +1814,7 @@
},
},
},
- "userDefinedFunctionResources": [ # [Experimental] Describes user-defined function resources used in the query.
- {
- "resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- "inlineCode": "A String", # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- },
- ],
+ "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
},
},
"id": "A String", # Unique opaque ID of the job.
@@ -1571,13 +1856,39 @@
"timeoutMs": 42, # [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).
"kind": "bigquery#queryRequest", # The resource type of the request.
"dryRun": True or False, # [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.
+ "parameterMode": "A String", # [Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query.
"useQueryCache": true, # [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.
"defaultDataset": { # [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'.
"projectId": "A String", # [Optional] The ID of the project containing this dataset.
"datasetId": "A String", # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
},
- "useLegacySql": True or False, # [Experimental] 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 values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
+ "useLegacySql": true, # [Experimental] 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 values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false.
"maxResults": 42, # [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.
+ "queryParameters": [ # [Experimental] Query parameters for Standard SQL queries.
+ {
+ "parameterType": { # [Required] The type of this parameter.
+ "structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
+ {
+ "type": # Object with schema name: QueryParameterType # [Required] The type of this field.
+ "description": "A String", # [Optional] Human-oriented description of the field.
+ "name": "A String", # [Optional] The name of this field.
+ },
+ ],
+ "type": "A String", # [Required] The top level type of this field.
+ "arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.
+ },
+ "parameterValue": { # [Required] The value of this parameter.
+ "structValues": [ # [Optional] The struct field values, in order of the struct type's declaration.
+ # Object with schema name: QueryParameterValue
+ ],
+ "arrayValues": [ # [Optional] The array values, if this is an array type.
+ # Object with schema name: QueryParameterValue
+ ],
+ "value": "A String", # [Optional] The value of this value, if a simple scalar type.
+ },
+ "name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
+ },
+ ],
"query": "A String", # [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".
"preserveNulls": True or False, # [Deprecated] This property is deprecated.
}