psql command-line tool basics in PostgreSQL

Introduction

psql helps you talk to your PostgreSQL database using simple commands. It lets you run queries and see results right away.

You want to quickly check data in your database without a fancy app.

You need to run SQL commands to create or change tables.

You want to test queries before adding them to your program.

You need to fix or update data directly in the database.

You want to learn SQL by trying commands interactively.

Syntax

PostgreSQL

psql [options] [dbname [username]]

Use 'psql' to start the tool and connect to a database.

You can specify the database name and user to connect as.

Examples

Connects to the database named 'mydatabase' using your current system user.

PostgreSQL

psql mydatabase

Connects to 'mydatabase' as user 'alice'.

PostgreSQL

psql -U alice mydatabase

Connects to 'mydatabase' on the local machine at port 5432.

PostgreSQL

psql -h localhost -p 5432 mydatabase

Sample Program

Shows connection info and the PostgreSQL version.

PostgreSQL

\conninfo
SELECT version();

Important Notes

Commands starting with a backslash (\) are psql-specific, not SQL.

Use \q to quit the psql tool.

You can use \? to see a list of all psql commands.

Summary

psql is a simple way to connect and work with PostgreSQL databases.

You start it by typing 'psql' with optional database and user names.

Inside psql, you can run SQL queries and special commands starting with \.

Practice

1. What is the primary purpose of the psql command-line tool in PostgreSQL?

easy

A. To connect to a PostgreSQL database and run SQL commands interactively

B. To create new PostgreSQL database clusters

C. To backup PostgreSQL databases automatically

D. To monitor server hardware performance

Solution

1. Step 1: Understand the role of psql

   psql is a command-line interface tool designed to connect to PostgreSQL databases and allow users to run SQL commands interactively.

2. Step 2: Differentiate from other tools

   Other options like creating clusters or backups are done by different tools or commands, not psql.

3. Final Answer:

   To connect to a PostgreSQL database and run SQL commands interactively -> Option A

4. Quick Check:

   psql = interactive SQL client [OK]

Hint: Remember: psql = PostgreSQL interactive shell [OK]

Common Mistakes:

• Confusing psql with backup tools
• Thinking psql manages hardware
• Assuming psql creates database clusters

2. Which of the following is the correct way to start psql and connect to a database named mydb as user alice?

easy

A. psql start mydb alice

B. psql --connect mydb alice

C. psql connect mydb user alice

D. psql -d mydb -U alice

Solution

1. Step 1: Recall psql connection syntax

   The correct syntax to connect is psql -d database -U user.

2. Step 2: Match options to syntax

   psql -d mydb -U alice matches this syntax exactly, while others use invalid or unsupported flags.

3. Final Answer:

   psql -d mydb -U alice -> Option D

4. Quick Check:

   psql -d db -U user = connect [OK]

Hint: Use -d for database and -U for user [OK]

Common Mistakes:

• Using unsupported flags like --connect
• Writing commands without dashes
• Mixing command words incorrectly

3. Inside psql, what will be the result of running the command \dt?

medium

A. It lists all tables in the current database

B. It deletes the current table

C. It displays the current database connection info

D. It shows the last query execution plan

Solution

1. Step 1: Understand psql meta-commands

   Commands starting with a backslash (\) are special psql commands. \dt lists tables.

2. Step 2: Identify what \dt does

   \dt shows all tables in the current database schema, not deleting or showing connection info.

3. Final Answer:

   It lists all tables in the current database -> Option A

4. Quick Check:

   \dt = list tables [OK]

Hint: Backslash commands show info; \dt lists tables [OK]

Common Mistakes:

• Thinking \dt deletes tables
• Confusing \dt with connection info commands
• Expecting \dt to show query plans

4. You try to run psql -d mydb -U alice but get an error: psql: FATAL: password authentication failed for user "alice". What is the most likely cause?

medium

A. The database mydb does not exist

B. The psql command is misspelled

C. The password entered for user alice is incorrect or missing

D. The PostgreSQL server is not running

Solution

1. Step 1: Analyze the error message

   The error says "password authentication failed for user alice," indicating a login problem.

2. Step 2: Identify the cause

   This usually means the password is wrong or not provided, not that the database or command is missing.

3. Final Answer:

   The password entered for user alice is incorrect or missing -> Option C

4. Quick Check:

   Password error = authentication failed [OK]

Hint: Password errors mean wrong or missing password [OK]

Common Mistakes:

• Assuming database doesn't exist from this error
• Thinking psql command is wrong
• Ignoring server status

5. You want to list all databases available on your PostgreSQL server using psql. Which command should you run inside the psql prompt?

hard

A. SHOW DATABASES;

B. \l

C. \listdb

D. SELECT * FROM pg_databases;

Solution

1. Step 1: Recall psql meta-commands for listing databases

   The command \l (or \list) lists all databases in psql.

2. Step 2: Evaluate other options

   SHOW DATABASES; is MySQL syntax, \listdb is invalid, and SELECT * FROM pg_databases; is incorrect because the catalog table is pg_database, not pg_databases.

3. Final Answer:

   \l -> Option B

4. Quick Check:

   \l = list databases [OK]

Hint: Use \l inside psql to list databases [OK]

Common Mistakes:

• Using MySQL syntax SHOW DATABASES;
• Typing wrong meta-command \listdb
• Querying wrong system table name