Class ServerClient

A connection to the "postgres" database on a PostegreSQL server.

Index

Constructors

Methods

createDatabase createGrant createMemberships createRole databaseExists roleExists

Constructors

constructor

new ServerClient(client: Client): ServerClient
Creates a new ServerClient.
Parameters
- client: Client
  The pg Client instance
Returns ServerClient

Methods

createDatabase

createDatabase(catalog: Catalog): Promise<void>
Create a new database catalog only if it does not already exist.
Parameters
- catalog: Catalog
  The database catalog to create
Returns Promise<void>
A Promise that resolves when the operation completes

createGrant

createGrant(grant: Grant): Promise<void>
Execute a grant statement.
Parameters
- grant: Grant
  The grant to perform
Returns Promise<void>
A Promise that resolves when the operation completes

createMemberships

createMemberships(role: Role, members: Role[]): Promise<Membership[]>
Grants membership in a role to each of the given roles.

Role memberships apply to the entire server, not to a single database. The connected user must have ADMIN OPTION on the role, such as the CREATEROLE user that created it.
Parameters
- role: Role
  The role in which membership is granted
- members: Role[]
  The roles to receive membership
Returns Promise<Membership[]>
A Promise that resolves to the new memberships

createRole

createRole(role: Role): Promise<void>
Create a new login only if it does not already exist.
Parameters
- role: Role
  The login to create
Returns Promise<void>
A Promise that resolves when the operation completes

databaseExists

databaseExists(name: string): Promise<boolean>
Tests to see if the database already exists.
Parameters
- name: string
  The database name
Returns Promise<boolean>
A Promise that resolves to true if the database exists

roleExists

roleExists(username: string): Promise<boolean>
Tests to see if the user already exists.
Parameters
- username: string
  The username to test
Returns Promise<boolean>
A Promise that resolves to true if the user exists