testbed/googleapis__python-bigquery/docs/usage/datasets.rst

Managing Datasets
~~~~~~~~~~~~~~~~~

A dataset represents a collection of tables, and applies several default
policies to tables as they are created:

- An access control list (ACL).  When created, a dataset has an ACL
  which maps to the ACL inherited from its project.

- A default table expiration period.  If set, tables created within the
  dataset will have the value as their expiration period.

See BigQuery documentation for more information on
`Datasets <https://cloud.google.com/bigquery/docs/datasets>`_.

Listing Datasets
^^^^^^^^^^^^^^^^

List datasets for a project with the
:func:`~google.cloud.bigquery.client.Client.list_datasets` method:

.. literalinclude:: ../samples/list_datasets.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_list_datasets]
   :end-before: [END bigquery_list_datasets]

List datasets by label for a project with the
:func:`~google.cloud.bigquery.client.Client.list_datasets` method:

.. literalinclude:: ../samples/list_datasets_by_label.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_list_datasets_by_label]
   :end-before: [END bigquery_list_datasets_by_label]

Getting a Dataset
^^^^^^^^^^^^^^^^^

Get a dataset resource (to pick up changes made by another client) with the
:func:`~google.cloud.bigquery.client.Client.get_dataset` method:

.. literalinclude:: ../samples/get_dataset.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_get_dataset]
   :end-before: [END bigquery_get_dataset]

Determine if a dataset exists with the
:func:`~google.cloud.bigquery.client.Client.get_dataset` method:

.. literalinclude:: ../samples/dataset_exists.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_dataset_exists]
   :end-before: [END bigquery_dataset_exists]

Creating a Dataset
^^^^^^^^^^^^^^^^^^

Create a new dataset with the
:func:`~google.cloud.bigquery.client.Client.create_dataset` method:

.. literalinclude:: ../samples/create_dataset.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_create_dataset]
   :end-before: [END bigquery_create_dataset]

Updating a Dataset
^^^^^^^^^^^^^^^^^^

Update a property in a dataset's metadata with the
:func:`~google.cloud.bigquery.client.Client.update_dataset` method:

.. literalinclude:: ../samples/update_dataset_description.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_update_dataset_description]
   :end-before: [END bigquery_update_dataset_description]

Modify user permissions on a dataset with the
:func:`~google.cloud.bigquery.client.Client.update_dataset` method:

.. literalinclude:: ../samples/update_dataset_access.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_update_dataset_access]
   :end-before: [END bigquery_update_dataset_access]

Manage Dataset labels
^^^^^^^^^^^^^^^^^^^^^

Add labels to a dataset with the
:func:`~google.cloud.bigquery.client.Client.update_dataset` method:

.. literalinclude:: ../samples/label_dataset.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_label_dataset]
   :end-before: [END bigquery_label_dataset]

Get dataset's labels with the
:func:`~google.cloud.bigquery.client.Client.get_dataset` method:

.. literalinclude:: ../samples/get_dataset_labels.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_get_dataset_labels]
   :end-before: [END bigquery_get_dataset_labels]
   
Delete dataset's labels with the
:func:`~google.cloud.bigquery.client.Client.update_dataset` method:

.. literalinclude:: ../samples/delete_dataset_labels.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_delete_label_dataset]
   :end-before: [END bigquery_delete_label_dataset]

Deleting a Dataset
^^^^^^^^^^^^^^^^^^

Delete a dataset with the
:func:`~google.cloud.bigquery.client.Client.delete_dataset` method:

.. literalinclude:: ../samples/delete_dataset.py
   :language: python
   :dedent: 4
   :start-after: [START bigquery_delete_dataset]
   :end-before: [END bigquery_delete_dataset]