GSP1085

Overview

AlloyDB for PostgreSQL is a fully managed PostgreSQL-compatible database service for your most demanding enterprise database workloads. AlloyDB combines the best of Google with one of the most popular open-source database engines, PostgreSQL, for superior performance, scale, and availability.

In this lab, you migrate a stand-alone PostgreSQL database (running on a virtual machine) to AlloyDB for PostgreSQL using native PostgreSQL tools. One of the database migration options supported by AlloyDB is the import of a DMP file. The DMP file must be created using the pg_dump tool with the custom or directory format setting. The DMP must be imported using the pg_restore tool.

What you'll do

In this lab, you learn how to perform the following tasks:

• Verify Data in Source Instance for Migration
• Create a database DMP file using pg_dump
• Import DMP file using pg_restore

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 are made available to you.

This hands-on lab lets you do the lab activities in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials 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 (recommended) or private browser window to run this lab. This prevents 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: Use only the student account for this lab. If you use a different Google Cloud account, you may incur charges to that 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 dialog opens for you to select your payment method. On the left is the Lab Details pane with the following:

   • The Open Google Cloud 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 Cloud console (or right-click and select Open Link in Incognito Window if you are running the Chrome browser).

   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 below and paste it into the Sign in dialog.

   {{{user_0.username | "Username"}}}

   You can also find the Username in the Lab Details pane.

4. Click Next.

5. Copy the Password below and paste it into the Welcome dialog.

   {{{user_0.password | "Password"}}}

   You can also find the Password in the Lab Details pane.

6. Click Next.

   Important: You must use the credentials the lab provides you. Do not use your Google Cloud account credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.

7. 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 Google Cloud console opens in this tab.

Note: To access Google Cloud products and services, click the Navigation menu or type the service or product name in the Search field.

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 at the top of the Google Cloud console.

2. Click through the following windows:

   • Continue through the Cloud Shell information window.
   • Authorize Cloud Shell to use your credentials to make Google Cloud API calls.

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 {{{project_0.project_id | "PROJECT_ID"}}}

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

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

gcloud auth list

4. Click Authorize.

Output:

ACTIVE: * ACCOUNT: {{{user_0.username | "ACCOUNT"}}} To set the active account, run: $ gcloud config set account `ACCOUNT`

5. (Optional) You can list the project ID with this command:

gcloud config list project

Output:

[core] project = {{{project_0.project_id | "PROJECT_ID"}}} Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

Task 1. Verify Data in Source Instance for Migration

1. On the Navigation menu (), under Compute Engine click VM instances.

2. For the instance named pg14-source, in the Connect column, click SSH to open a terminal window.

3. Use the following command to launch the PostgreSQL (psql) client.

sudo -u postgres psql

7. You will be presented the psql terminal prompt similar to as shown below.

psql (14.5 (Debian 14.5-1.pgdg110+1)) Type "help" for help.

8. Input and run the following SQL command to see the HR related tables in the postgres database.

\dt List of relations Schema | Name | Type | Owner --------+-------------+-------+---------- public | countries | table | postgres public | departments | table | postgres public | employees | table | postgres public | jobs | table | postgres public | locations | table | postgres public | regions | table | postgres (6 rows)

9. Run the following queries to determine the row counts for each table.

select count (*) as countries_row_count from countries; select count (*) as departments_row_count from departments; select count (*) as employees_row_count from employees; select count (*) as jobs_row_count from jobs; select count (*) as locations_row_count from locations; select count (*) as regions_row_count from regions;

10. The source table rows counts are as follows.

Name	Rows
countries	25
departments	27
employees	107
jobs	19
locations	23
regions	4

11. Type \q to exit the psql client.

Task 2. Create a database DMP file using pg_dump

1. The pg_dump tool is installed by default with every PostgreSQL installation. In the pg14-source terminal, create a DMP file of the postgres database containing the HR tables you examined earlier. Run the the following command at the shell prompt. Note: the '-Fc' flag designates a custom format DMP file.

