GSP814

Overview

Data Catalog is a fully managed and scalable metadata management service that empowers organizations to quickly discover, understand, and manage all their data.

It offers a simple and easy-to-use search interface for data discovery, a flexible and powerful cataloging system for capturing both technical and business metadata, and a strong security and compliance foundation with Cloud Data Loss Prevention (DLP) and Cloud Identity and Access Management (IAM) integrations.

Using Data Catalog

There are two main ways you interact with Data Catalog:

• Searching for data assets that you have access to.

• Tagging assets with metadata.

What you will learn

In this lab, you will learn how to:

• Enable the Data Catalog API so that you can use this service in your Google Cloud project.

• Execute SQLServer to Data Catalog connector.

• Execute PostgreSQL to Data Catalog connector.

• Execute MySQL to Data Catalog connector.

Prerequisites

Very Important: Before starting this lab, log out of your personal or corporate gmail account, or run this lab in Incognito. This prevents sign-in confusion while the lab is running.

Setup and requirements

Before you click the Start Lab button

Read these instructions. Labs are timed and you cannot pause them. The timer, which starts when you click Start Lab, shows how long Google Cloud resources will be made available to you.

This Qwiklabs hands-on lab lets you do the lab activities yourself in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials that you use to sign in and access Google Cloud for the duration of the lab.

What you need

To complete this lab, you need:

• Access to a standard internet browser (Chrome browser recommended).
• Time to complete the lab.

Note: If you already have your own personal Google Cloud account or project, do not use it for this lab.

Note: If you are using a Pixelbook, open an Incognito window to run this lab.

How to start your lab and sign in to the Google Cloud Console

1. Click the Start Lab button. If you need to pay for the lab, a pop-up opens for you to select your payment method. On the left is a panel populated with the temporary credentials that you must use for this lab.

   

2. Copy the username, and then click Open Google Console. The lab spins up resources, and then opens another tab that shows the Sign in page.

   

   Tip: Open the tabs in separate windows, side-by-side.

3. In the Sign in page, paste the username that you copied from the Connection Details panel. Then copy and paste the password.

   Important: You must use the credentials from the Connection Details panel. Do not use your Qwiklabs credentials. If you have your own Google Cloud account, do not use it for this lab (avoids incurring charges).

4. Click through the subsequent pages:

   • Accept the terms and conditions.
   • Do not add recovery options or two-factor authentication (because this is a temporary account).
   • Do not sign up for free trials.

After a few moments, the Cloud Console opens in this tab.

Activate Cloud Shell

Cloud Shell is a virtual machine that is loaded with development tools. It offers a persistent 5GB home directory and runs on the Google Cloud. Cloud Shell provides command-line access to your Google Cloud resources.

In the Cloud Console, in the top right toolbar, click the Activate Cloud Shell button.

Click Continue.

It takes a few moments to provision and connect to the environment. When you are connected, you are already authenticated, and the project is set to your PROJECT_ID. For example:

gcloud is the command-line tool for Google Cloud. It comes pre-installed on Cloud Shell and supports tab-completion.

You can list the active account name with this command:

gcloud auth list
content_copy

(Output)

Credentialed accounts:
 - <myaccount>@<mydomain>.com (active)content_copy

(Example output)

Credentialed accounts:
 - google1623327_student@qwiklabs.netcontent_copy

You can list the project ID with this command:

gcloud config list project
content_copy

(Output)

[core]
project = <project_ID>content_copy

(Example output)

[core]
project = qwiklabs-gcp-44776a13dea667a6content_copy

Enable the Data Catalog API

Open the Navigation menu and select APIs and Services > Library.

In the search bar, enter in "Data Catalog" and select the Google Cloud Data Catalog API.

Then click Enable.

If you run into the following error after trying to enable the Data Catalog API:

Click Close and refresh your browser tab. Then click Enable again. The Data Catalog API should be successfully enabled:

SQLServer to Data Catalog

Start by setting up your environment. Run the following command to set your Project ID, replacing <YOUR_PROJECT_ID> with the Project ID found in the connection details panel:

gcloud config set project <YOUR_PROJECT_ID>
content_copy

Next set it as an environment variable:

export PROJECT_ID=$(gcloud config get-value project)
content_copy

Create the SQLServer Database

You can use the open source scripts at Cloud SQL SQLServer Tooling to create and populate your SQLServer instance.

