Skip to main content
Server path: /google-bigquery | Type: Application | PCID required: Yes

Tools

ToolDescription
google-bigquery_datasets_deleteDeletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.
google-bigquery_datasets_getReturns the dataset specified by datasetID.
google-bigquery_datasets_insertCreates a new empty dataset.
google-bigquery_datasets_listLists all datasets in the specified project to which the user has been granted the READER dataset role.
google-bigquery_datasets_patchUpdates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics.
google-bigquery_execute_sql_queryRuns a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
google-bigquery_insert_rowsStreams data into BigQuery one record at a time without needing to run a load job.
google-bigquery_jobs_cancelRequests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.
google-bigquery_jobs_deleteRequests the deletion of the metadata of a job. This call returns when the job’s metadata is deleted.
google-bigquery_jobs_getReturns information about a specific job. Job information is available for a six month period after creation. Requires that you’re the person who ran the job, or have the Is Owner project role.
google-bigquery_jobs_get_query_resultsRPC to get the results of a query job.
google-bigquery_jobs_listLists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.
google-bigquery_list_row_access_policiesLists all row access policies on the specified table.
google-bigquery_list_table_dataList the content of a table in rows.
google-bigquery_models_deleteDeletes the model specified by modelId from the dataset.
google-bigquery_models_getGets the specified model resource by model ID.
google-bigquery_models_listLists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.
google-bigquery_models_patchPatch specific fields in the specified model.
google-bigquery_projects_listRPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the Resource Manager API, which provides the underlying data for this method and has more capabilities.
google-bigquery_routines_deleteDeletes the routine specified by routineId from the dataset.
google-bigquery_routines_getGets the specified routine resource by routine ID.
google-bigquery_routines_insertCreates a new routine in the dataset.
google-bigquery_routines_listLists all routines in the specified dataset. Requires the READER dataset role.
google-bigquery_routines_updateUpdates information in an existing routine. The update method replaces the entire Routine resource.
google-bigquery_tables_deleteDeletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.
google-bigquery_tables_getGets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.
google-bigquery_tables_insertCreates a new, empty table in the dataset.
google-bigquery_tables_listLists all tables in the specified dataset. Requires the READER dataset role.
google-bigquery_tables_patchUpdates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics.
google-bigquery_undelete_datasetUndeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted.

google-bigquery_datasets_delete

Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the dataset being deleted
datasetIdstringYesRequired. Dataset ID of dataset being deleted
deleteContentsbooleanNoIf True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

google-bigquery_datasets_get

Returns the dataset specified by datasetID. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the requested dataset
datasetIdstringYesRequired. Dataset ID of the requested dataset
datasetViewstringNoOptional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.

google-bigquery_datasets_insert

Creates a new empty dataset. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the new dataset
accessobject[]NoOptional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
creationTimestringNoOutput only. The time when this dataset was created, in milliseconds since the epoch.
datasetReferenceobjectNoDataset Reference
defaultCollationstringNoOptional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * ‘und:ci’: undetermined locale, case insensitive. * ”: empty string. Default to case-sensitive behavior.
defaultEncryptionConfigurationobjectNoDefault Encryption Configuration
defaultPartitionExpirationMsstringNoThis default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the TimePartitioning.expirationMs property on the new table. If you set TimePartitioning.expirationMs explicitly when creating a table, the defaultPartitionExpirationMs of the containing dataset is ignored. When creating a partitioned table, if defaultPartitionExpirationMs is set, the defaultTableExpirationMs value is ignored and the table will not be inherit a table expiration deadline.
defaultRoundingModestringNoOptional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table’s default rounding mode, unless otherwise specified.
defaultTableExpirationMsstringNoOptional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table’s expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
descriptionstringNoOptional. A user-friendly description of the dataset.
etagstringNoOutput only. A hash of the resource.
externalDatasetReferenceobjectNoConfigures the access a dataset defined in an external metadata storage.
friendlyNamestringNoOptional. A descriptive name for the dataset.
idstringNoOutput only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
isCaseInsensitivebooleanNoOptional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.
kindstringNoOutput only. The resource type.
labelsobjectNoThe labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
lastModifiedTimestringNoOutput only. The date when this dataset was last modified, in milliseconds since the epoch.
linkedDatasetSourceobjectNoA dataset source type which refers to another BigQuery dataset.
locationstringNoThe geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
maxTimeTravelHoursstringNoOptional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.
satisfiesPzibooleanNoOutput only. Reserved for future use.
satisfiesPzsbooleanNoOutput only. Reserved for future use.
selfLinkstringNoOutput only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
storageBillingModelstringNoOptional. Updates storage_billing_model for the dataset.
tagsobject[]NoOutput only. Tags for the Dataset.
typestringNoOutput only. Same as type in ListFormatDataset. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. — *BIGLAKE_METASTORE - dataset that references a database created in BigLakeMetastore service. —

