> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/concepts/resources/depot/supported-sources/bigquery.md).

# Google BigQuery

To create a BigQuery Depot you must have the following details:

## Pre-requisites specific to DataOS

You must have the Data Admin role to create a Depot. To get the Data Admin role, contact the DataOS Operator or the Tenant Admin.

Run the command below to check your assigned roles.

```bash
dataos-ctl user get
#Expected Output: 
time="2026-03-30T17:49:18+05:30" level=info msg="😃 user get..."
time="2026-03-30T17:49:19+05:30" level=info msg="😃 user get...complete"

     NAME     │        ID         │  TYPE  │        EMAIL         │                  TAGS
──────────────┼───────────────────┼────────┼──────────────────────┼────────────────────────────────────────
 I Am Groot   │ iamgroottmdcio    │ person │ iam.groot@tmdc.io    │ roles:id:ct-onboarding-data-developer,
              │                   │        │                      │ roles:id:data-dev,
              │                   │        │                      │ roles:id:system-dev,
              │                   │        │                      │ roles:id:user,
              │                   │        │                      │ users:id:iamgroottmdcio

```

## Pre-requisites specific to the source system

* **Project ID**: The unique identifier for your Google Cloud project used by BigQuery. You can find this in the Google Cloud Console under "Project Info" on your project dashboard.
* **Email ID**: The email address associated with the Google Cloud service account used to access BigQuery. This can be found in the IAM & Admin section of the Google Cloud Console under the "Service Accounts" tab, where the email is listed for each service account.
* **Credential Properties in JSON File**: A JSON file containing the necessary credential properties for authentication. This file is generated when you create a service account in Google Cloud. You can download it from the IAM & Admin > Service Accounts section in the Google Cloud Console by selecting a service account and clicking "Add Key" > "JSON".
* **Additional Parameters**: Any extra configuration parameters required to establish the connection, such as project settings or specific access scopes. These may be provided by the administrator or defined in the BigQuery API documentation based on the integration you are working with.

## Create a BigQuery Depot

A Depot of type `bigquery` reads data from Google BigQuery datasets and tables. The Depot exposes BigQuery projects under DataOS governance for queries and downstream consumption. To create a BigQuery Depot, follow these steps:

### **Step 1: Create a Secret for securing BigQuery credentials**

Begin by creating a Secret Resource by following the [BigQuery](/concepts/resources/secret/data-sources/bigquery.md) guide.

### **Step 2: Create a BigQuery Depot manifest file**

Create a manifest file with the configuration details for your BigQuery Depot.

{% tabs %}
{% tab title="Manifest file" %}

```yaml
name: ${{bigquery-name}}
version: v2alpha
type: depot
tags:
  - BigQuery
  - depot
  - warehouse
description: "BigQuery data warehouse depot for data storage and analytics"
spec:
  type: bigquery
  spec:
    project: "${{bigquery-project-name}}"
  secrets:
    - id: "${{tenant-id}}:${{bigquery-secret-name}}"
      purpose: scan
    - id: "${{tenant-id}}:${{bigquery-secret-name}}"
      purpose: rw
    - id: "${{tenant-id}}:${{bigquery-secret-name}}"
      purpose: query
```

{% endtab %}

{% tab title="Example" %}

```yaml
name: ${{bigquery-name}}
version: v2alpha
type: depot
tags:
  - BigQuery
  - depot
  - warehouse
description: "BigQuery data warehouse depot for data storage and analytics"
spec:
  type: bigquery
  spec:
    project: "${{bigquery-project-name}}"
  secrets:
    - id: "${{tenant-id}}:${{bigquery-secret-name}}"
      purpose: scan
    - id: "${{tenant-id}}:${{bigquery-secret-name}}"
      purpose: rw
    - id: "${{tenant-id}}:${{bigquery-secret-name}}"
      purpose: query
```

{% endtab %}
{% endtabs %}

### **Step 3: Apply the Depot manifest file**

Apply the manifest through the DataOS CLI:

```bash
dataos-ctl resource apply -f ${{manifest-file-path}}
```

## Verify the Depot creation

Verify the Depot in two ways:

* Check the name of the newly created Depot in the list of Depots you own:

  ```bash
  dataos-ctl resource get -t depot
  ```
* List all Depots created in the current Tenant:

  ```bash
  dataos-ctl resource get -t depot -a
  ```

## Delete a Depot

{% hint style="warning" %}
Best practice: Delete Resources that are no longer in use to save time and reduce costs.
{% endhint %}

To delete a Depot, run the following command in the DataOS CLI:

{% tabs %}
{% tab title="Command 1" %}

```bash
dataos-ctl resource delete -t depot -n ${{name}}
```

{% endtab %}

{% tab title="Command 2 " %}

```bash
dataos-ctl resource delete -i "${{resource-name}}|v2alpha|depot"
```

{% endtab %}

{% tab title="Command 3" %}

```bash
dataos-ctl resource delete -f ${{manifest-file-path}}
```

{% endtab %}
{% endtabs %}

Specify the Resource type and Depot name in the `delete` command.

**Example Usage:**

{% tabs %}
{% tab title="Command 1" %}

```bash
dataos-ctl resource delete -t depot -n testdepot
#output
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}

{% tab title="Command 2" %}

```bash
dataos-ctl resource delete -i "testdepot|v2alpha|depot"
#output
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:55:37+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}

{% tab title="Command 3" %}

```bash
dataos-ctl resource delete -f /path/to/depot.yaml
#output
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 delete..."
time="2026-03-25T15:53:55+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot..."
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 deleting testdepot:v2alpha:depot...deleted"
time="2026-03-25T15:53:56+05:30" level=info msg="🗑 delete...complete"
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://v2.dataos.info/concepts/resources/depot/supported-sources/bigquery.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.