Registry / gcp / google-cloud-datacatalog

google-cloud-datacatalog

library3.31.0pypypi✓ verified 24d ago

Google Cloud Data Catalog is a fully managed, highly scalable data discovery and metadata management service. It allows users to discover, manage, and understand data assets across Google Cloud, supporting technical and business metadata. The Python client library, currently at version 3.30.0, provides programmatic access to the Data Catalog API and follows a regular release cadence as part of the broader `google-cloud-python` client libraries.

gcp data

pip install google-cloud-datacatalog

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · GOOGLE-CLOUD-DATAC

google-cloud-datacatalog

gcppythonv3.31.0

Install

5.7s avg

Import

1669ms

Disk

72MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v3.31.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 2.018s · 73.2MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.7s · import 1.320s · 71MB

72MB installed

● package 72MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

DataCatalogClient

✓ from google.cloud.datacatalog_v1 import DataCatalogClient

types

✓ from google.cloud.datacatalog_v1 import types

Contains protobuf message definitions like Entry, Tag, TagTemplate

Initializes the DataCatalogClient and attempts to list existing entry groups within a specified Google Cloud project and location. This example assumes default authentication (e.g., via `GOOGLE_APPLICATION_CREDENTIALS` environment variable or Google Cloud SDK).

import os from google.cloud.datacatalog_v1 import DataCatalogClient # Set your Google Cloud project ID (e.g., from GOOGLE_CLOUD_PROJECT_ID env var) # or specify it directly. project_id = os.environ.get('GOOGLE_CLOUD_PROJECT', 'your-gcp-project-id') # Create a client try: client = DataCatalogClient() print(f"Data Catalog client created successfully for project: {project_id}") # Example: List entry groups (pagination handled automatically) parent = f"projects/{project_id}/locations/us-central1" print(f"Listing entry groups in {parent}...") for entry_group in client.list_entry_groups(parent=parent): print(f" Entry Group: {entry_group.name}") print("Quickstart finished. Note: Data Catalog is migrating to Dataplex Universal Catalog.") except Exception as e: print(f"An error occurred: {e}") print("Please ensure the Data Catalog API is enabled and authentication is set up.") print("e.g., export GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json")

Debug

Known issues

breakingGoogle Cloud Data Catalog is deprecated in favor of Dataplex Universal Catalog. While the Data Catalog API and client library still function, new development should leverage Dataplex's comprehensive data management capabilities.

fix

Migrate to Google Cloud Dataplex Universal Catalog for metadata management. Review Dataplex documentation for equivalent functionalities and migration guides. `pip install google-cloud-dataplex`.

affects: All versions, as this is a product-level deprecation.

gotchaThe `google-cloud-datacatalog` client library logs RPC events using Python's standard logging, but logs may contain sensitive information and are not propagated to the root logger by default. You must configure logging explicitly.

fix

To enable logging without code changes, set `GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.datacatalog` (or a broader scope like `google`) in your environment. For code-based configuration, ensure `logging.getLogger("google").propagate = True` if you need events to reach the root logger.

affects: All versions

gotchaPython 3.9 and older versions are past their end of life or no longer fully supported. While client libraries may still function, Google will not post further updates supporting Python 3.9, and critical bug fixes will be on a best-effort basis. It is recommended to upgrade to Python 3.10 or higher for full support and features.

fix

Upgrade your Python environment to version 3.10 or higher. Re-install the library within a compatible virtual environment to ensure full support and receive future updates.

affects: < 3.10 (including 3.9)

gotchaThe client library failed to authenticate, indicating that Application Default Credentials (ADC) were not found or the Data Catalog API was not enabled for the project. Users must ensure ADC are properly configured and the Data Catalog API is enabled.

fix

Configure Application Default Credentials (ADC) by following instructions at https://cloud.google.com/docs/authentication/external/set-up-adc. Additionally, ensure the Data Catalog API is enabled for your Google Cloud project via the Cloud Console or by running `gcloud services enable datacatalog.googleapis.com`.

affects: All versions

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'google.cloud.datacatalog'

The `google-cloud-datacatalog` library is not installed in the Python environment, or there's a conflict with other `google-cloud` libraries.

fix

Install the library using pip: `pip install google-cloud-datacatalog` or, if in a specific environment, `python -m pip install google-cloud-datacatalog`. Ensure your virtual environment is activated if you are using one.

AttributeError: module 'google.cloud.datacatalog_v1' has no attribute 'GetIamPolicyRequest'

This error typically occurs when the client library version used is incompatible with the API methods or types being called, often due to outdated sample code or an older library version lacking the specific attribute.

fix

Upgrade the `google-cloud-datacatalog` library to the latest version: `pip install --upgrade google-cloud-datacatalog`. Additionally, cross-reference your code with the official client library documentation for the correct usage of methods and types for your installed version.

Error: 5 NOT_FOUND: Project "your-project-id" does not exist

This error often indicates that the specified Google Cloud project ID is incorrect, or the Data Catalog API is not enabled for that project, or the service account lacks permission to view the project or its resources.

fix

Verify that the `project_id` used in your code is correct. Ensure the Data Catalog API is enabled for your project in the Google Cloud Console (APIs & Services > Library). Also, confirm that the service account or user running the code has the necessary IAM permissions (e.g., `datacatalog.viewer` or `datacatalog.admin`) on the specified project.

google.api_core.exceptions.PermissionDenied: 403 The caller does not have permission

The service account or user credentials used to authenticate the Data Catalog client lack the necessary Identity and Access Management (IAM) permissions to perform the requested operation on the specified resource.

fix

Grant the appropriate IAM role(s) to the service account or user. For common operations, roles like `Data Catalog Viewer` (`roles/datacatalog.viewer`), `Data Catalog Editor` (`roles/datacatalog.editor`), or more granular custom roles may be needed. Use the IAM console or `gcloud iam` commands to assign these roles to the principal accessing Data Catalog.

Upgrade

Version history

3.31.0latest on PyPI · released Jun 3, 2026

Audit

Dependencies

google-api-corerequiredCore library for Google Cloud API clients

google-authrequiredAuthentication and authorization for Google APIs

proto-plusrequiredPythonic wrappers for Protocol Buffers

protobufrequiredProtocol Buffers message serialization library

Agent activity

19 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/googleapis/google-cloud-python ↗

packagehttps://pypi.org/project/google-cloud-datacatalog/ ↗

homepagehttps://cloud.google.com/data-catalog ↗