@wmfs/tymly-pg-plugin

    1.256.0 • Public • Published

    tymly-pg-plugin

    Tymly Package npm (scoped) CircleCI codecov CodeFactor Dependabot badge Commitizen friendly JavaScript Style Guide license

    Plugin for TymlyJS that provides PostgreSQL persistence

    Install

    $ npm install pg-info --save

    Services

    Audit

    The audit service allows Tymly to keep a history of change in records.

    If you do not want a model to keep a history of changes then add the flag "audit": false to it's json definition. Tymly will store this history in the 'rewind' model.

    This service will pick up any file in the /pg-scripts directory of a blueprint with the following file naming convention: audit-{function-name}.sql where {function-name} is the name of your function.

    This function will then be applied to all models by default unless they have "audit":false.

    Storage

    Keeps storage of relevant blueprint objects and creates them in the database provided at PG_CONNECTION_STRING.

    Testing

    Before running these tests, you'll need a test PostgreSQL database available and set a PG_CONNECTION_STRING environment variable to point to it, for example:

    PG_CONNECTION_STRING=postgres://postgres:postgres@localhost:5432/my_test_db

    $ npm test

    License

    MIT

    Install

    npm i @wmfs/tymly-pg-plugin

    DownloadsWeekly Downloads

    138

    Version

    1.256.0

    License

    MIT

    Unpacked Size

    259 kB

    Total Files

    122

    Last publish

    Collaborators

    • wmfsbot