PostgreSQL connection with pg in Node.js

Introduction

We use the pg library to connect Node.js apps to PostgreSQL databases. It helps us send queries and get data easily.

You want to save user data from a web form into a PostgreSQL database.

You need to read data from PostgreSQL to show on a website.

You want to update or delete records in PostgreSQL from your Node.js app.

You are building a backend API that talks to PostgreSQL.

You want to run SQL commands from your JavaScript code.

Syntax

Node.js

import { Client } from 'pg';

async function main() {
  const client = new Client({
    user: 'yourUsername',
    host: 'localhost',
    database: 'yourDatabase',
    password: 'yourPassword',
    port: 5432
  });

  await client.connect();

  // Run queries here

  await client.end();
}

main();

Replace connection details with your own database info.

Always call connect() before running queries and end() when done.

Examples

Using a connection string instead of separate options.

Node.js

import { Client } from 'pg';

async function main() {
  const client = new Client({
    connectionString: 'postgresql://user:password@localhost:5432/mydb'
  });

  await client.connect();

  // Run queries here

  await client.end();
}

main();

Run a simple query to get the current time from PostgreSQL.

Node.js

const res = await client.query('SELECT NOW()');
console.log(res.rows[0]);

Sample Program

This program connects to PostgreSQL, runs a simple query that returns a message, prints it, and then closes the connection.

Node.js

import { Client } from 'pg';

async function run() {
  const client = new Client({
    user: 'postgres',
    host: 'localhost',
    database: 'testdb',
    password: 'mypassword',
    port: 5432
  });

  try {
    await client.connect();
    const res = await client.query('SELECT $1::text as message', ['Hello, pg!']);
    console.log(res.rows[0].message);
  } catch (err) {
    console.error('Error connecting or querying', err);
  } finally {
    await client.end();
  }
}

run();

Important Notes

Make sure PostgreSQL server is running and accessible.

Never hardcode passwords in real apps; use environment variables.

Use try/catch to handle errors when connecting or querying.

Summary

The pg library lets Node.js talk to PostgreSQL easily.

Set up a Client with your database info, connect, query, then close.

Always handle errors and close connections to keep your app stable.

Practice

1. What is the main purpose of the pg library in Node.js?

easy

A. To connect and interact with PostgreSQL databases

B. To create web servers

C. To manage file uploads

D. To style web pages

Solution

1. Step 1: Understand the role of pg

   The pg library is designed specifically to connect Node.js applications to PostgreSQL databases.

2. Step 2: Compare with other options

   Creating web servers, managing file uploads, and styling pages are unrelated to database connections and are handled by other libraries.

3. Final Answer:

   To connect and interact with PostgreSQL databases -> Option A

4. Quick Check:

   pg = PostgreSQL connection [OK]

Hint: Remember pg is for PostgreSQL database connection [OK]

Common Mistakes:

• Confusing pg with web server libraries
• Thinking pg handles frontend styling
• Assuming pg manages file uploads

2. Which of the following is the correct way to create a new Client instance from the pg library?

easy

A. const client = pg.connect('postgresql://user:pass@localhost/db');

B. const client = new pg.Client({ connectionString: 'postgresql://user:pass@localhost/db' });

C. const client = new Client.connect('postgresql://user:pass@localhost/db');

D. const client = pg.new Client('postgresql://user:pass@localhost/db');

Solution

1. Step 1: Recall the correct Client creation syntax

   The pg library requires creating a new Client instance using new pg.Client() with a config object.

2. Step 2: Check each option's syntax

   const client = new pg.Client({ connectionString: 'postgresql://user:pass@localhost/db' }); correctly uses new pg.Client({ connectionString: ... }). Options B, C, and D use invalid syntax or methods that do not exist.

3. Final Answer:

   const client = new pg.Client({ connectionString: 'postgresql://user:pass@localhost/db' }); -> Option B

4. Quick Check:

   Use new pg.Client with config object [OK]

Hint: Use 'new pg.Client' with config object for connection [OK]

Common Mistakes:

• Calling pg.connect directly without new Client
• Using incorrect method names like Client.connect
• Missing the 'new' keyword when creating Client

3. What will the following code output if the query succeeds?

const { Client } = require('pg');
const client = new Client({ connectionString: 'postgresql://user:pass@localhost/db' });

async function run() {
  await client.connect();
  const res = await client.query('SELECT 1 AS number');
  console.log(res.rows[0].number);
  await client.end();
}

run();

medium

A. 1

B. [{ number: 1 }]

C. undefined

D. Error: query failed

Solution

1. Step 1: Understand the query and result structure

   The query SELECT 1 AS number returns one row with a column named 'number' having value 1.

2. Step 2: Check how the result is accessed

   The code logs res.rows[0].number, which accesses the first row's 'number' field, so it prints 1.

3. Final Answer:

   1 -> Option A

4. Quick Check:

   res.rows[0].number = 1 [OK]

Hint: Access query result via res.rows[0].columnName [OK]

Common Mistakes:

• Logging res.rows instead of a specific field
• Expecting the whole array instead of one value
• Not awaiting client.connect() before query

4. Identify the error in this code snippet that uses pg to connect to PostgreSQL:

const { Client } = require('pg');
const client = new Client({ connectionString: 'postgresql://user:pass@localhost/db' });

client.connect();
const res = await client.query('SELECT NOW()');
console.log(res.rows[0]);
client.end();

medium

A. client.end() should be called before query

B. client.query() should not be awaited

C. No error, code is correct

D. Missing await before client.connect()

Solution

1. Step 1: Check async usage for connect()

   The client.connect() method returns a promise and must be awaited to ensure connection before querying.

2. Step 2: Verify other async calls

   The await before client.query() is correct. Calling client.end() after query is also correct.

3. Final Answer:

   Missing await before client.connect() -> Option D

4. Quick Check:

   Always await client.connect() before queries [OK]

Hint: Always await client.connect() before querying [OK]

Common Mistakes:

• Not awaiting client.connect() causing race conditions
• Awaiting client.query() is correct, so skipping it is wrong
• Calling client.end() too early before query finishes

5. You want to write a Node.js function using pg that connects to PostgreSQL, runs a query, and always closes the connection even if an error occurs. Which pattern is best?

hard

A. Call connect, query, and end sequentially without error handling

B. Only call client.end() if query succeeds, skip on error

C. Use try-catch-finally: connect in try, query in try, close in finally

D. Use callbacks instead of async/await for better error handling

Solution

1. Step 1: Understand error-safe connection handling

   To ensure the connection closes even if an error happens, use a try-catch-finally block where client.end() is called in the finally block.

2. Step 2: Evaluate options for best practice

   Use try-catch-finally: connect in try, query in try, close in finally correctly uses try-catch-finally. Call connect, query, and end sequentially without error handling lacks error handling. Only call client.end() if query succeeds, skip on error risks leaving connection open on errors. Use callbacks instead of async/await for better error handling is outdated compared to async/await.

3. Final Answer:

   Use try-catch-finally: connect in try, query in try, close in finally -> Option C

4. Quick Check:

   try-catch-finally ensures connection closes [OK]

Hint: Use try-catch-finally to always close connection [OK]

Common Mistakes:

• Not closing connection on errors
• Ignoring async/await for error handling
• Closing connection only on success