npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@digigov-oss/auditrecord-postgresql-engine

v1.0.2

Published

PostgreSQL storage database for use with audit mechanism of GSIS

Downloads

9

Readme

AuditRecordPostgreSqlEngine

Complementary engine for AuditRecordDB module to use famous PostgreSQL DB for storage.

Prostgresql instalation

To work with Postgresql, you need to use PostgresqlEngine instead of FileEngine Moreover, have to install the native libpg library for Postgresql.

  • On macOS: brew install libpq
  • On Ubuntu/Debian: apt-get install libpq-dev g++ make
  • On RHEL/CentOS: yum install postgresql-devel

To make it work, pass environment variables according to the documentation of the LIBPGSQL library. https://www.postgresql.org/docs/9.1/libpq-envars.html

Please remember that protocol and/or transaction id sequences will be created in the database if not provided.

You can set the reset protocol number type at "daily","monthly" or "yearly". By default, it is "innumerable", i.e. never resets.

If you select one of the reset types, a new sequence will be created in the database for protocol needs as protxxxxx_seq. So if you do not need to keep tracking on application, you may need to clean up those sequences from time to time using a cron job.

Examples

//you can use the PostgresSqlEngine via enviroment variables
import auditRecordDB from '@digigov-oss/gsis-audit-record-db';
import {PostgreSqlEngine} from '@digigov-oss/auditrecord-postgresql-engine';
const main = () =>{
process.env.PGHOST='localhost'
process.env.PGUSER='dbuser'
process.env.PGPASSWORD='secretpassword'
process.env.PGDATABASE='audit'
process.env.PGPORT='5432'

console.log(auditRecordDB({},new PostgresSqlEngine()))
}
//or via connection string
import auditRecordDB from '@digigov-oss/gsis-audit-record-db';
import {PostgreSqlEngine} from '@digigov-oss/auditrecord-postgresql-engine';
const connectionString = 'postgresql://dbuser:secretpassword@localhost:5432/audit'
const main = () =>{
console.log(auditRecordDB({},new PostgresSqlEngine(connectionString)))
}
//The postgresql engine asumes that you have already create the table `audit_records` in the database, and that the table has the following columns:
//auditUnit: text
//auditTransactionId: text
//auditProtocol: text
//auditTransactionDate: text
//auditUserIp: text
//auditUserId: text
//
//if you have already a table on Postgresql you can use it by mapping the columns to the AuditRecord
import auditRecordDB from '@digigov-oss/gsis-audit-record-db';
import {PostgreSqlEngine} from '@digigov-oss/auditrecord-postgresql-engine';
const connectionString = 'postgresql://dbuser:secretpassword@localhost:5432/audit'
const main = () =>{
console.log(auditRecordDB({},new PostgresSqlEngine(connectionString,{
tableName:'audit_records',
columns:{
  auditUnit:'audit_unit',
  auditTransactionId:'audit_transaction_id',
  auditProtocol:'audit_protocol',
  auditTransactionDate:'audit_transaction_date',
  auditUserIp:'audit_user_ip',
  auditUserId:'audit_user_id'
  }
})))
}