In your Cloud Shell session, run the following command to clone the required repository:

git clone https://github.com/mesmacosta/cloudsql-sqlserver-tooling
content_copy

Now change your current working directory to the cloned repo directory:

cd cloudsql-sqlserver-tooling
content_copy

Now run the the init-db.sh script.

source init-db.sh
content_copy

This will create your SQLServer instance and populate it with random schema.

This will take around five minutes to complete. You can move on when you receive the following output:

CREATE TABLE factory_warehouse15797.employees53b82dc5 ( school80581 REAL, reason91250 DATETIME, randomdata32431 BINARY, phone_number52754 REAL, person66471 REAL, credit_card75527 DATETIME )

COMPLETEDcontent_copy

Set Up the Service Account

Run the following command to create a Service Account:

gcloud iam service-accounts create sqlserver2dc-credentials \
--display-name  "Service Account for SQLServer to Data Catalog connector" \
--project $PROJECT_ID
content_copy

Now create and download the Service Account Key.

gcloud iam service-accounts keys create "sqlserver2dc-credentials.json" \
--iam-account "sqlserver2dc-credentials@$PROJECT_ID.iam.gserviceaccount.com"
content_copy

Add the Data Catalog admin role to the Service Account:

gcloud projects add-iam-policy-binding $PROJECT_ID \
--member "serviceAccount:sqlserver2dc-credentials@$PROJECT_ID.iam.gserviceaccount.com" \
--quiet \
--project $PROJECT_ID \
--role "roles/datacatalog.admin"
content_copy

Execute SQLServer to Data Catalog connector.

You can build the SQLServer connector yourself by going to this GitHub repository.

To facilitate its usage, we are going to use a docker image. The environment variables were loaded by the init-db.sh script.

Run the following command to execute the connector:

docker run --rm --tty -v \
"$PWD":/data mesmacosta/sqlserver2datacatalog:stable \
--datacatalog-project-id=$PROJECT_ID \
--datacatalog-location-id=us-central1 \
--sqlserver-host=$public_ip_address \
--sqlserver-user=$username \
--sqlserver-pass=$password \
--sqlserver-database=$database
content_copy

Soon after you should receive the following output:

============End sqlserver-to-datacatalog============content_copy

Search for the SQLServer Entries in Data Catalog

After the script finishes, open the navigation menu and select Data Catalog from the list of services.

In the search bar, enter sqlserver. You should see the following Tag Templates and Entry Group appear in the results:

Now click on the sqlserver Entry Group. Your console should resemble the following:

This is the real value of an Entry Group—you can see all entries that belong to sqlserver using the UI.

Click on one of the warehouse entries. Look at the Custom entry details and tags:

Custom entry details and Tags:

This is the real value the connector adds — it allows you to have the metadata searchable in Data Catalog.

Cleaning up

To delete the created resources, run the following command to delete the SQLServer metadata:

./cleanup-db.sh
content_copy

Now execute the cleaner container:

docker run --rm --tty -v \
"$PWD":/data mesmacosta/sqlserver-datacatalog-cleaner:stable \
--datacatalog-project-ids=$PROJECT_ID \
--rdbms-type=sqlserver \
--table-container-type=schema
content_copy

Now run the following command to delete the SQLServer database:

./delete-db.sh
content_copy

From the Navigation menu click Data Catalog. Search for sqlserver. You will no longer see the SQLServer Tag Templates in the results:

Ensure you see the following output in Cloud Shell before you move on:

 Cloud SQL Instance deleted
 COMPLETEDcontent_copy

You will now learn how to do the same thing with a PostgreSQL instance.

PostgreSQL to Data Catalog

Create the PostgreSQL Database

You can use the open source scripts at Cloud SQL PostgreSQL Tooling to create and populate your PostgreSQL instance.

Run the following command in Cloud Shell to return to your home directory:

cd
content_copy

Run the following command to clone the Github repository:

git clone https://github.com/mesmacosta/cloudsql-postgresql-tooling
content_copy

Now change your current working directory to the cloned repo directory:

cd cloudsql-postgresql-tooling
content_copy

Now execute the init-db.sh script:

source init-db.sh
content_copy

This will create your PostgreSQL instance and populate it with random schema. Soon after you should receive the following output:

