datasets

Creates, updates, deletes, gets or lists a datasets resource.

Overview

Name	`datasets`
Type	Resource
Id	`google.bigquery.datasets`

Fields

Name	Datatype	Description
`id`	`string`	Output 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.
`description`	`string`	Optional. A user-friendly description of the dataset.
`access`	`array`	Optional. 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; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
`creationTime`	`string`	Output only. The time when this dataset was created, in milliseconds since the epoch.
`datasetReference`	`object`	Identifier for a dataset.
`defaultCollation`	`string`	Optional. 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.
`defaultEncryptionConfiguration`	`object`	Configuration for Cloud KMS encryption settings.
`defaultPartitionExpirationMs`	`string`	This 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.
`defaultRoundingMode`	`string`	Optional. 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.
`defaultTableExpirationMs`	`string`	Optional. 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.
`etag`	`string`	Output only. A hash of the resource.
`externalCatalogDatasetOptions`	`object`	Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema or namespace represented by the current dataset.
`externalDatasetReference`	`object`	Configures the access a dataset defined in an external metadata storage.
`friendlyName`	`string`	Optional. A descriptive name for the dataset.
`isCaseInsensitive`	`boolean`	Optional. 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.
`kind`	`string`	Output only. The resource type.
`labels`	`object`	The 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.
`lastModifiedTime`	`string`	Output only. The date when this dataset was last modified, in milliseconds since the epoch.
`linkedDatasetMetadata`	`object`	Metadata about the Linked Dataset.
`linkedDatasetSource`	`object`	A dataset source type which refers to another BigQuery dataset.
`location`	`string`	The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
`maxTimeTravelHours`	`string`	Optional. 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.
`resourceTags`	`object`	Optional. The tags attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See Tag definitions for more details.
`restrictions`	`object`
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use.
`selfLink`	`string`	Output 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.
`storageBillingModel`	`string`	Optional. Updates storage_billing_model for the dataset.
`tags`	`array`	Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
`type`	`string`	Output 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.

Methods

Name	Accessible by	Required Params	Description
`get`	`SELECT`	`+datasetId, projectId`	Returns the dataset specified by datasetID.
`list`	`SELECT`	`projectId`	Lists all datasets in the specified project to which the user has been granted the READER dataset role.
`insert`	`INSERT`	`projectId`	Creates a new empty dataset.
`delete`	`DELETE`	`+datasetId, projectId`	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.
`patch`	`UPDATE`	`+datasetId, projectId`	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.
`update`	`REPLACE`	`+datasetId, projectId`	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.
`undelete`	`EXEC`	`+datasetId, projectId`	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.

`SELECT` examples

Lists all datasets in the specified project to which the user has been granted the READER dataset role.

SELECT
id,
description,
access,
creationTime,
datasetReference,
defaultCollation,
defaultEncryptionConfiguration,
defaultPartitionExpirationMs,
defaultRoundingMode,
defaultTableExpirationMs,
etag,
externalCatalogDatasetOptions,
externalDatasetReference,
friendlyName,
isCaseInsensitive,
kind,
labels,
lastModifiedTime,
linkedDatasetMetadata,
linkedDatasetSource,
location,
maxTimeTravelHours,
resourceTags,
restrictions,
satisfiesPzi,
satisfiesPzs,
selfLink,
storageBillingModel,
tags,
type
FROM google.bigquery.datasets
WHERE projectId = '{{ projectId }}';

`INSERT` example

Use the following StackQL query and manifest file to create a new datasets resource.

All Properties
Manifest

/*+ create */
INSERT INTO google.bigquery.datasets (
projectId,
access,
datasetReference,
defaultCollation,
defaultEncryptionConfiguration,
defaultPartitionExpirationMs,
defaultRoundingMode,
defaultTableExpirationMs,
description,
externalCatalogDatasetOptions,
externalDatasetReference,
friendlyName,
isCaseInsensitive,
labels,
linkedDatasetSource,
location,
maxTimeTravelHours,
resourceTags,
storageBillingModel
)
SELECT 
'{{ projectId }}',
'{{ access }}',
'{{ datasetReference }}',
'{{ defaultCollation }}',
'{{ defaultEncryptionConfiguration }}',
'{{ defaultPartitionExpirationMs }}',
'{{ defaultRoundingMode }}',
'{{ defaultTableExpirationMs }}',
'{{ description }}',
'{{ externalCatalogDatasetOptions }}',
'{{ externalDatasetReference }}',
'{{ friendlyName }}',
{{ isCaseInsensitive }},
'{{ labels }}',
'{{ linkedDatasetSource }}',
'{{ location }}',
'{{ maxTimeTravelHours }}',
'{{ resourceTags }}',
'{{ storageBillingModel }}'
;

