PostgreSQL Module

PostgreSQL is a powerful, open source object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

Install

npm install @testcontainers/postgresql --save-dev

Examples

Connect and execute query:

it("should connect and return a query result", async () => {
  const container = await new PostgreSqlContainer().start();

  const client = new Client({
    host: container.getHost(),
    port: container.getPort(),
    database: container.getDatabase(),
    user: container.getUsername(),
    password: container.getPassword(),
  });
  await client.connect();

  const result = await client.query("SELECT 1");
  expect(result.rows[0]).toEqual({ "?column?": 1 });

  await client.end();
  await container.stop();
});

Connect and execute query using URI:

it("should work with database URI", async () => {
  const container = await new PostgreSqlContainer().start();

  const client = new Client({
    connectionString: container.getConnectionUri(),
  });
  await client.connect();

  const result = await client.query("SELECT 1");
  expect(result.rows[0]).toEqual({ "?column?": 1 });

  await client.end();
  await container.stop();
});

Set database:

it("should set database", async () => {
  const container = await new PostgreSqlContainer().withDatabase("customDatabase").start();

  const client = new Client({
    host: container.getHost(),
    port: container.getPort(),
    database: container.getDatabase(),
    user: container.getUsername(),
    password: container.getPassword(),
  });
  await client.connect();

  const result = await client.query("SELECT current_database()");
  expect(result.rows[0]).toEqual({ current_database: "customDatabase" });

  await client.end();
  await container.stop();
});

Set username:

it("should set username", async () => {
  const container = await new PostgreSqlContainer().withUsername("customUsername").start();

  const client = new Client({
    host: container.getHost(),
    port: container.getPort(),
    database: container.getDatabase(),
    user: container.getUsername(),
    password: container.getPassword(),
  });
  await client.connect();

  const result = await client.query("SELECT current_user");
  expect(result.rows[0]).toEqual({ current_user: "customUsername" });

  await client.end();
  await container.stop();
});