google-bigquery_datasets_list

Lists all datasets in the specified project to which the user has been granted the READER dataset role. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the datasets to be listed
allbooleanNoWhether to list all datasets, including hidden ones
filterstringNoAn expression for filtering the results of the request by label. The syntax is “labels.<name>[:<value>]”. Multiple filters can be ANDed together by connecting with a space. Example: “labels.department:receiving labels.active”. See Filtering datasets using labels for details.
maxResultsintegerNoThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageTokenstringNoPage token, returned by a previous call, to request the next page of results

google-bigquery_datasets_patch

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the dataset being updated
datasetIdstringYesRequired. Dataset ID of the dataset being updated
accessobject[]NoOptional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
creationTimestringNoOutput only. The time when this dataset was created, in milliseconds since the epoch.
datasetReferenceobjectNoDataset Reference
defaultCollationstringNoOptional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: * ‘und:ci’: undetermined locale, case insensitive. * ”: empty string. Default to case-sensitive behavior.
defaultEncryptionConfigurationobjectNoDefault Encryption Configuration
defaultPartitionExpirationMsstringNoThis default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the TimePartitioning.expirationMs property on the new table. If you set TimePartitioning.expirationMs explicitly when creating a table, the defaultPartitionExpirationMs of the containing dataset is ignored. When creating a partitioned table, if defaultPartitionExpirationMs is set, the defaultTableExpirationMs value is ignored and the table will not be inherit a table expiration deadline.
defaultRoundingModestringNoOptional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table’s default rounding mode, unless otherwise specified.
defaultTableExpirationMsstringNoOptional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table’s expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
descriptionstringNoOptional. A user-friendly description of the dataset.
etagstringNoOutput only. A hash of the resource.
externalDatasetReferenceobjectNoConfigures the access a dataset defined in an external metadata storage.
friendlyNamestringNoOptional. A descriptive name for the dataset.
idstringNoOutput only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
isCaseInsensitivebooleanNoOptional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.
kindstringNoOutput only. The resource type.
labelsobjectNoThe labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
lastModifiedTimestringNoOutput only. The date when this dataset was last modified, in milliseconds since the epoch.
linkedDatasetSourceobjectNoA dataset source type which refers to another BigQuery dataset.
locationstringNoThe geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
maxTimeTravelHoursstringNoOptional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.
satisfiesPzibooleanNoOutput only. Reserved for future use.
satisfiesPzsbooleanNoOutput only. Reserved for future use.
selfLinkstringNoOutput only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
storageBillingModelstringNoOptional. Updates storage_billing_model for the dataset.
tagsobject[]NoOutput only. Tags for the Dataset.
typestringNoOutput only. Same as type in ListFormatDataset. The type of the dataset, one of: * DEFAULT - only accessible by owner and authorized accounts, * PUBLIC - accessible by everyone, * LINKED - linked dataset, * EXTERNAL - dataset with definition in external metadata catalog. — *BIGLAKE_METASTORE - dataset that references a database created in BigLakeMetastore service. —