- name: your_resource_model_name
  props:
    - name: access
      value:
        - - name: dataset
            value:
              - name: dataset
                value:
                  - name: datasetId
                    value: string
                  - name: projectId
                    value: string
              - name: targetTypes
                value:
                  - string
          - name: domain
            value: string
          - name: groupByEmail
            value: string
          - name: iamMember
            value: string
          - name: role
            value: string
          - name: routine
            value:
              - name: datasetId
                value: string
              - name: projectId
                value: string
              - name: routineId
                value: string
          - name: specialGroup
            value: string
          - name: userByEmail
            value: string
          - name: view
            value:
              - name: datasetId
                value: string
              - name: projectId
                value: string
              - name: tableId
                value: string
    - name: creationTime
      value: string
    - name: defaultCollation
      value: string
    - name: defaultEncryptionConfiguration
      value:
        - name: kmsKeyName
          value: string
    - name: defaultPartitionExpirationMs
      value: string
    - name: defaultRoundingMode
      value: string
    - name: defaultTableExpirationMs
      value: string
    - name: description
      value: string
    - name: etag
      value: string
    - name: externalCatalogDatasetOptions
      value:
        - name: defaultStorageLocationUri
          value: string
        - name: parameters
          value: object
    - name: externalDatasetReference
      value:
        - name: connection
          value: string
        - name: externalSource
          value: string
    - name: friendlyName
      value: string
    - name: id
      value: string
    - name: isCaseInsensitive
      value: boolean
    - name: kind
      value: string
    - name: labels
      value: object
    - name: lastModifiedTime
      value: string
    - name: linkedDatasetMetadata
      value:
        - name: linkState
          value: string
    - name: linkedDatasetSource
      value: []
    - name: location
      value: string
    - name: maxTimeTravelHours
      value: string
    - name: resourceTags
      value: object
    - name: restrictions
      value:
        - name: type
          value: string
    - name: satisfiesPzi
      value: boolean
    - name: satisfiesPzs
      value: boolean
    - name: selfLink
      value: string
    - name: storageBillingModel
      value: string
    - name: tags
      value:
        - - name: tagKey
            value: string
          - name: tagValue
            value: string
    - name: type
      value: string

`UPDATE` example

Updates a datasets resource.

/*+ update */
UPDATE google.bigquery.datasets
SET 
access = '{{ access }}',
datasetReference = '{{ datasetReference }}',
defaultCollation = '{{ defaultCollation }}',
defaultEncryptionConfiguration = '{{ defaultEncryptionConfiguration }}',
defaultPartitionExpirationMs = '{{ defaultPartitionExpirationMs }}',
defaultRoundingMode = '{{ defaultRoundingMode }}',
defaultTableExpirationMs = '{{ defaultTableExpirationMs }}',
description = '{{ description }}',
externalCatalogDatasetOptions = '{{ externalCatalogDatasetOptions }}',
externalDatasetReference = '{{ externalDatasetReference }}',
friendlyName = '{{ friendlyName }}',
isCaseInsensitive = true|false,
labels = '{{ labels }}',
linkedDatasetSource = '{{ linkedDatasetSource }}',
location = '{{ location }}',
maxTimeTravelHours = '{{ maxTimeTravelHours }}',
resourceTags = '{{ resourceTags }}',
storageBillingModel = '{{ storageBillingModel }}'
WHERE 
+datasetId = '{{ +datasetId }}'
AND projectId = '{{ projectId }}';

`REPLACE` example

Replaces all fields in the specified datasets resource.

/*+ update */
REPLACE google.bigquery.datasets
SET 
access = '{{ access }}',
datasetReference = '{{ datasetReference }}',
defaultCollation = '{{ defaultCollation }}',
defaultEncryptionConfiguration = '{{ defaultEncryptionConfiguration }}',
defaultPartitionExpirationMs = '{{ defaultPartitionExpirationMs }}',
defaultRoundingMode = '{{ defaultRoundingMode }}',
defaultTableExpirationMs = '{{ defaultTableExpirationMs }}',
description = '{{ description }}',
externalCatalogDatasetOptions = '{{ externalCatalogDatasetOptions }}',
externalDatasetReference = '{{ externalDatasetReference }}',
friendlyName = '{{ friendlyName }}',
isCaseInsensitive = true|false,
labels = '{{ labels }}',
linkedDatasetSource = '{{ linkedDatasetSource }}',
location = '{{ location }}',
maxTimeTravelHours = '{{ maxTimeTravelHours }}',
resourceTags = '{{ resourceTags }}',
storageBillingModel = '{{ storageBillingModel }}'
WHERE 
+datasetId = '{{ +datasetId }}'
AND projectId = '{{ projectId }}';

`DELETE` example

Deletes the specified datasets resource.

/*+ delete */
DELETE FROM google.bigquery.datasets
WHERE +datasetId = '{{ +datasetId }}'
AND projectId = '{{ projectId }}';

Overview​

Fields​

Methods​

SELECT examples​

INSERT example​

UPDATE example​

REPLACE example​

DELETE example​