- JSON representation
- JobConfiguration
- JobConfigurationQuery
- SystemVariables
- ScriptOptions
- KeyResultStatementKind
- JobConfigurationLoad
- DestinationTableProperties
- JobConfigurationTableCopy
- OperationType
- JobConfigurationExtract
- ModelExtractOptions
- JobStatistics
- JobStatistics2
- ExplainQueryStage
- ExplainQueryStep
- QueryTimelineSample
- MlStatistics
- TrainingType
- ExportDataStatistics
- ExternalServiceCost
- BiEngineStatistics
- BiEngineMode
- BiEngineAccelerationMode
- BiEngineReason
- Code
- LoadQueryStatistics
- SearchStatistics
- IndexUsageMode
- IndexUnusedReason
- Code
- PerformanceInsights
- StagePerformanceStandaloneInsight
- StagePerformanceChangeInsight
- InputDataChange
- JobStatistics3
- JobStatistics4
- ScriptStatistics
- EvaluationKind
- ScriptStackFrame
- RowLevelSecurityStatistics
- DataMaskingStatistics
- TransactionInfo
- JobStatus
JSON representation |
---|
{ "kind": string, "etag": string, "id": string, "selfLink": string, "user_email": string, "configuration": { object ( |
Fields | |
---|---|
kind |
Output only. The type of the resource. |
etag |
Output only. A hash of this resource. |
id |
Output only. Opaque ID field of the job. |
selfLink |
Output only. A URL that can be used to access the resource again. |
user_email |
Output only. Email address of the user who ran the job. |
configuration |
Required. Describes the job configuration. |
jobReference |
Optional. Reference describing the unique-per-user name of the job. |
statistics |
Output only. Information about the job, including starting time and ending time of the job. |
status |
Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. |
principal_subject |
Output only. [Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities. |
JobConfiguration
JSON representation |
---|
{ "jobType": string, "query": { object ( |
Fields | |
---|---|
jobType |
Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. |
query |
[Pick one] Configures a query job. |
load |
[Pick one] Configures a load job. |
copy |
[Pick one] Copies a table. |
extract |
[Pick one] Configures an extract job. |
dryRun |
Optional. If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined. |
jobTimeoutMs |
Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job. |
labels |
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. An object containing a list of |
JobConfigurationQuery
JobConfigurationQuery configures a BigQuery query job.
JSON representation |
---|
{ "query": string, "destinationTable": { object ( |
Fields | |
---|---|
query |
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. |
destinationTable |
Optional. Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery. |
tableDefinitions |
Optional. You can specify external table definitions, which operate as ephemeral tables that can be queried. These definitions are configured using a JSON map, where the string key represents the table identifier, and the value is the corresponding external data configuration object. An object containing a list of |
userDefinedFunctionResources[] |
Describes user-defined function resources used in the query. |
createDisposition |
Optional. Specifies whether the job is allowed to create new tables. The following values are supported:
The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
writeDisposition |
Optional. Specifies the action that occurs if the destination table already exists. The following values are supported:
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. |
defaultDataset |
Optional. Specifies the default dataset to use for unqualified table names in the query. This setting does not alter behavior of unqualified dataset names. Setting the system variable @@dataset_id achieves the same behavior. |
priority |
Optional. Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. |
preserveNulls |
[Deprecated] This property is deprecated. |
allowLargeResults |
Optional. If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size. |
useQueryCache |
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. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true. |
flattenResults |
Optional. If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened. |
maximumBillingTier |
Optional. [Deprecated] Maximum billing tier allowed for this query. The billing tier controls the amount of compute resources allotted to the query, and multiplies the on-demand cost of the query accordingly. A query that runs within its allotted resources will succeed and indicate its billing tier in statistics.query.billingTier, but if the query exceeds its allotted resources, it will fail with billingTierLimitExceeded. WARNING: The billed byte amount can be multiplied by an amount up to this number! Most users should not need to alter this setting, and we recommend that you avoid introducing new uses of it. |
maximumBytesBilled |
Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default. |
useLegacySql |
Optional. 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. |
parameterMode |
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. |
queryParameters[] |
jobs.query parameters for standard SQL queries. |
schemaUpdateOptions[] |
Allows the schema of the destination 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:
|
timePartitioning |
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
rangePartitioning |
Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
clustering |
Clustering specification for the destination table. |
destinationEncryptionConfiguration |
Custom encryption configuration (e.g., Cloud KMS keys) |
scriptOptions |
Options controlling the execution of scripts. |
connectionProperties[] |
Connection properties which can modify the query behavior. |
createSession |
If this property is true, the job creates a new session using a randomly generated sessionId. To continue using a created session with subsequent queries, pass the existing session identifier as a The new session's location will be set to |
Union field
|
|
systemVariables |
Output only. System variables for standard SQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. |
SystemVariables
System variables given to a query.
JSON representation |
---|
{
"types": {
string: {
object ( |
Fields | |
---|---|
types |
Output only. Data type for each system variable. An object containing a list of |
values |
Output only. Value for each system variable. |
ScriptOptions
JSON representation |
---|
{
"statementTimeoutMs": string,
"statementByteBudget": string,
"keyResultStatement": enum ( |
Fields | |
---|---|
statementTimeoutMs |
Timeout period for each statement in a script. |
statementByteBudget |
Limit on the number of bytes billed per statement. Exceeding this budget results in an error. |
keyResultStatement |
Determines which statement in the script represents the "key result", used to populate the schema and query results of the script job. Default is LAST. |
KeyResultStatementKind
Enums | |
---|---|
KEY_RESULT_STATEMENT_KIND_UNSPECIFIED |
|
LAST |
|
FIRST_SELECT |
JobConfigurationLoad
JobConfigurationLoad contains the configuration properties for loading data into a destination table.
JSON representation |
---|
{ "sourceUris": [ string ], "schema": { object ( |
Fields | |
---|---|
sourceUris[] |
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed. |
schema |
Optional. The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. |
destinationTable |
[Required] The destination table to load the data into. |
destinationTableProperties |
Optional. [Experimental] Properties with which to create the destination table if it is new. |
createDisposition |
Optional. Specifies whether the job is allowed to create new tables. The following values are supported:
|
writeDisposition |
Optional. Specifies the action that occurs if the destination table already exists. The following values are supported:
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. |
nullMarker |
Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value. |
fieldDelimiter |
Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence "\t" (U+0009) to specify a tab separator. The default value is comma (",", U+002C). |
skipLeadingRows |
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. When autodetect is on, the behavior is the following:
|
encoding |
Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the If you don't specify an encoding, or if you specify a UTF-8 encoding when the CSV file is not UTF-8 encoded, BigQuery attempts to convert the data to UTF-8. Generally, your data loads successfully, but it may not match byte-for-byte what you expect. To avoid this, specify the correct encoding by using the If BigQuery can't convert a character other than the ASCII |
quote |
Optional. The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '. @default " |
maxBadRecords |
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. This is only supported for CSV and NEWLINE_DELIMITED_JSON file formats. |
schemaInlineFormat |
[Deprecated] The format of the schemaInline property. |
schemaInline |
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". |
allowQuotedNewlines |
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. |
sourceFormat |
Optional. The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV. |
allowJaggedRows |
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. |
ignoreUnknownValues |
Optional. Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra 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. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names in the table schema Avro, Parquet, ORC: Fields in the file schema that don't exist in the table schema. |
projectionFields[] |
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result. |
autodetect |
Optional. Indicates if we should automatically infer the options and schema for CSV and JSON sources. |
schemaUpdateOptions[] |
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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:
|
timePartitioning |
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
rangePartitioning |
Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. |
clustering |
Clustering specification for the destination table. |
destinationEncryptionConfiguration |
Custom encryption configuration (e.g., Cloud KMS keys) |
useAvroLogicalTypes |
Optional. If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER). |
referenceFileSchemaUri |
Optional. The user can provide a reference file with the reader schema. This file is only loaded if it is part of source URIs, but is not loaded otherwise. It is enabled for the following formats: AVRO, PARQUET, ORC. |
hivePartitioningOptions |
Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification. |
decimalTargetTypes[] |
Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is:
This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats. |
parquetOptions |
Optional. Additional properties to set if sourceFormat is set to PARQUET. |
preserveAsciiControlCharacters |
Optional. When sourceFormat is set to "CSV", this indicates whether the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved. |
DestinationTableProperties
JSON representation |
---|
{ "friendlyName": string, "description": string, "labels": { string: string, ... } } |
Fields | |
---|---|
friendlyName |
Optional. Friendly name for the destination table. If the table already exists, it should be same as the existing friendly name. |
description |
Optional. The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail. |
labels |
Optional. The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail. An object containing a list of |
JobConfigurationTableCopy
JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see Copy a table.
JSON representation |
---|
{ "sourceTable": { object ( |
Fields | |
---|---|
sourceTable |
[Pick one] Source table to copy. |
sourceTables[] |
[Pick one] Source tables to copy. |
destinationTable |
[Required] The destination table. |
createDisposition |
Optional. Specifies whether the job is allowed to create new tables. The following values are supported:
The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. |
writeDisposition |
Optional. Specifies the action that occurs if the destination table already exists. The following values are supported:
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. |
destinationEncryptionConfiguration |
Custom encryption configuration (e.g., Cloud KMS keys). |
operationType |
Optional. Supported operation types in table copy job. |
destinationExpirationTime |
Optional. The time when the destination table expires. Expired tables will be deleted and their storage reclaimed. |
OperationType
Indicates different operation types supported in table copy job.
Enums | |
---|---|
OPERATION_TYPE_UNSPECIFIED |
Unspecified operation type. |
COPY |
The source and destination table have the same table type. |
SNAPSHOT |
The source table type is TABLE and the destination table type is SNAPSHOT. |
RESTORE |
The source table type is SNAPSHOT and the destination table type is TABLE. |
CLONE |
The source and destination table have the same table type, but only bill for unique data. |
JobConfigurationExtract
JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.
JSON representation |
---|
{ "destinationUri": string, "destinationUris": [ string ], "printHeader": boolean, "fieldDelimiter": string, "destinationFormat": string, "compression": string, "useAvroLogicalTypes": boolean, "modelExtractOptions": { object ( |
Fields | |
---|---|
destinationUri |
[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written. |
destinationUris[] |
[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. |
printHeader |
Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. |
fieldDelimiter |
Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models. |
destinationFormat |
Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL. |
compression |
Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models. |
useAvroLogicalTypes |
Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. |
modelExtractOptions |
Optional. Model extract options only applicable when extracting models. |
Union field source . Required. Source reference for the export. source can be only one of the following: |
|
sourceTable |
A reference to the table being exported. |
sourceModel |
A reference to the model being exported. |
ModelExtractOptions
Options related to model extraction.
JSON representation |
---|
{ "trialId": string } |
Fields | |
---|---|
trialId |
The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = Model.defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. |
JobStatistics
Statistics for a single job execution.
JSON representation |
---|
{ "creationTime": string, "startTime": string, "endTime": string, "totalBytesProcessed": string, "completionRatio": number, "quotaDeferments": [ string ], "query": { object ( |
Fields | |
---|---|
creationTime |
Output only. Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. |
startTime |
Output only. Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE. |
endTime |
Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. |
totalBytesProcessed |
Output only. Total bytes processed for the job. |
completionRatio |
Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. |
quotaDeferments[] |
Output only. Quotas which delayed this job's start time. |
query |
Output only. Statistics for a query job. |
load |
Output only. Statistics for a load job. |
extract |
Output only. Statistics for an extract job. |