PostgresRole

Source: src/Planetscale/Postgres/PostgresRole.ts

A PlanetScale role for accessing a PostgreSQL database branch.

For MySQL databases, use {@link MySQLPassword} instead.

Creating a Role

Postgres admin role

const admin = yield* Planetscale.PostgresRole("Admin", {
  database: "my-db",
  inheritedRoles: ["postgres"],
});

Read-only role

const reader = yield* Planetscale.PostgresRole("Reader", {
  database: "my-db",
  inheritedRoles: ["pg_read_all_data", "pg_read_all_settings"],
});

Role with TTL

const tempReader = yield* Planetscale.PostgresRole("TempReader", {
  database: "my-db",
  inheritedRoles: ["pg_read_all_data"],
  ttl: 3600,
});