Skip to content

Connecting External Tools

🐘 Connecting to PostgreSQL using pgAdmin 4

pgAdmin is a visual database management tool for PostgreSQL, the database engine used by the MIRROR platform.

We use pgAdmin to:

  • πŸ” Visually inspect the ingested data
  • 🧩 Explore tables created by the ingestion scripts
  • πŸ› οΈ Run manual SQL queries if needed
  • πŸ“¦ Confirm that layers (like projects, buildings, or glossary) are successfully stored

This guide explains how to connect to the local PostgreSQL container used by the MIRROR platform using pgAdmin 4.


βœ… 1. Install pgAdmin 4

If you haven't already, download and install pgAdmin 4:

πŸ‘‰ https://www.pgadmin.org/download/


πŸ”— 2. Register a New Server

Once pgAdmin is installed:

  1. Open pgAdmin 4
  2. Right-click on β€œServers” in the left sidebar
  3. Click Register > Server

Register server - General Tab


πŸ–ΌοΈ Register Server β€” General Tab

  • Enter any Name (e.g., MirrorDB)
  • Go to the Connection tab

πŸ”Œ Register Server β€” Connection Tab

  • Host name/address: localhost
    If localhost doesn't work, try 127.0.0.1
  • Port: 5432
  • Username: (check your .env or credentials folder, usually citymap)
  • Password: (check credentials folder or ask admin)

Register server - General Tab

βœ… Be sure to click β€œSave Password”


πŸ” Credentials Info

Database connection credentials are typically located in:

./credentials/