pg-access-apply

pg-access-apply

Idempotent postgres database and role management

Docs

Loosely, this manages resources that are configured and then handed over to an application to use. Eg: you create a database and a role, then pass this configuration over to an application which creates and manages tables etc within that database. The goal of this library is to manage things like databases and roles.

Getting started

import { Client } from 'pg';
import { pg_applier } from 'pg-access-apply';

// Create a database client and connect
const client = new Client({ ... });
client.connect();
try {
    // Pass a 'query' function to pg_applier
    const applier = pg_applier({
        query: client.query.bind(client),
    });

    // Ensure database 'mydatabase' exists
    await applier.database({
        name: 'mydatabase',
    });

    // Ensure role 'myrole' exists and has password 'mypassword'
    await applier.role({
        name: 'myrole',
        properties: {
            password: 'mypassword',
            login: true,
        },
    });

    // Ensure role 'myrole' has all privileges on database 'mydatabase'
    await applierDb.grantOnDatabase({
        roles: ['myrole'],
        properties: {
            allPrivileges: true,
            databases: ['mydatabase'],
        },
    });
} finally {
    client.end();
}

Supported Postgres resources

• Database
• Role (aka User, aka Group)
• Tablespace (TODO: https://github.com/plumdog/pg-access-apply/issues/11)
• Schema (TODO: https://github.com/plumdog/pg-access-apply/issues/12)
• Role privileges on:
  • Tables
  • Table columns (TODO: https://github.com/plumdog/pg-access-apply/issues/13)
  • Sequences (TODO: https://github.com/plumdog/pg-access-apply/issues/14)
  • Foreign data wrappers (TODO: https://github.com/plumdog/pg-access-apply/issues/15)
  • Foreign servers (TODO: https://github.com/plumdog/pg-access-apply/issues/16)
  • Functions (TODO: https://github.com/plumdog/pg-access-apply/issues/17)
  • Languages (TODO: https://github.com/plumdog/pg-access-apply/issues/18)
  • Large objects (TODO: https://github.com/plumdog/pg-access-apply/issues/19)
  • Schemas (TODO: https://github.com/plumdog/pg-access-apply/issues/20)
  • Tablespaces (TODO: https://github.com/plumdog/pg-access-apply/issues/21)
  • Other roles (TODO: https://github.com/plumdog/pg-access-apply/issues/22)

Changelog

0.1.5

• Add a getting started example 7761a33
• Record outstanding resources df52e58
• Export all types for documentation 56aa60a