https://github.com/plumdog/pg-access-apply

Idempotent postgres database and role management
https://github.com/plumdog/pg-access-apply

Last synced: about 1 month ago
JSON representation

Idempotent postgres database and role management

• Host: GitHub
• URL: https://github.com/plumdog/pg-access-apply
• Owner: plumdog
• License: mit
• Created: 2021-10-17T19:25:08.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-16T22:52:39.000Z (about 3 years ago)
• Last Synced: 2024-10-14T02:27:24.421Z (3 months ago)
• Language: TypeScript
• Size: 973 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pg-access-apply

Idempotent postgres database and role management

[Docs](https://www.plumdog.co.uk/pg-access-apply/)

[![npm version](https://badge.fury.io/js/pg-access-apply.svg)](https://badge.fury.io/js/pg-access-apply)

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

```typescript

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)