pgfilter.js

#!/usr/bin/env node

import yargs from 'yargs/yargs'
import { hideBin } from 'yargs/helpers'
import input from './lib/input.js'
import { validJSONFile, validBackupFile, validBuffer } from './lib/utils.js'

const pgfilter = yargs(hideBin(process.argv))
  .scriptName('pgfilter')
  .env('PGFILTER')
  .version()
  .option('f', {
    alias: 'file',
    describe: 'Path to the filtering/transformation JSON file. env: PGFILTER_FILE',
    type: 'string',
    demandOption: true,
    normalize: true,
    coerce: (f) => validJSONFile(f, 'file')
  })
  .option('b', {
    alias: 'buffer-length',
    describe: 'Set internal stream transformation buffer size. There is no limit by default. If set, process will throw an error as soon the buffer exceed the limit. Use --skip to avoid exit the whole process. env: PGFILTER_BUFFER_LENGTH',
    type: 'number',
    default: undefined,
    coerce: (b) => validBuffer(b, 'buffer')
  })
  .option('s', {
    alias: 'skip-overflow',
    describe: 'If set, the line that exceed the internal buffer will be ignored and the process will not exit. env: PGFILTER_SKIP_OVERFLOW',
    type: 'boolean',
    default: false
  })
  .option('v', {
    alias: 'verbose',
    describe: 'Show debug messages in STDERR',
    type: 'boolean',
    default: false
  })
  .usage('$0 [backup_file]', 'Filter/Transform rows during restore process for Postgres databases. For more detailed information check: https://github.com/rebelstackio/pgfilter', (yargs) => {
    yargs.positional('backup_file', {
      describe: 'Path to the Postgres Backup file.',
      type: 'string',
      default: null,
      defaultDescription: 'null. pgfilter Use STDIN by default',
      normalize: true,
      coerce: (b) => validBackupFile(b, 'backup_file')
    }).example([
      ['$0 -f ~/config.json mydb.dump | psql -p "$PGPORT" --dbname=mydb', 'Restore an anonymized version of the database']
    ])
  }).argv

input(pgfilter)