arrow_back

Data Catalog: Qwik Start

Join Sign in

Data Catalog: Qwik Start

30 minutes 1 Credit

GSP729

Google Cloud self-paced labs logo

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.

BigQuery is an enterprise data warehouse that enables super-fast SQL queries using the processing power of Google's infrastructure.

Simply move your data into BigQuery and let us handle the hard work. You can control access to both the project and your data based on your business needs, such as giving others the ability to view or query your data.

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.

Data Catalog use case

Imagine you are a data engineer in your company. It is your job to ensure all datasets can be easily discovered and used by colleagues, such as data scientists or business analysts. When a new dataset comes in, you annotate it with important information—this could be whether or not it contains PII data, who owns the dataset, how many rows the dataset contains, etc.

You can annotate this information by adding tags to your dataset and tables. Data Catalog allows you to create tag templates to let you define what kind of attributes you want to tag. This allows you to easily access, map, and discover pertinent information from your datasets and tables.

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.

  • Create a dataset with BigQuery.

  • Copy a public New York Taxi table to your dataset.

  • Create a Data Catalog tag template.

  • Tag your newly created table with the newly created tags.

Prerequisites

Note: 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 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.

To complete this lab, you need:

  • Access to a standard internet browser (Chrome browser recommended).
Note: Use an Incognito or private browser window to run this lab. This prevents any conflicts between your personal account and the Student account, which may cause extra charges incurred to your personal account.
  • Time to complete the lab---remember, once you start, you cannot pause a lab.
Note: If you already have your own personal Google Cloud account or project, do not use it for this lab to avoid extra charges to your account.

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 the Lab Details panel with the following:

    • The Open Google Console button
    • Time remaining
    • The temporary credentials that you must use for this lab
    • Other information, if needed, to step through this lab
  2. Click Open Google Console. The lab spins up resources, and then opens another tab that shows the Sign in page.

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

    Note: If you see the Choose an account dialog, click Use Another Account.
  3. If necessary, copy the Username from the Lab Details panel and paste it into the Sign in dialog. Click Next.

  4. Copy the Password from the Lab Details panel and paste it into the Welcome dialog. Click Next.

    Important: You must use the credentials from the left panel. Do not use your Google Cloud Skills Boost credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.
  5. 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.

Note: You can view the menu with a list of Google Cloud Products and Services by clicking the Navigation menu at the top-left. Navigation menu icon

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.

  1. Click Activate Cloud Shell Activate Cloud Shell icon at the top of the Google Cloud console.

  2. 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. The output contains a line that declares the PROJECT_ID for this session:

Your Cloud Platform project in this session is set to YOUR_PROJECT_ID

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

  1. (Optional) You can list the active account name with this command:

gcloud auth list

Output:

ACTIVE: * ACCOUNT: student-01-xxxxxxxxxxxx@qwiklabs.net To set the active account, run: $ gcloud config set account `ACCOUNT`
  1. (Optional) You can list the project ID with this command:

gcloud config list project

Output:

[core] project = <project_ID>

Example output:

[core] project = qwiklabs-gcp-44776a13dea667a6 Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

Task 1. Enable the Data Catalog API

  1. From the navigation menu, select APIs and Services > Library.

  2. In the search bar, enter in Data Catalog and select the first result.

  3. Then click Enable.

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

Failed API Enablement error message

  1. Click Close.
  2. Refresh your browser tab.
  3. Click Enable again.

The Data Catalog API should be successfully enabled:

Google Cloud Data Catalog window showing the Data Catalog API overview

Open the BigQuery console

  1. In the Google Cloud Console, select Navigation menu > BigQuery.

The Welcome to BigQuery in the Cloud Console message box opens. This message box provides a link to the quickstart guide and the release notes.

  1. Click Done.

The BigQuery console opens.

Task 2. Create a dataset

  1. In the left navigation pane of BigQuery, click on view actions next to your project id, then click CREATE DATASET.

The View Actions navigation menu, wherein the option Create dataset is highlighted within the project's sub-menu.

  1. In the Create Dataset dialog:

  • For Dataset ID, enter demo_dataset

  • For Data location, select us (multiple regions in United States).

The Create dataset page, wherein the Project ID, Dataset ID, and Data location fields are completed.

  1. Then click Create dataset.
Note: You cannot add a description or a label when you create a dataset using the Cloud Console. After the dataset is created, you can add a description and label.

Click Check my progress to verify the objective. Create a dataset