CREATE TABLE factory_warehouse69945.home17e97c57 ( house57588 DATE, paragraph64180 SMALLINT, ip_address61569 JSONB, date_time44962 REAL, food19478 JSONB, state8925 VARCHAR(25), cpf75444 REAL, date_time96090 SMALLINT, reason7955 CHAR(5), phone_number96292 INT, size97593 DATE, date_time609 CHAR(5), location70431 DATE )
 COMPLETEDcontent_copy

Set Up the Service Account

Create a Service Account.

gcloud iam service-accounts create postgresql2dc-credentials \
--display-name  "Service Account for PostgreSQL to Data Catalog connector" \
--project $PROJECT_ID
content_copy

Next create and download the Service Account Key.

gcloud iam service-accounts keys create "postgresql2dc-credentials.json" \
--iam-account "postgresql2dc-credentials@$PROJECT_ID.iam.gserviceaccount.com"
content_copy

Next add Data Catalog admin role to the Service Account.

gcloud projects add-iam-policy-binding $PROJECT_ID \
--member "serviceAccount:postgresql2dc-credentials@$PROJECT_ID.iam.gserviceaccount.com" \
--quiet \
--project $PROJECT_ID \
--role "roles/datacatalog.admin"
content_copy

Execute PostgreSQL to Data Catalog connector

You can build the PostgreSQL connector yourself by going to this GitHub repository.

To facilitate its usage, we are going to use a docker image. The environment variables were loaded by the init-db.sh script.

Execute the connector:

docker run --rm --tty -v \
"$PWD":/data mesmacosta/postgresql2datacatalog:stable \
--datacatalog-project-id=$PROJECT_ID \
--datacatalog-location-id=us-central1 \
--postgresql-host=$public_ip_address \
--postgresql-user=$username \
--postgresql-pass=$password \
--postgresql-database=$database
content_copy

Soon after you should receive the following output:

============End postgresql-to-datacatalog============content_copy

Check the results of the script

Ensure that you are in the Data Catalog home page.

In the search bar, enter PostgreSQL. You should see the following Tag Templates and Entry Group appear in the results:

Now click on the postgresql Entry Group. Your console should resemble the following:

This is the real value of an Entry Group — you can see all entries that belong to postgresql using the UI.

Click on one of the warehouse entries. Look at the Custom entry details and tags:

Custom entry details and Tags:

This is the real value the connector adds—it allows you to have the metadata searchable in Data Catalog.

Cleaning up

To delete the created resources, run the following command to delete the PostgreSQL metadata:

./cleanup-db.sh
content_copy

Now execute the cleaner container:

docker run --rm --tty -v \
"$PWD":/data mesmacosta/postgresql-datacatalog-cleaner:stable \
--datacatalog-project-ids=$PROJECT_ID \
--rdbms-type=postgresql \
--table-container-type=schema
content_copy

Finally, delete the PostgreSQL database:

./delete-db.sh
content_copy

Now, from the Navigation menu click on Data Catalog. Search for PostgreSQL. You will no longer see the PostgreSQL Tag Templates in the results:

Ensure you see the following output in Cloud Shell before you move on:

  Cloud SQL Instance deleted
  COMPLETEDcontent_copy

You will now learn how to do the same thing with a MySQL instance.

MySQL to Data Catalog

Create the MySQL Database

You can use the open source scripts at Cloud SQL MySQL Tooling to create and populate your MySQL instance.

Run the following command in Cloud Shell to return to your home directory:

cd
content_copy

Run the following command to clone the github repository:

git clone https://github.com/mesmacosta/cloudsql-mysql-tooling
content_copy

Now change your current working directory to the cloned repo directory:

cd cloudsql-mysql-tooling
content_copy

Next execute the init-db.sh script:

source init-db.sh
content_copy

This will create your MySQL instance and populate it with random schema. After a few minutes, you should receive the following output:

CREATE TABLE factory_warehouse14342.persons88a5ebc4 ( address9634 TEXT, cpf12934 FLOAT, food88799 BOOL, food4761 LONGTEXT, credit_card44049 FLOAT, city8417 TINYINT, name76076 DATETIME, address19458 TIME, reason49953 DATETIME )
 COMPLETEDcontent_copy

Set Up the Service Account

Run the following to create a Service Account:

gcloud iam service-accounts create mysql2dc-credentials \
--display-name  "Service Account for MySQL to Data Catalog connector" \
--project $PROJECT_ID
content_copy

Next, create and download the Service Account Key:

