> ## Documentation Index > Fetch the complete documentation index at: https://docs.maia.ai/llms.txt > Use this file to discover all available pages before exploring further. # Google BigQuery environments export const m_runner = "Maia runner"; export const Projects = () => <>the Projects icon ; export const designer = "Designer"; An environment defines the connection between a project and your chosen cloud data warehouse. Environments include useful defaults—such as a default warehouse, database, and schema—that can be used to pre-populate component configurations in {designer}. Haven't added a project yet? Read [Google BigQuery projects](/docs/guides/bigquery-projects). We recommend using environments to separate your development and production environments: * Use **development environments** for building, testing, and iterating on pipelines before they are deployed. * Use **production environments** to run pipelines that are fully deployed to work on live data. Only stable and thoroughly tested pipelines should be deployed here. * You can also use **intermediate environments**, such as `staging`, `test`, or `preprod`, to validate pipelines before they are deployed to production. These can also be used for performance testing. For more information, read our [Unlocking Data Productivity](https://www.matillion.com/whitePaper/unlocking-data-productivity-data-ops-guide) DataOps guide. *** ## Prerequisites Before adding a new environment, make sure a Google Cloud credential is configured in the project. You can then choose whether to use the project-level credential or specify an environment-level value. *** ## Add an environment This tab lists all environments in your project. Follow these steps if you've already created a [BigQuery project](/docs/guides/bigquery-projects). 1. In your project, click the **Environments** tab. 2. Click **Add environment**. The available options for adding a new environment depend on your project configuration. ## Specify GCP cloud credentials You are required to provide the following GCP cloud credentials: | Parameter | Description | | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | GCP credentials | Use the drop-down to select the credentials you set up when you created your project. | | [Use project defaults](#use-project-defaults) | Select this option to inherit the cloud credentials configured as defaults for your project. | | [Override for this environment](#override-for-this-environment) | Select this option if you want to provide new credentials for this environment only. | Click **Continue**. ### Use project defaults If you selected **Use project defaults** on the previous screen, use this section to create a new environment. #### Create an environment | Parameter | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Environment name | A unique name for the environment. Max 255 characters. | | Default environment access | Use the drop-down to select the default access for all new and existing users added to the project. For more information, read [Environment roles](/docs/administration/environment-roles). | Click **Continue**. #### Select BigQuery defaults | Parameter | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project that contains your BigQuery datasets and tables. You can find a project's ID in the Google Cloud Console on the dashboard. For more information, read the [Google Cloud documentation](https://cloud.google.com/resource-manager/docs/creating-managing-projects). | | Dataset | The BigQuery dataset for this environment connection. For more information, read the [BigQuery documentation](https://cloud.google.com/bigquery/docs/datasets-intro). | | Allow inherit project defaults | Use this toggle to manage how the environment handles variable values. When enabled (default), the environment inherits project-level default values. If disabled, you must manually provide values for each variable to ensure pipelines function successfully across environments. | Click **Finish**. You will return to the **Environments** tab in the project's menu. From here, you can view your: * [Branches](/docs/guides/branches) * [Google BigQuery environments](/docs/guides/bigquery-environments) * [Artifacts](/docs/guides/artifacts) * [Schedules](/docs/guides/schedules) * [User access](/docs/administration/project-roles) * [Secret definitions](/docs/guides/secrets-and-secret-definitions) * [Cloud credentials](/docs/guides/cloud-credentials) * [OAuths](/docs/guides/oauth) * [Networks](/docs/guides/networks) ### Override for this environment If you selected **Override for this environment** on the previous screen, use this section to select your Google BigQuery defaults. #### Select BigQuery defaults | Parameter | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project that contains your BigQuery datasets and tables. You can find a project's ID in the Google Cloud Console on the dashboard. For more information, read the [Google Cloud documentation](https://cloud.google.com/resource-manager/docs/creating-managing-projects). | | Dataset | The BigQuery dataset for this environment connection. For more information, read the [BigQuery documentation](https://cloud.google.com/bigquery/docs/datasets-intro). | | Allow inherit project defaults | Use this toggle to manage how the environment handles variable values. When enabled (default), the environment inherits project-level default values. If disabled, you must manually provide values for each variable to ensure pipelines function successfully across environments. | Click **Finish**. You will return to the **Environments** tab in the project's menu. From here, you can view your: * [Branches](/docs/guides/branches) * [Google BigQuery environments](/docs/guides/bigquery-environments) * [Artifacts](/docs/guides/artifacts) * [Schedules](/docs/guides/schedules) * [User access](/docs/administration/project-roles) * [Secret definitions](/docs/guides/secrets-and-secret-definitions) * [Cloud credentials](/docs/guides/cloud-credentials) * [OAuths](/docs/guides/oauth) * [Networks](/docs/guides/networks) ## Specify GCP cloud credentials You are required to provide the following GCP cloud credentials: | Parameter | Description | | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | GCP credentials | Use the drop-down to select the credentials you set up when you created your project. | | [Use project defaults](#use-project-defaults) | Select this option to inherit the cloud credentials configured as defaults for your project. | | [Override for this environment](#override-for-this-environment) | Select this option if you want to provide new credentials for this environment only. | Click **Continue**. ### Use project defaults If you selected **Use project defaults** on the previous screen, use this section to create a new environment. #### Create an environment | Parameter | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Environment name | A unique name for the environment. Max 255 characters. | | Default environment access | Use the drop-down to select the default access for all new and existing users added to the project. For more information, read [Environment roles](/docs/administration/environment-roles). | Click **Continue**. #### Select BigQuery defaults | Parameter | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project that contains your BigQuery datasets and tables. You can find a project's ID in the Google Cloud Console on the dashboard. For more information, read the [Google Cloud documentation](https://cloud.google.com/resource-manager/docs/creating-managing-projects). | | Dataset | The BigQuery dataset for this environment connection. For more information, read the [BigQuery documentation](https://cloud.google.com/bigquery/docs/datasets-intro). | | Allow inherit project defaults | Use this toggle to manage how the environment handles variable values. When enabled (default), the environment inherits project-level default values. If disabled, you must manually provide values for each variable to ensure pipelines function successfully across environments. | If you use a [Matillion Full SaaS](/docs/guides/runner-overview#matillion-full-saas) solution, the [cloud credentials](/docs/guides/cloud-credentials) associated with your environment will be used to access your Google Cloud resources, including BigQuery and any associated GCS buckets. To overwrite this role, [associate different cloud credentials](/docs/guides/cloud-credentials#associate-cloud-provider-credentials-with-an-environment) with this environment after you have finished creating it. You can create these credentials before or after creating the environment. Click **Finish**. You will return to the **Environments** tab in the project's menu. From here, you can view your: * [Branches](/docs/guides/branches) * [Google BigQuery environments](/docs/guides/bigquery-environments) * [Artifacts](/docs/guides/artifacts) * [Schedules](/docs/guides/schedules) * [User access](/docs/administration/project-roles) * [Secret definitions](/docs/guides/secrets-and-secret-definitions) * [Cloud credentials](/docs/guides/cloud-credentials) * [OAuths](/docs/guides/oauth) * [Networks](/docs/guides/networks) ### Override for this environment If you selected **Override for this environment** on the previous screen, use this section to create an environment. | Parameter | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Environment name | A unique name for the environment. Max 255 characters. | | Default environment access | Use the drop-down to select the default access for all new and existing users added to the project. For more information, read [Environment roles](/docs/administration/environment-roles). | | Service Account Key | Your Google Cloud service account JSON key file. | Click **Continue**. #### Select BigQuery defaults | Parameter | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project that contains your BigQuery datasets and tables. You can find a project's ID in the Google Cloud Console on the dashboard. For more information, read the [Google Cloud documentation](https://cloud.google.com/resource-manager/docs/creating-managing-projects). | | Dataset | The BigQuery dataset for this environment connection. For more information, read the [BigQuery documentation](https://cloud.google.com/bigquery/docs/datasets-intro). | | Allow inherit project defaults | Use this toggle to manage how the environment handles variable values. When enabled (default), the environment inherits project-level default values. If disabled, you must manually provide values for each variable to ensure pipelines function successfully across environments. | If you use a [Matillion Full SaaS](/docs/guides/runner-overview#matillion-full-saas) solution, the [cloud credentials](/docs/guides/cloud-credentials) associated with your environment will be used to access your Google Cloud resources, including BigQuery and any associated GCS buckets. To overwrite this role, [associate different cloud credentials](/docs/guides/cloud-credentials#associate-cloud-provider-credentials-with-an-environment) with this environment after you have finished creating it. You can create these credentials before or after creating the environment. Click **Finish**. You will return to the **Environments** tab in the project's menu. From here, you can view your: * [Branches](/docs/guides/branches) * [Google BigQuery environments](/docs/guides/bigquery-environments) * [Artifacts](/docs/guides/artifacts) * [Schedules](/docs/guides/schedules) * [User access](/docs/administration/project-roles) * [Secret definitions](/docs/guides/secrets-and-secret-definitions) * [Cloud credentials](/docs/guides/cloud-credentials) * [OAuths](/docs/guides/oauth) * [Networks](/docs/guides/networks) ## Specify GCP cloud credentials Select the following from the **Credentials** drop-down: * [Use runner-assigned credentials](#use-runner-assigned-credentials): This option does not have any Google Cloud credentials associated to your environment. Instead, [application default credentials](https://docs.cloud.google.com/docs/authentication/application-default-credentials) will be used. * [Specify custom credentials](#specify-custom-credentials): This option will allow you to specify your credentials, which will result in a Google Cloud credential being associated to your environment. Once you've chosen which Google Cloud credentials to use, click **Continue**. ### Use runner assigned credentials If you selected **Use runner assigned credentials** earlier, complete the following to create an environment. #### Create an environment | Parameter | Description | | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Environment name | A unique name for the environment. Max 255 characters. | | Runner | A working {m_runner}. This is only required if you are using a [Hybrid SaaS solution](/docs/guides/runner-overview#matillion-hosted-and-customer-hosted-agents). To learn how to create a {m_runner}, read [Create a {m_runner}](/docs/guides/create-a-runner). | | Default environment access | Use the drop-down to select the default access for all new and existing users added to the project. For more information, read [Environment roles](/docs/administration/environment-roles). | {m_runner}s can be restricted to specific projects and environments. If a {m_runner} is not allowed for your project or environment, it will not appear in the **Runner** drop-down. For more information, read [Restricting {m_runner}s](/docs/guides/restrict-a-runner). Click **Continue**. ### Select BigQuery defaults | Parameter | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project that contains your BigQuery datasets and tables. You can find a project's ID in the Google Cloud Console on the dashboard. For more information, read the [Google Cloud documentation](https://cloud.google.com/resource-manager/docs/creating-managing-projects). | | Dataset | The BigQuery dataset for this environment connection. For more information, read the [BigQuery documentation](https://cloud.google.com/bigquery/docs/datasets-intro). | | Allow inherit project defaults | Use this toggle to manage how the environment handles variable values. When enabled (default), the environment inherits project-level default values. If disabled, you must manually provide values for each variable to ensure pipelines function successfully across environments. | If you use a [Hybrid SaaS](/docs/guides/runner-overview#hybrid-saas) solution, your new environment will inherit the {m_runner}'s execution role (service account role) to access your Google Cloud resources, including BigQuery and any associated GCS buckets. To overwrite this role, [associate different cloud credentials](/docs/guides/cloud-credentials#associate-cloud-provider-credentials-with-an-environment) with this environment after you have finished creating it. You can create these credentials before or after creating the environment. Click **Finish**. You will return to the **Environments** tab in the project's menu. From here, you can view your: * [Branches](/docs/guides/branches) * [Google BigQuery environments](/docs/guides/bigquery-environments) * [Artifacts](/docs/guides/artifacts) * [Schedules](/docs/guides/schedules) * [User access](/docs/administration/project-roles) * [Secret definitions](/docs/guides/secrets-and-secret-definitions) * [Cloud credentials](/docs/guides/cloud-credentials) * [OAuths](/docs/guides/oauth) * [Networks](/docs/guides/networks) ## Specify custom credentials ### Specify GCP cloud credentials If you selected **Specify custom credentials** earlier, use this section to specify your Google Cloud credentials. | Parameter | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | Credentials | Specify custom credentials. | | GCP credentials | The credentials you set up when you created your project, or credentials you created some other time. | | Use project defaults | Select this option to inherit the cloud credentials configured as defaults for your project. | | Override for this environment | Select this option if you want to provide new credentials for this environment. | Click **Continue**. ### Use project defaults If you selected **Use project defaults** above, create an environment. #### Create an environment | Parameter | Description | | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Environment name | A unique name for the environment. Max 255 characters. | | Runner | A working {m_runner}. This is only required if you are using a [Hybrid SaaS solution](/docs/guides/runner-overview#matillion-hosted-and-customer-hosted-agents). To learn how to create a {m_runner}, read [Create a {m_runner}](/docs/guides/create-a-runner). | | Default environment access | Use the drop-down to select the default access for all new and existing users added to the project. For more information, read [Environment roles](/docs/administration/environment-roles). | {m_runner}s can be restricted to specific projects and environments. If a {m_runner} is not allowed for your project or environment, it will not appear in the **Runner** drop-down. For more information, read [Restricting {m_runner}s](/docs/guides/restrict-a-runner). Click **Continue**. #### Select BigQuery defaults | Parameter | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project that contains your BigQuery datasets and tables. You can find a project's ID in the Google Cloud Console on the dashboard. For more information, read the [Google Cloud documentation](https://cloud.google.com/resource-manager/docs/creating-managing-projects). | | Dataset | The BigQuery dataset for this environment connection. For more information, read the [BigQuery documentation](https://cloud.google.com/bigquery/docs/datasets-intro). | | Allow inherit project defaults | Use this toggle to manage how the environment handles variable values. When enabled (default), the environment inherits project-level default values. If disabled, you must manually provide values for each variable to ensure pipelines function successfully across environments. | If you use a [Hybrid SaaS](/docs/guides/runner-overview#hybrid-saas) solution, your new environment will inherit the {m_runner}'s execution role (service account role) to access your Google Cloud resources, including BigQuery and any associated GCS buckets. To overwrite this role, [associate different cloud credentials](/docs/guides/cloud-credentials#associate-cloud-provider-credentials-with-an-environment) with this environment after you have finished creating it. You can create these credentials before or after creating the environment. Click **Finish**. You will return to the **Environments** tab in the project's menu. From here, you can view your: * [Branches](/docs/guides/branches) * [Google BigQuery environments](/docs/guides/bigquery-environments) * [Artifacts](/docs/guides/artifacts) * [Schedules](/docs/guides/schedules) * [User access](/docs/administration/project-roles) * [Secret definitions](/docs/guides/secrets-and-secret-definitions) * [Cloud credentials](/docs/guides/cloud-credentials) * [OAuths](/docs/guides/oauth) * [Networks](/docs/guides/networks) ### Override for this environment If you selected **Override for this environment** above, create an environment. Click **Continue**. #### Create an environment Add the following details to override your current project environment settings: | Parameter | Description | | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Environment name | A unique name for the environment. Max 255 characters. | | Runner | A working {m_runner}. This is only required if you are using a [Hybrid SaaS](/docs/guides/runner-overview#matillion-hosted-and-customer-hosted-agents) solution. To learn how to create a {m_runner}, read [Create a {m_runner}](/docs/guides/create-a-runner). | | Default environment access | Use the drop-down to select the default access for all new and existing users added to the project. For more information, read [Environment roles](/docs/administration/environment-roles). | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project. You can find the project ID in the Google Cloud Console on the dashboard. | | Service Account Key | Your Google Cloud service account JSON key file. | Click **Continue**. #### Select BigQuery defaults | Parameter | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | GCP Project ID | The unique, user-defined string identifier for your Google Cloud project that contains your BigQuery datasets and tables. You can find a project's ID in the Google Cloud Console on the dashboard. For more information, read the [Google Cloud documentation](https://cloud.google.com/resource-manager/docs/creating-managing-projects). | | Dataset | The BigQuery dataset for this environment connection. For more information, read the [BigQuery documentation](https://cloud.google.com/bigquery/docs/datasets-intro). | | Allow inherit project defaults | Use this toggle to manage how the environment handles variable values. When enabled (default), the environment inherits project-level default values. If disabled, you must manually provide values for each variable to ensure pipelines function successfully across environments. | If you use a [Hybrid SaaS](/docs/guides/runner-overview#hybrid-saas) solution, your new environment will inherit the {m_runner}'s execution role (service account role) to access your Google Cloud resources, including BigQuery and any associated GCS buckets. To overwrite this role, [associate different cloud credentials](/docs/guides/cloud-credentials#associate-cloud-provider-credentials-with-an-environment) with this environment after you have finished creating it. You can create these credentials before or after creating the environment. Click **Finish**. You will return to the **Environments** tab in the project's menu. From here, you can view your: * [Branches](/docs/guides/branches) * [Google BigQuery environments](/docs/guides/bigquery-environments) * [Artifacts](/docs/guides/artifacts) * [Schedules](/docs/guides/schedules) * [User access](/docs/administration/project-roles) * [Secret definitions](/docs/guides/secrets-and-secret-definitions) * [Cloud credentials](/docs/guides/cloud-credentials) * [OAuths](/docs/guides/oauth) * [Networks](/docs/guides/networks) *** ## Associate cloud provider credentials with an environment Each environment in your project should have at least one set of cloud credentials associated with it. This allows you to access account resources on different platforms other than that hosting your project. For example, if your project is on AWS and you want to access resources in Azure, you need to associate your Azure cloud credentials with the environment. Credentials are configured at the project level and apply to selected environments within the project. They can then be used by any pipelines that use those environments. To create and associate cloud credentials, read [Cloud provider credentials](/docs/guides/cloud-credentials#creating-a-cloud-provider-credential). ### Edit or remove an associated credential Edit or remove which credential is in use by your environment: * **Hybrid SaaS:** Removing the credential causes the environment to fall back to runner-assigned credentials. * **Full SaaS:** Removing the credential leaves the environment unusable, because Full SaaS environments require an explicitly associated credential. *** ## Manage environments To view your environments: 1. From the **Your projects** menu, select your project. 2. Navigate to the **Environments** tab. Click the column headers to sort your environments by name, default {m_runner}, cloud data warehouse account name, or credential type. ### Edit an environment The edit environment screen only allows you to edit default values for your Google Cloud project and dataset. 1. Click the three dots **...** in the row of the environment you want to edit. 2. Click **Edit environment**. 3. On the **Edit Google BigQuery credentials**, use the **Runner** drop-down to choose a different runner for your environment. 4. Use the **Default environment access** drop-down to choose a different default role for your environment. For more information, read [Environment roles](/docs/administration/environment-roles). 5. Click **Continue** to move to the next screen, where you can use the drop-down menus to update your BigQuery defaults. 6. Click **Update** to return to the **Environments** tab in your project. If you disable the **Allow inherit project defaults** toggle on the BigQuery defaults screen, the environment will not inherit project-level defaults. You must manually provide a default value for each variable within the environment to ensure pipelines function successfully across different environments. To edit the **Associate credentials** of your environment, you can edit or remove which credential is being used by your environment. For Hybrid SaaS deployments, removing a credential effectively means to use **Use runner-assigned** credentials. For a Full SaaS deployment, removing credentials will result in your environment being unusable. ### Delete an environment Deleting an environment permanently removes the environment from your project. All artifacts and schedules in the deleted environment will be inaccessible. This action cannot be undone. Before you delete an environment, you must: * Disable any active schedules that run pipelines in this environment. * Change the default environment of any branches that currently use this environment as their default. For more information, read [Branches](/docs/guides/branches). To delete an environment: 1. Click the three dots **...** in the row of the environment you want to delete. 2. Click **Delete environment**. 3. In the confirmation dialog, enter the name of the environment you want to delete. 4. Click **Delete environment**.