google-bigquery_execute_sql_query

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the query request.
connectionPropertiesobject[]NoOptional. Connection properties which can modify the query behavior.
continuousbooleanNo[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
createSessionbooleanNoOptional. If true, creates a new session using a randomly generated session_id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode. The session location will be set to QueryRequest.location if it is present, otherwise it’s set to the default location based on existing routing logic.
defaultDatasetobjectNoDefault Dataset
dryRunbooleanNoOptional. 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.
formatOptionsobjectNoOptions for data format adjustments.
jobCreationModestringNoOptional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. This feature is not yet available. Jobs will always be created.
kindstringNoThe resource type of the request.
labelsobjectNoOptional. The labels associated with this query. Labels can be used to organize and group query 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 keys must start with a letter and each label in the list must have a different key.
locationstringNoThe geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
maximumBytesBilledstringNoOptional. Limits the bytes billed for this query. Queries with bytes billed above this limit will fail (without incurring a charge). If unspecified, the project default is used.
maxResultsintegerNoOptional. 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.
parameterModestringNoGoogleSQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
preserveNullsbooleanNoThis property is deprecated.
querystringYesRequired. A query string to execute, using Google Standard SQL or legacy SQL syntax. Example: “SELECT COUNT(f1) FROM myProjectId.myDatasetId.myTableId”.
queryParametersobject[]NoQuery parameters for GoogleSQL queries.
requestIdstringNoOptional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don’t affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.
timeoutMsintegerNoOptional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.
useLegacySqlbooleanNoSpecifies 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 GoogleSQL: 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.
useQueryCachebooleanNoOptional. 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.

google-bigquery_insert_rows

Streams data into BigQuery one record at a time without needing to run a load job. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the destination.
datasetIdstringYesRequired. Dataset ID of the destination.
tableIdstringYesRequired. Table ID of the destination.
ignoreUnknownValuesbooleanNoOptional. Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
kindstringNoOptional. The resource type of the response. The value is not checked at the backend. Historically, it has been set to “bigquery#tableDataInsertAllRequest” but you are not required to set it.
rowsobject[]YesThe rows value
skipInvalidRowsbooleanNoOptional. Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
templateSuffixstringNoOptional. If specified, treats the destination table as a base template, and inserts the rows into an instance table named “{destination}{templateSuffix}”. BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
traceIdstringNoOptional. Unique request trace id. Used for debugging purposes only. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended.

google-bigquery_jobs_cancel

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the job to cancel
jobIdstringYesRequired. Job ID of the job to cancel
locationstringNoThe geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the us or the eu multi-regional location - If the job’s location is in a single region (for example, us-central1) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

google-bigquery_jobs_delete

Requests the deletion of the metadata of a job. This call returns when the job’s metadata is deleted. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the job for which metadata is to be deleted.
jobIdstringYesRequired. Job ID of the job for which metadata is to be deleted. If this is a parent job which has child jobs, the metadata from all child jobs will be deleted as well. Direct deletion of the metadata of child jobs is not allowed.
locationstringNoThe geographic location of the job. Required. See details at: https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

google-bigquery_jobs_get

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you’re the person who ran the job, or have the Is Owner project role. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the requested job.
jobIdstringYesRequired. Job ID of the requested job.
locationstringNoThe geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the us or the eu multi-regional location - If the job’s location is in a single region (for example, us-central1) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

google-bigquery_jobs_get_query_results

RPC to get the results of a query job. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the query job.
jobIdstringYesRequired. Job ID of the query job.
formatOptions.useInt64TimestampbooleanNoOptional. Output timestamp as usec int64. Default is false.
locationstringNoThe geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the us or the eu multi-regional location - If the job’s location is in a single region (for example, us-central1) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
maxResultsintegerNoMaximum number of results to read.
pageTokenstringNoPage token, returned by a previous call, to request the next page of results.
startIndexstringNoZero-based index of the starting row.
timeoutMsintegerNoOptional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.

google-bigquery_jobs_list

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesProject ID of the jobs to list.
allUsersbooleanNoWhether to display jobs owned by all users in the project. Default False.
maxCreationTimestringNoMax value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned.
maxResultsintegerNoThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
minCreationTimestringNoMin value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned.
pageTokenstringNoPage token, returned by a previous call, to request the next page of results.
parentJobIdstringNoIf set, show only child jobs of the specified parent. Otherwise, show all top-level jobs.
projectionstringNoRestrict information returned to a set of selected fields
stateFilterstring[]NoFilter for job state

google-bigquery_list_row_access_policies

Lists all row access policies on the specified table. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the row access policies to list.
datasetIdstringYesRequired. Dataset ID of row access policies to list.
tableIdstringYesRequired. Table ID of the table to list row access policies.
pageSizeintegerNoThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageTokenstringNoPage token, returned by a previous call, to request the next page of results.

google-bigquery_list_table_data

List the content of a table in rows. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project id of the table to list.
datasetIdstringYesRequired. Dataset id of the table to list.
tableIdstringYesRequired. Table id of the table to list.
formatOptions.useInt64TimestampbooleanNoOptional. Output timestamp as usec int64. Default is false.
maxResultsintegerNoRow limit of the table.
pageTokenstringNoTo retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list.
selectedFieldsstringNoSubset of fields to return, supports select into sub fields. Example: selected_fields = “a,e.d.f”;
startIndexstringNoStart row index of the table.

google-bigquery_models_delete

Deletes the model specified by modelId from the dataset. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the model to delete.
datasetIdstringYesRequired. Dataset ID of the model to delete.
modelIdstringYesRequired. Model ID of the model to delete.

google-bigquery_models_get

Gets the specified model resource by model ID. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the requested model.
datasetIdstringYesRequired. Dataset ID of the requested model.
modelIdstringYesRequired. Model ID of the requested model.

google-bigquery_models_list

Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the models to list.
datasetIdstringYesRequired. Dataset ID of the models to list.
maxResultsintegerNoThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageTokenstringNoPage token, returned by a previous call to request the next page of results

google-bigquery_models_patch

Patch specific fields in the specified model. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the model to patch.
datasetIdstringYesRequired. Dataset ID of the model to patch.
modelIdstringYesRequired. Model ID of the model to patch.
bestTrialIdstringNoThe best trial_id across all training runs.
creationTimestringNoOutput only. The time when this model was created, in millisecs since the epoch.
defaultTrialIdstringNoOutput only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective hyperparameter tuning models, this is the best trial ID. For multi-objective hyperparameter tuning models, this is the smallest trial ID among all Pareto optimal trials.
descriptionstringNoOptional. A user-friendly description of this model.
encryptionConfigurationobjectNoEncryption Configuration
etagstringNoOutput only. A hash of this resource.
expirationTimestringNoOptional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
featureColumnsobject[]NoOutput only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.
friendlyNamestringNoOptional. A descriptive name for this model.
hparamSearchSpacesobjectNoHyperparameter search spaces. These should be a subset of training_options.
hparamTrialsobject[]NoOutput only. Trials of a hyperparameter tuning model sorted by trial_id.
labelColumnsobject[]NoOutput only. Label columns that were used to train this model. The output of the model will have a “predicted_” prefix to these columns.
labelsobjectNoThe labels associated with this model. You can use these to organize and group your models. 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.
lastModifiedTimestringNoOutput only. The time when this model was last modified, in millisecs since the epoch.
locationstringNoOutput only. The geographic location where the model resides. This value is inherited from the dataset.
modelReferenceobjectNoId path of a model.
modelTypestringNoOutput only. Type of the model resource.
optimalTrialIdsstring[]NoOutput only. For single-objective hyperparameter tuning models, it only contains the best trial. For multi-objective hyperparameter tuning models, it contains all Pareto optimal trials sorted by trial_id.
remoteModelInfoobjectNoRemote Model Info
trainingRunsobject[]NoInformation for all training runs in increasing order of start_time.
transformColumnsobject[]NoOutput only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.

google-bigquery_projects_list

RPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the Resource Manager API, which provides the underlying data for this method and has more capabilities. Parameters:
ParameterTypeRequiredDefaultDescription
maxResultsintegerNomaxResults unset returns all results, up to 50 per page. Additionally, the number of projects in a page may be fewer than maxResults because projects are retrieved and then filtered to only projects with the BigQuery API enabled.
pageTokenstringNoPage token, returned by a previous call, to request the next page of results. If not present, no further pages are present.

google-bigquery_routines_delete

Deletes the routine specified by routineId from the dataset. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the routine to delete
datasetIdstringYesRequired. Dataset ID of the routine to delete
routineIdstringYesRequired. Routine ID of the routine to delete

google-bigquery_routines_get

Gets the specified routine resource by routine ID. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the requested routine
datasetIdstringYesRequired. Dataset ID of the requested routine
routineIdstringYesRequired. Routine ID of the requested routine
readMaskstringNoIf set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.

google-bigquery_routines_insert

Creates a new routine in the dataset. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the new routine
datasetIdstringYesRequired. Dataset ID of the new routine
argumentsobject[]NoOptional.
creationTimestringNoOutput only. The time when this routine was created, in milliseconds since the epoch.
dataGovernanceTypestringNoOptional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines.
definitionBodystringYesRequired. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n Note that both \n are replaced with linebreaks.
descriptionstringNoOptional. The description of the routine, if defined.
determinismLevelstringNoOptional. The determinism level of the JavaScript UDF, if defined.
etagstringNoOutput only. A hash of this resource.
importedLibrariesstring[]NoOptional. If language = “JAVASCRIPT”, this field stores the path of the imported JAVASCRIPT libraries.
languagestringNoOptional. Defaults to “SQL” if remote_function_options field is absent, not set otherwise.
lastModifiedTimestringNoOutput only. The time when this routine was last modified, in milliseconds since the epoch.
remoteFunctionOptionsobjectNoOptions for a remote user-defined function.
returnTableTypeobjectNoA table type
returnTypeobjectNoThe data type of a variable such as a function argument. Examples include: * INT64: &#123;"typeKind": "INT64"&#125; * ARRAY: { “typeKind”: “ARRAY”, “arrayElementType”: {“typeKind”: “STRING”} } * STRUCT>: { “typeKind”: “STRUCT”, “structType”: { “fields”: [ { “name”: “x”, “type”: {“typeKind”: “STRING”} }, { “name”: “y”, “type”: { “typeKind”: “ARRAY”, “arrayElementType”: {“typeKind”: “DATE”} } } ] } }
routineReferenceobjectNoId path of a routine.
routineTypestringYesRequired. The type of routine.
securityModestringNoOptional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine’s configuration.
sparkOptionsobjectNoOptions for a user-defined Spark routine.
strictModebooleanNoOptional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn’t guarantee that the procedure will successfully execute at runtime. If strictMode is set to TRUE, the procedure body is further checked for errors such as non-existent tables or columns. The CREATE PROCEDURE statement fails if the body fails any of these checks. If strictMode is set to FALSE, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify strictMode=FALSE to avoid non-existent procedure errors during validation. Default value is TRUE.

google-bigquery_routines_list

Lists all routines in the specified dataset. Requires the READER dataset role. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the routines to list
datasetIdstringYesRequired. Dataset ID of the routines to list
filterstringNoIf set, then only the Routines matching this filter are returned. The supported format is routineType:&#123;RoutineType&#125;, where &#123;RoutineType&#125; is a RoutineType enum. For example: routineType:SCALAR_FUNCTION.
maxResultsintegerNoThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageTokenstringNoPage token, returned by a previous call, to request the next page of results
readMaskstringNoIf set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.

google-bigquery_routines_update

Updates information in an existing routine. The update method replaces the entire Routine resource. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the routine to update
datasetIdstringYesRequired. Dataset ID of the routine to update
routineIdstringYesRequired. Routine ID of the routine to update
argumentsobject[]NoOptional.
creationTimestringNoOutput only. The time when this routine was created, in milliseconds since the epoch.
dataGovernanceTypestringNoOptional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines.
definitionBodystringNoRequired. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n Note that both \n are replaced with linebreaks.
descriptionstringNoOptional. The description of the routine, if defined.
determinismLevelstringNoOptional. The determinism level of the JavaScript UDF, if defined.
etagstringNoOutput only. A hash of this resource.
importedLibrariesstring[]NoOptional. If language = “JAVASCRIPT”, this field stores the path of the imported JAVASCRIPT libraries.
languagestringNoOptional. Defaults to “SQL” if remote_function_options field is absent, not set otherwise.
lastModifiedTimestringNoOutput only. The time when this routine was last modified, in milliseconds since the epoch.
remoteFunctionOptionsobjectNoOptions for a remote user-defined function.
returnTableTypeobjectNoA table type
returnTypeobjectNoThe data type of a variable such as a function argument. Examples include: * INT64: &#123;"typeKind": "INT64"&#125; * ARRAY: { “typeKind”: “ARRAY”, “arrayElementType”: {“typeKind”: “STRING”} } * STRUCT>: { “typeKind”: “STRUCT”, “structType”: { “fields”: [ { “name”: “x”, “type”: {“typeKind”: “STRING”} }, { “name”: “y”, “type”: { “typeKind”: “ARRAY”, “arrayElementType”: {“typeKind”: “DATE”} } } ] } }
routineReferenceobjectNoId path of a routine.
routineTypestringNoRequired. The type of routine.
securityModestringNoOptional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine’s configuration.
sparkOptionsobjectNoOptions for a user-defined Spark routine.
strictModebooleanNoOptional. Use this option to catch many common errors. Error checking is not exhaustive, and successfully creating a procedure doesn’t guarantee that the procedure will successfully execute at runtime. If strictMode is set to TRUE, the procedure body is further checked for errors such as non-existent tables or columns. The CREATE PROCEDURE statement fails if the body fails any of these checks. If strictMode is set to FALSE, the procedure body is checked only for syntax. For procedures that invoke themselves recursively, specify strictMode=FALSE to avoid non-existent procedure errors during validation. Default value is TRUE.

google-bigquery_tables_delete

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the table to delete
datasetIdstringYesRequired. Dataset ID of the table to delete
tableIdstringYesRequired. Table ID of the table to delete

google-bigquery_tables_get

Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the requested table
datasetIdstringYesRequired. Dataset ID of the requested table
tableIdstringYesRequired. Table ID of the requested table
selectedFieldsstringNoList of table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed.
viewstringNoOptional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.

google-bigquery_tables_insert

Creates a new, empty table in the dataset. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the new table
datasetIdstringYesRequired. Dataset ID of the new table
biglakeConfigurationobjectNoConfiguration for BigLake managed tables.
cloneDefinitionobjectNoInformation about base table and clone time of a table clone.
clusteringobjectNoConfigures table clustering.
creationTimestringNoOutput only. The time when this table was created, in milliseconds since the epoch.
defaultCollationstringNoOptional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: * ‘und:ci’: undetermined locale, case insensitive. * ”: empty string. Default to case-sensitive behavior.
defaultRoundingModestringNoOptional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn’t affect existing fields.
descriptionstringNoOptional. A user-friendly description of this table.
encryptionConfigurationobjectNoEncryption Configuration
etagstringNoOutput only. A hash of this resource.
expirationTimestringNoOptional. The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.
externalDataConfigurationobjectNoExternal Data Configuration
friendlyNamestringNoOptional. A descriptive name for this table.
idstringNoOutput only. An opaque ID uniquely identifying the table.
kindstringNoThe type of resource ID.
labelsobjectNoThe labels associated with this table. You can use these to organize and group your tables. 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.
lastModifiedTimestringNoOutput only. The time when this table was last modified, in milliseconds since the epoch.
locationstringNoOutput only. The geographic location where the table resides. This value is inherited from the dataset.
materializedViewobjectNoDefinition and configuration of a materialized view.
materializedViewStatusobjectNoStatus of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message.
maxStalenessstringNoOptional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type.
modelobjectNoThe model value
numActiveLogicalBytesstringNoOutput only. Number of logical bytes that are less than 90 days old.
numActivePhysicalBytesstringNoOutput only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numBytesstringNoOutput only. The size of this table in logical bytes, excluding any data in the streaming buffer.
numLongTermBytesstringNoOutput only. The number of logical bytes in the table that are considered “long-term storage”.
numLongTermLogicalBytesstringNoOutput only. Number of logical bytes that are more than 90 days old.
numLongTermPhysicalBytesstringNoOutput only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numPartitionsstringNoOutput only. The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numPhysicalBytesstringNoOutput only. The physical size of this table in bytes. This includes storage used for time travel.
numRowsstringNoOutput only. The number of rows of data in this table, excluding any data in the streaming buffer.
numTimeTravelPhysicalBytesstringNoOutput only. Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numTotalLogicalBytesstringNoOutput only. Total number of logical bytes in the table or materialized view.
numTotalPhysicalBytesstringNoOutput only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
rangePartitioningobjectNoRange Partitioning
replicasobject[]NoOptional. Output only. Table references of all replicas currently active on the table.
requirePartitionFilterbooleanNoOptional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
resourceTagsobjectNo[Optional] The tags associated with this table. Tag keys are globally unique. See additional information on tags. An object containing a list of “key”: value pairs. The key is the namespaced friendly name of the tag key, e.g. “12345/environment” where 12345 is parent id. The value is the friendly short name of the tag value, e.g. “production”.
schemaobjectNoSchema of a table
selfLinkstringNoOutput only. A URL that can be used to access this resource again.
snapshotDefinitionobjectNoInformation about base table and snapshot time of the snapshot.
streamingBufferobjectNoStreaming Buffer
tableConstraintsobjectNoThe TableConstraints defines the primary key and foreign key.
tableReferenceobjectNoTable Reference
tableReplicationInfoobjectNoReplication info of a table created using AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv
timePartitioningobjectNoTime Partitioning
typestringNoOutput only. Describes the table type. The following values are supported: * TABLE: A normal BigQuery table. * VIEW: A virtual table defined by a SQL query. * EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. * MATERIALIZED_VIEW: A precomputed view defined by a SQL query. * SNAPSHOT: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on table snapshots. The default value is TABLE.
viewobjectNoDescribes the definition of a logical view.

google-bigquery_tables_list

Lists all tables in the specified dataset. Requires the READER dataset role. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the tables to list
datasetIdstringYesRequired. Dataset ID of the tables to list
maxResultsintegerNoThe maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
pageTokenstringNoPage token, returned by a previous call, to request the next page of results

google-bigquery_tables_patch

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the table to update
datasetIdstringYesRequired. Dataset ID of the table to update
tableIdstringYesRequired. Table ID of the table to update
autodetect_schemabooleanNoOptional. When true will autodetect schema, else will keep original schema
biglakeConfigurationobjectNoConfiguration for BigLake managed tables.
cloneDefinitionobjectNoInformation about base table and clone time of a table clone.
clusteringobjectNoConfigures table clustering.
creationTimestringNoOutput only. The time when this table was created, in milliseconds since the epoch.
defaultCollationstringNoOptional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: * ‘und:ci’: undetermined locale, case insensitive. * ”: empty string. Default to case-sensitive behavior.
defaultRoundingModestringNoOptional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn’t affect existing fields.
descriptionstringNoOptional. A user-friendly description of this table.
encryptionConfigurationobjectNoEncryption Configuration
etagstringNoOutput only. A hash of this resource.
expirationTimestringNoOptional. The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.
externalDataConfigurationobjectNoExternal Data Configuration
friendlyNamestringNoOptional. A descriptive name for this table.
idstringNoOutput only. An opaque ID uniquely identifying the table.
kindstringNoThe type of resource ID.
labelsobjectNoThe labels associated with this table. You can use these to organize and group your tables. 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.
lastModifiedTimestringNoOutput only. The time when this table was last modified, in milliseconds since the epoch.
locationstringNoOutput only. The geographic location where the table resides. This value is inherited from the dataset.
materializedViewobjectNoDefinition and configuration of a materialized view.
materializedViewStatusobjectNoStatus of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message.
maxStalenessstringNoOptional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type.
modelobjectNoThe model value
numActiveLogicalBytesstringNoOutput only. Number of logical bytes that are less than 90 days old.
numActivePhysicalBytesstringNoOutput only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numBytesstringNoOutput only. The size of this table in logical bytes, excluding any data in the streaming buffer.
numLongTermBytesstringNoOutput only. The number of logical bytes in the table that are considered “long-term storage”.
numLongTermLogicalBytesstringNoOutput only. Number of logical bytes that are more than 90 days old.
numLongTermPhysicalBytesstringNoOutput only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numPartitionsstringNoOutput only. The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numPhysicalBytesstringNoOutput only. The physical size of this table in bytes. This includes storage used for time travel.
numRowsstringNoOutput only. The number of rows of data in this table, excluding any data in the streaming buffer.
numTimeTravelPhysicalBytesstringNoOutput only. Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
numTotalLogicalBytesstringNoOutput only. Total number of logical bytes in the table or materialized view.
numTotalPhysicalBytesstringNoOutput only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
rangePartitioningobjectNoRange Partitioning
replicasobject[]NoOptional. Output only. Table references of all replicas currently active on the table.
requirePartitionFilterbooleanNoOptional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
resourceTagsobjectNo[Optional] The tags associated with this table. Tag keys are globally unique. See additional information on tags. An object containing a list of “key”: value pairs. The key is the namespaced friendly name of the tag key, e.g. “12345/environment” where 12345 is parent id. The value is the friendly short name of the tag value, e.g. “production”.
schemaobjectNoSchema of a table
selfLinkstringNoOutput only. A URL that can be used to access this resource again.
snapshotDefinitionobjectNoInformation about base table and snapshot time of the snapshot.
streamingBufferobjectNoStreaming Buffer
tableConstraintsobjectNoThe TableConstraints defines the primary key and foreign key.
tableReferenceobjectNoTable Reference
tableReplicationInfoobjectNoReplication info of a table created using AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv
timePartitioningobjectNoTime Partitioning
typestringNoOutput only. Describes the table type. The following values are supported: * TABLE: A normal BigQuery table. * VIEW: A virtual table defined by a SQL query. * EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. * MATERIALIZED_VIEW: A precomputed view defined by a SQL query. * SNAPSHOT: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on table snapshots. The default value is TABLE.
viewobjectNoDescribes the definition of a logical view.

google-bigquery_undelete_dataset

Undeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesRequired. Project ID of the dataset to be undeleted
datasetIdstringYesRequired. Dataset ID of dataset being deleted
deletionTimestringNoOptional. The exact time when the dataset was deleted. If not specified, it will undelete the most recently deleted version.