Task 3. Copy a public New York Taxi table to your dataset.

  1. From the left-hand panel, click + ADD DATA > Explore public datasets.

  2. In the search bar, enter in NYC TLC Trips and click on the result that appears:

The search results, wherein the NYC TLC Trips tile is highlighted alongside the 'Filter by' menu.

For this lab, you will be using a table from this dataset which contains NYC yellow cab trip data from 2018.

  1. Click out of the side panel to close it as soon as you're ready to continue.

  2. Copy the tlc_yellow_trips_2018 table by running this command in your Cloud Shell panel:

bq cp bigquery-public-data:new_york_taxi_trips.tlc_yellow_trips_2018 $(gcloud config get project):demo_dataset.trips

The previous command used the bq command line tool to copy the public table into your project and organized it in the demo_dataset you created earlier.

  1. Refresh your BigQuery browser page.
  1. Confirm that the trips table is listed in your demo_dataset.

The listed pinned projects, wherein the trips table is listed as a file within the demo_dataset.

You will add Data Catalog tags to the table in the next section.

Click Check my progress to verify the objective. Copy a public New York taxi table to your dataset

Task 4. Create a Data Catalog tag template

Create a tag template from the Data Catalog UI.

  1. Open the Navigation menu and click on Data Catalog > Tag Templates. Then click + CREATE TAG TEMPLATE:

The Data Catalog pane, wherein the tag templates option is highlighted, along with the Create template button.

  1. Fill in the template form to define a "Demo Tag Template".

  • Template display name: Demo Tag Template
  • Template ID: demo_tag_template
  • Location: keep the default setting.

Next, create four tag attributes (also called tag "fields").

  1. Click Add Field. Create four attributes with the values listed below. Note that the "source" attribute defines a required tag attribute. You can use lower case letters and underscores to define attribute names:

  • Field display name: Source of data asset

  • Field ID: source_of_data_asset

  • Make this field required: Checked

  • Type: String

  1. Click Done.

  2. Now click Add Field and enter in:

  • Field display name: Number of rows in data asset

  • Field ID: number_of_rows_in_data_asset

  • Make this field required: Not checked

  • Type: Double

  1. Click Done.

  2. Then click Add Field and enter in:

  • Field display name: Has PII

  • Field ID: has_pii

  • Make this field required: Not checked

  • Type: Boolean

  1. Click Done.

  2. Then click Add Field and enter in:

  • Field display name: PII type

  • Field ID: pii_type

  • Make this field required: Not checked

  • Type: Enumerated

  1. Add 3 values to this attribute:
  • Email

  • Social Security Number

  • None

  1. Then click Done.

The completed tag template form should list the four tag attributes:

The completed tag template form, along with visibility options and the create and Cancel buttons.

  1. Click CREATE.

The Data Catalog Tag template page displays template details and attributes:

The completed data catalog, which lists the template details, fields, display names, and types.

Task 5. Tag your table with the newly created tags

  1. To attach a tag to a table in your dataset, click on the Data Catalog icon in the top left corner.

  2. In Left pane, select Search and type demo_dataset in the Search box.

  3. Click Search:

The Data Catalog page, with the search term 'demo_dataset' typed in the search bar.

The demo_dataset and the trips table that you copied into the dataset are displayed in the search results.

  1. Open the trips table by clicking on the name:

The demo_dataset listed along with its specifications and the highlighted trips table.

The Entry details page opens.

  1. Click ATTACH TAGS.

The Entry details page, wherein the Attach tags button is highlighted.

  1. From the Attach Tags dialog, under "Choose what to tag" select trips table, and select the Demo Tag Template for tag templates.

  2. Next, insert or select the following values for each tag attribute:

  • source_of_data_asset: tlc_yellow_trips_2018
  • pii_type: NONE

The Attach Tags page, wherein the Source of data assets and PII type have been selected and filled within the Demo Tag Template.

  1. Click Save.

  2. Click on Demo Tag Template to view the tag attributes listed on the Entry details page.

The Entry details page, which includes the Demo Tag Template's display name, source of data asset, and PII type.

Click Check my progress to verify the objective. Create a tag template and attach the tag to your table

Congratulations!

Great job! You learned how to successfully attach a tag to a table with Data Catalog.

Finish your quest

This self-paced lab is part of the 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 any quest that contains this lab and get immediate completion credit. See the Google Cloud Skills Boost catalog to see all available quests.

What was covered

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.

Next steps / learn more

End your lab

When you have completed your lab, click End Lab. Your account and the resources you've used are removed from the lab platform.

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 and 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 August 16, 2022

Lab last tested July 28, 2022

Copyright 2022 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.