@wmfs/pg-telepods

pg-telepods

Takes the contents of one PostgreSQL table, applies a transformation function to each row and ensures a target table is kept in sync

Install

$ npm install pg-telepods --save

Usage

const pg = require('pg')
const startTelepods = require('pg-telepods')

// Make a new Postgres client
const client = new pg.Client('postgres://postgres:postgres@localhost:5432/my_test_db')
client.connect()

// Start the Telepods...

startTelepods(
  {
    client: client,
    outputDir: '/some/temp/dir',
    source: {  
      tableName: 'springfield.people',
      hashSumColumnName: 'hash_sum'
    },
    target: {
      tableName: 'government.census',
      hashSumColumnName: 'origin_hash_sum'
    },
    join: {
      'social_security_id': 'social_security_id' // key = source table column, value = target table column
    },
    transformFunction: function (sourceRow, callback) {
      callback(null, {
        'socialSecurityId': sourceRow.socialSecurityId,
        'name': sourceRow.firstName + ' ' + sourceRow.lastName,
        'town': 'Springfield'
      })
    }
  },
  function (err) {
    // All data synchronized from people -> census.
  }
)

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

Changelog

1.96.0 (2022-10-17)

🛠 Builds

• deps-dev: update dependency chai to v4.3.6 (892aa96)
• deps-dev: update dependency mocha to v10 (dc43eb7)
• deps-dev: update dependency mocha to v10.1.0 (a5f7b5f)
• deps-dev: update dependency mocha to v9.2.1 (2c50c1d)
• deps-dev: update dependency mocha to v9.2.2 (f99f242)
• deps-dev: update dependency semantic-release to v19.0.3 (4642dd7)
• deps-dev: update dependency semantic-release to v19.0.5 (9ce6206)
• deps-dev: update dependency standard to v17 (b3e62c5)
• deps: update dependency pg to v8.8.0 (cff7b11)