Manage BigQuery API dependencies
This document describes the Google Cloud services and APIs that BigQuery depends on. It also explains the effects on BigQuery behavior when you disable those services. Review this document before you enable or disable services in your project.
Some services are enabled by default in every Google Cloud project that you create. Other APIs are automatically enabled for all Google Cloud projects that use BigQuery. The remaining services must be explicitly enabled before you can use their functionality. For more information, see the following resources:
This document is intended for administrators.
Services enabled by default
The following services are enabled by default for every new Google Cloud project:
analyticshub.googleapis.com
- You can't create or manage data exchanges, listings, data clean rooms, or subscriptions.
- You can't search and explore exchanges or listings that other providers create.
- Created subscriptions persist but aren't accessible.
- Linked datasets are accessible as long as the BigQuery API is enabled.
- You can't create new subscriptions
bigqueryconnection.googleapis.com
- Federated queries to data stored outside of BigQuery
- External tables and datasets
- BigQuery metastore
- You can't manage external connections.
- You can't create remote models.
- You can't create remote functions.
- You can't query BigLake tables and object tables.
bigquerymigration.googleapis.com
- You can't create migration tasks or assessments.
- Existing tasks or assessments aren't available.
Note: Usually you can disable this service after completing data migration.
bigquerydatapolicy.googleapis.com
- You can't manage your data masking policies.
- Data masking policies aren't deleted, but queries to tables with data masking applied fail.
bigqueryreservation.googleapis.com
- You can't create or manage capacity commitments, reservations, or assignments.
- You can't monitor slot usage.
- Disaster recovery failover isn't available.
- Slot autoscaling stops.
bigquerystorage.googleapis.com
- You can't use the Storage Read API or the Storage Write API to access your BigQuery data.
dataform.googleapis.com
- Dataform provides code repositories that are leveraged by the following features:
- You can't create pipelines, saved queries, Colab notebooks, data canvases, data preparations, or Dataform projects.
- Existing scheduled pipelines, notebooks, or Dataform projects stop.
- Any existing pipelines, saved queries, Colab notebooks, data canvases, data preparations, or Dataform projects become inaccessible.
dataplex.googleapis.com
- Dataplex Universal Catalog provides data cataloging and governance
capabilities that are used by the following:
- Resource Explorer in BigQuery Studio
- Autocomplete in BigQuery Studio SQL editor
- BigQuery sharing (formerly Analytics Hub) search for listings
- Profile insights
- Data quality scans
- Data lineage viewing
- Table and dataset insights
- Data canvas
- BigQuery data asset search is unavailable.
- Sharing listing search is unavailable.
- You can't create new or access previously created profile insights, data quality scans, or query suggestions.
- You can't see data asset details on a lineage graph.
- You can't search for data assets in data canvas.
Effect of disabling the BigQuery API
Disabling the BigQuery API also disables the following services which are dependent upon BigQuery API:
- binaryauthorization.googleapis.com
- container.googleapis.com
- cloudapis.googleapis.com
- dataprep.googleapis.com
- servicebroker.googleapis.com
- telecomdatafabric.googleapis.com
Services enabled by BigQuery Unified API
The BigQuery Unified API ( bigqueryunified.googleapis.com
)
includes a curated collection of services that are required for various
BigQuery features to function. If you enable the
BigQuery Unified API, then all of these services are activated
simultaneously. Google can update the services in this collection, and those
services are automatically enabled in projects with this API enabled.
You can disable individual services and APIs.
For instructions on enabling bigqueryunified.googleapis.com
, see Enabling and disabling services
.
aiplatform.googleapis.com
- You won't be able to run your notebooks.
- Any existing BigQuery ML remote models stop working.
- Your existing notebooks remain accessible for editing.
bigqueryunified.googleapis.com
- Provides a single-click activation of the BigQuery dependent services listed in this document, excluding the cloudaicompanion, composerand datalineageAPIs.
- Ensures new BigQuery dependencies are enabled in your project.
- Future dependencies aren't automatically enabled in your project.
compute.googleapis.com
- Google Compute Engine provides a runtime environment for all features provided by Dataproc and Vertex AI.
- Colab notebooks, remote ML models, Apache Spark, SparkSQL, and PySpark jobs stop.
- Source code remains available.
- Dataproc API gets disabled.
dataproc.googleapis.com
- You can't create Dataproc clusters to run open source data analytics.
- You can't run Dataproc Serverless workloads.
- You can't run Spark in BigQuery workloads.
datastream.googleapis.com
- All data streams are paused and aren't accessible.
Services disabled by default
You must manually enable the following services for the corresponding capabilities to become available:
cloudaicompanion.googleapis.com
- Gemini in BigQuery features
-
Code completion, generation, and explanation features stop working.
Learn more about turning off Gemini in BigQuery .
composer.googleapis.com
- Existing Cloud Composer DAGs aren't listed on the Scheduling page and stop.
- Existing Cloud Composer environments become inoperative, stop working, and return an error state.
datalineage.googleapis.com
- Data lineage capture and viewing
- Data lineage isn't captured for your project.
- You can't view the lineage graph.
Manually enable BigQuery code assets
To manage code assets in BigQuery, such as notebooks and saved queries, you must enable the following APIs:
- The Compute Engine API
- The Dataform API
- The Vertex AI API
Before March 2024, these APIs were not automatically enabled by default. If you have automation scripts from before March 2024 that depended on the status of these APIs, then you might need to update them. If you already have these APIs enabled, then you will see new Notebooksand Queriesfolders in the Explorerpane in BigQuery.
Before you begin
To manually enable code asset management,
you must have the Identity and Access Management (IAM) Owner ( roles/owner
) role
.
Manually enable BigQuery code assets
To enable required API dependencies for code assets, follow these steps:
-
Go to the BigQuerypage.
-
On the Studio, in the tab bar of the editor pane, click the arrow drop-down next to the +sign, hold the pointer over Notebook, and then select BigQuery template.
-
In the banner that appears under the tab bar of the editor pane, click Enable.
If you don't see the banner, check if you have the required IAM Owner role.
-
In the Enable featurespane, in the Core feature APIssection, do the following:
- To enable version history and sharing of code assets, in the Version history and sharingsection, click Enable.
- To enable notebooks, under Python notebooks, click Enable all.
- When the APIs are enabled, click Next.
-
Optional: Set user permissions in the Permissionssection:
- To grant principals the ability to create code assets, and to read, edit, and set permissions for the code assets they created, type their user or group names in the Creatorfield.
- To grant principals the ability to read, edit, and set permissions for all code assets shared with them, type their user or group names in the Ownerfield.
-
Click Next.
-
Optional: In the Additional APIssection, click Enable allto enable the APIs that you need to create BigQuery remote procedures by using BigQuery DataFrames .
-
If you chose not to enable the additional APIs, click Closeto close the Enable featurespane.
Restrict access to code assets
You can help prevent enablement of additional APIs by setting the Restrict Resource Service Usage organization policy constraint . You can turn off selected APIs at any time.
What's next?
- To learn how to manage Google Cloud services, see Enabling and disabling services .
- To learn how to manage API access at a granular level with organization policy constraints, see Restricting resource usage .
- To learn how to control access to services with Identity and Access Management (IAM) roles and permissions for BigQuery, see BigQuery IAM roles and permissions .