sudo -u postgres pg_dump -Fc postgres > pg14_source.DMP

2. Browse the directory to confirm the size and other details of the DMP file.

ls -l -h pg14_source.DMP -rw-r--r-- 1 student-03-171e0d8475af google-sudoers 13K Aug 27 21:19 pg14_source.DMP

3. To simulate a routine database export/import, migrate the DMP file to a Cloud Storage bucket. A bucket named after your Qwiklabs Project ID was created at lab startup.

gsutil cp pg14_source.DMP gs://{{{primary_project.project_id|Project ID}}}/pg14_source.DMP

4. Click Check my progress to verify the objective.

Upload database DMP file to Cloud Storage

Task 3. Import DMP file using pg_restore

1. An AlloyDB cluster and instance were provisioned when you started the lab. On the Cloud Console Navigation menu (), under Databases click AlloyDB for PostgreSQL then Clusters to examine the cluster's details.

2. The cluster is named lab-cluster and the instance is named lab-instance.

3. Please make note of the Private IP address in the instances section. Copy the Private IP address to a text file so that you can paste the value in a later step. The instance takes a while to be fully created and initialized. Please wait until you see a Status of Ready to proceed to the next step.

4. A VM named, alloydb-client, containing the PostgreSQL client was provisioned for you at the start of the lab. This installation includes the database restore tool pg_restore.

5. On the Navigation menu (), under Compute Engine click VM instances.

6. For the instance named alloydb-client, in the Connect column, click SSH to open a terminal window.

7. Set the following environment variable, replacing ALLOYDB_ADDRESS with the Private IP address of the AlloyDB instance.

export ALLOYDB=ALLOYDB_ADDRESS

8. Run the following command to store the Private IP address of the AlloyDB instance on the AlloyDB client VM so that it will persist throughout the lab.

echo $ALLOYDB > alloydbip.txt

9. Use the following command to launch the PostgreSQL (psql) client. You will be prompted to provide the postgres user's password (Change3Me) which was specified when the cluster was created.

psql -h $ALLOYDB -U postgres

10. Run the follwoing command to confirm that the postgres database is currently empty.

\dt Did not find any relations.

11. Type \q to exit the psql client.

12. Download the DMP file from the Cloud Storage bucket to the local directory.

gsutil cp gs://{{{primary_project.project_id|Project ID}}}/pg14_source.DMP pg14_source.DMP

13. Run the following command to create a TOC file that comments out all extension statements.

pg_restore -l pg14_source.DMP | sed -E 's/(.* EXTENSION )/; \1/g' > pg14_source_toc.toc

14. Now run the restore command to load the HR tables. You will be prompted for the postgres user's password - Change3Me.

pg_restore -h $ALLOYDB -U postgres \ -d postgres \ -L pg14_source_toc.toc \ pg14_source.DMP

15. Launch the PostgreSQL (psql) client again. You will be prompted for the postgres user's password - Change3Me.

psql -h $ALLOYDB -U postgres

16. Run the following command to confirm that the tables were loaded.

\dt List of relations Schema | Name | Type | Owner --------+-------------+-------+---------- public | countries | table | postgres public | departments | table | postgres public | employees | table | postgres public | jobs | table | postgres public | locations | table | postgres public | regions | table | postgres (6 rows)

17. Run the following queries to determine the row counts for the migrated tables. The values will match the query outputs on the source instance.

select count (*) as countries_row_count from countries; select count (*) as departments_row_count from departments; select count (*) as employees_row_count from employees; select count (*) as jobs_row_count from jobs; select count (*) as locations_row_count from locations; select count (*) as regions_row_count from regions;

18. Click Check my progress to verify the objective.

Verify import of database DMP file

Congratulations!

You have now successfully migrated a stand-alone PostgreSQL database (running on a virtual machine) to AlloyDB for PostgreSQL using native PostgreSQL tools.

Manual Last Updated April 26, 2024

Lab Last Tested August 2, 2023

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