gcloud iam service-accounts keys create "mysql2dc-credentials.json" \
--iam-account "mysql2dc-credentials@$PROJECT_ID.iam.gserviceaccount.com"
content_copy

Next add Data Catalog admin role to the Service Account:

gcloud projects add-iam-policy-binding $PROJECT_ID \
--member "serviceAccount:mysql2dc-credentials@$PROJECT_ID.iam.gserviceaccount.com" \
--quiet \
--project $PROJECT_ID \
--role "roles/datacatalog.admin"
content_copy

Execute MySQL to Data Catalog connector

You can build the MySQL connector yourself by going to this GitHub repository.

To facilitate its usage, this lab uses a docker image. The environment variables were loaded by the init-db.sh script.

Execute the connector:

docker run --rm --tty -v \
"$PWD":/data mesmacosta/mysql2datacatalog:stable \
--datacatalog-project-id=$PROJECT_ID \
--datacatalog-location-id=us-central1 \
--mysql-host=$public_ip_address \
--mysql-user=$username \
--mysql-pass=$password \
--mysql-database=$database
content_copy

Soon after you should receive the following output:

============End mysql-to-datacatalog============content_copy

Check the results of the script

Ensure that you are in the Data Catalog home page.

In the search bar, type MySQL. You should see the following Tag Templates and Entry Group appear in the results:

Now click on the mysql Entry Group. Your console should resemble the following:

This is the real value of an Entry Group — you can see all entries that belong to MySQL using the UI.

Click on one of the warehouse entries. Look at the Custom entry details and tags:

Custom entry details and Tags:

This is the real value the connector adds — it allows you to have the metadata searchable in Data Catalog.

Cleaning up

To delete the created resources, run the following command to delete the MySQL metadata:

./cleanup-db.sh
content_copy

Now execute the cleaner container:

docker run --rm --tty -v \
"$PWD":/data mesmacosta/mysql-datacatalog-cleaner:stable \
--datacatalog-project-ids=$PROJECT_ID \
--rdbms-type=mysql \
--table-container-type=database
content_copy

Finally, delete the PostgreSQL database:

./delete-db.sh
content_copy

From the Navigation menu click Data Catalog. Search for MySQL. You will no longer see the MySQL Tag Templates in the results:

Ensure you see the following output in Cloud Shell before you move on:

  Cloud SQL Instance deleted
  COMPLETEDcontent_copy

Congratulations!

Great job! You received hands-on practice with Data Catalog connectors.

In this lab, you learned how to:

• Enable the Data Catalog API.
• Create a dataset.
• Copy a public New York Taxi table to your dataset.
• Create a tag template and attach the tag to your table.

Finish Your Quest

This self-paced lab is part of the Qwiklabs BigQuery for Data Warehousing, BigQuery for Marketing Analysts,and Data Catalog Fundamentals Quests. A Quest is a series of related labs that form a learning path. Completing a Quest earns you a badge to recognize your achievement. You can make your badge (or badges) public and link to them in your online resume or social media account. Enroll in a Quest and get immediate completion credit if you've taken this lab. See other available Qwiklabs Quests.

Next Steps / Learn More

• Read the Data Catalog Overview
• Learn How to search with Data Catalog
• Browse the Overview of APIs and Client Libraries

End your lab

When you have completed your lab, click End Lab. Qwiklabs removes the resources you’ve used and cleans the account for you.

You will be given an opportunity to rate the lab experience. Select the applicable number of stars, type a comment, and then click Submit.

The number of stars indicates the following:

• 1 star = Very dissatisfied
• 2 stars = Dissatisfied
• 3 stars = Neutral
• 4 stars = Satisfied
• 5 stars = Very satisfied

You can close the dialog box if you don't want to provide feedback.

For feedback, suggestions, or corrections, please use the Support tab.

Google Cloud Training & Certification

...helps you make the most of Google Cloud technologies. Our classes include technical skills and best practices to help you get up to speed quickly and continue your learning journey. We offer fundamental to advanced level training, with on-demand, live, and virtual options to suit your busy schedule. Certifications help you validate and prove your skill and expertise in Google Cloud technologies.

Manual Last Updated February 02, 2021

Lab Last Tested February 02, 2021

Copyright 2021 Google LLC All rights reserved. Google and the Google logo are trademarks of Google LLC. All other company and product names may be trademarks of the respective companies with which they are associated.