{"id":19223741,"url":"https://github.com/wmfs/tymly-pg-plugin","last_synced_at":"2025-07-07T15:33:36.827Z","repository":{"id":33036632,"uuid":"137052672","full_name":"wmfs/tymly-pg-plugin","owner":"wmfs","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-30T11:04:27.000Z","size":1722,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-06-30T11:10:22.582Z","etag":null,"topics":["plugin","tymly"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wmfs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-06-12T09:59:22.000Z","updated_at":"2025-06-30T11:04:30.000Z","dependencies_parsed_at":"2023-12-05T05:25:27.899Z","dependency_job_id":"71c930e6-603e-4380-8809-812dd03d6f9d","html_url":"https://github.com/wmfs/tymly-pg-plugin","commit_stats":null,"previous_names":[],"tags_count":358,"template":false,"template_full_name":null,"purl":"pkg:github/wmfs/tymly-pg-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmfs%2Ftymly-pg-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmfs%2Ftymly-pg-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmfs%2Ftymly-pg-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmfs%2Ftymly-pg-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wmfs","download_url":"https://codeload.github.com/wmfs/tymly-pg-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wmfs%2Ftymly-pg-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264103321,"owners_count":23557918,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["plugin","tymly"],"created_at":"2024-11-09T15:09:24.576Z","updated_at":"2025-07-07T15:33:36.772Z","avatar_url":"https://github.com/wmfs.png","language":"JavaScript","readme":"# tymly-pg-plugin\n[![Tymly Package](https://img.shields.io/badge/tymly-package-blue.svg)](https://tymly.io/)\n[![npm (scoped)](https://img.shields.io/npm/v/@wmfs/tymly-pg-plugin.svg)](https://www.npmjs.com/package/@wmfs/tymly-pg-plugin)\n[![CircleCI](https://circleci.com/gh/wmfs/tymly-pg-plugin.svg?style=svg)](https://circleci.com/gh/wmfs/tymly-pg-plugin)\n[![codecov](https://codecov.io/gh/wmfs/tymly-pg-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/wmfs/tymly-pg-plugin)\n[![CodeFactor](https://www.codefactor.io/repository/github/wmfs/tymly-pg-plugin/badge)](https://www.codefactor.io/repository/github/wmfs/tymly-pg-plugin)\n[![Dependabot badge](https://img.shields.io/badge/Dependabot-active-brightgreen.svg)](https://dependabot.com/)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly-pg-plugin/blob/master/LICENSE)\n\n\n\u003e Plugin for [TymlyJS](http://www.tymlyjs.io) that provides PostgreSQL persistence\n\n## \u003ca name=\"install\"\u003e\u003c/a\u003eInstall\n```bash\n$ npm install pg-info --save\n```\n\n## \u003ca name=\"services\"\u003e\u003c/a\u003eServices\n### Audit\nThe audit service allows Tymly to keep a history of change in records. \n\nIf 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.\n\nThis service will pick up any file in the /pg-scripts directory of a blueprint with the following file naming convention: \n```audit-{function-name}.sql``` where {function-name} is the name of your function.\n\nThis function will then be applied to all models by default unless they have ```\"audit\":false```.\n \n### Storage\nKeeps storage of relevant blueprint objects and creates them in the database provided at PG_CONNECTION_STRING.\n\n## \u003ca name=\"test\"\u003e\u003c/a\u003eTesting\n\nBefore 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:\n\n```PG_CONNECTION_STRING=postgres://postgres:postgres@localhost:5432/my_test_db```\n\n```bash\n$ npm test\n```\n\n## \u003ca name=\"license\"\u003e\u003c/a\u003eLicense\n\nMIT\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwmfs%2Ftymly-pg-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwmfs%2Ftymly-pg-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwmfs%2Ftymly-pg-plugin/lists"}