Breaking change: rename pg_types (parse, deparse)=>(decode, encode), (parser, deparser)=>(rowReader, rowWriter)

Author: jeromew

index.js

@@ -1,5 +1,5 @@
 module.exports = {
-  deparser: require('./lib/deparser'),
-  parser: require('./lib/parser'),
+  rowReader: require('./lib/rowReader'),
+  rowWriter: require('./lib/rowWriter'),
   transform: require('./lib/transform'),
 }

lib/pg_types.js

@@ -119,7 +119,7 @@ const array_send = function (atype, buf, value) {
   const flat = flatten(value)
   const len = flat.length
   for (let i = 0; i < len; i++) {
-    deparse(buf, atype, flat[i])
+    encode(buf, atype, flat[i])
   }
 }
 // note the type is not necessary here because it is embedded inside the
@@ -160,7 +160,7 @@ const array_recv = function (buf) {
   for (let i = 0; i < len; i++) {
     const fieldLen = buf.readUInt32BE(offset)
     offset += UInt32Len
-    flat.push(parse(buf.slice(offset, offset + fieldLen), type))
+    flat.push(decode(buf.slice(offset, offset + fieldLen), type))
     offset += fieldLen
   }
   let size
@@ -199,7 +199,7 @@ const types = {
   _timestamptz: { oid: 1185, send: array_send.bind(null, 'timestamptz'), recv: array_recv },
 }
 
-function deparse(buf, type, value) {
+function encode(buf, type, value) {
   // Add a UInt32  placeholder for the field length
   buf.word32be(0)
   const lenField = buf.words[buf.words.length - 1]
@@ -219,7 +219,7 @@ function deparse(buf, type, value) {
   return buf
 }
 
-function parse(buf, type) {
+function decode(buf, type) {
   return types[type].recv(buf)
 }
 
@@ -229,6 +229,6 @@ function flatten(arr) {
 
 module.exports = {
   types: types,
-  deparse: deparse,
-  parse: parse,
+  encode: encode,
+  decode: decode,
 }

lib/parser.js renamed to lib/rowReader.js

@@ -10,7 +10,7 @@ module.exports = function (txt, options) {
 
 const { Transform } = require('stream')
 const BP = require('bufferput')
-const { parse } = require('./pg_types')
+const { decode } = require('./pg_types')
 const BufferList = require('bl/BufferList')
 
 const PG_HEADER = 0
@@ -105,7 +105,7 @@ class CopyStream extends Transform {
 
       if (PG_FIELD_END === this._state) {
         if (this._fieldBuffer && this.mapping) {
-          this._fieldBuffer = parse(this._fieldBuffer.slice(), this.mapping[this._fieldIndex].type)
+          this._fieldBuffer = decode(this._fieldBuffer.slice(), this.mapping[this._fieldIndex].type)
         }
         if (this.mapping) {
           this._row[this.mapping[this._fieldIndex].key] = this._fieldBuffer

lib/deparser.js renamed to lib/rowWriter.js

@@ -11,7 +11,7 @@ module.exports = function (txt, options) {
 const { Transform } = require('stream')
 
 const BufferPut = require('bufferput')
-const { deparse } = require('./pg_types')
+const { encode } = require('./pg_types')
 
 class CopyStream extends Transform {
   constructor(options = {}) {
@@ -53,7 +53,7 @@ class CopyStream extends Transform {
     let vec
     for (i = 0; i < fieldCount; i++) {
       vec = chunk[i]
-      deparse(buf, vec.type, vec.value)
+      encode(buf, vec.type, vec.value)
     }
 
     this.push(buf.buffer())

lib/transform.js

@@ -1,8 +1,8 @@
 const through2 = require('through2')
 const MultiFork = require('multi-fork')
 
-const parser = require('./parser')
-const deparser = require('./deparser')
+const rowReader = require('./rowReader')
+const rowWriter = require('./rowWriter')
 
 const shift = function () {
   return through2.obj(function (row, _, cb) {
@@ -17,7 +17,7 @@ module.exports = function (opt) {
   const { transform } = opt
   const copyIns = opt.targets
 
-  const first = parser({ mapping: mapping })
+  const first = rowReader({ mapping: mapping })
   const n = copyIns.length
   let f = n
   const finish = function () {
@@ -32,7 +32,7 @@ module.exports = function (opt) {
   const M = new MultiFork(n, { classifier: classifier })
   for (let i = 0; i < n; i++) {
     copyIns[i].on('finish', finish)
-    M.streams[i].pipe(shift()).pipe(deparser()).pipe(copyIns[i])
+    M.streams[i].pipe(shift()).pipe(rowWriter()).pipe(copyIns[i])
   }
   first.pipe(transform).pipe(M)
   return first

test/parse.js renamed to test/decode.js

@@ -4,7 +4,7 @@ const assert = require('assert')
 const util = require('util')
 
 const pgtypes = require('../lib/pg_types')
-const { parse } = pgtypes
+const { decode } = pgtypes
 
 const samples = require('./samples')
 
@@ -23,15 +23,15 @@ function flatten(arr) {
 
 describe('decode', () => {
   samples.forEach(function (s) {
-    it(`parse type ${s.t}: ${util.inspect(s.v)}`, async () => {
+    it(`decode type ${s.t}: ${util.inspect(s.v)}`, async () => {
       const buf = s.r
       const isNull = buf.readInt32BE(0)
       const UInt32Len = 4
       let type = s.t
       if (isNull === -1) {
         assert.equal(buf.length, UInt32Len, 'A "null" binary buffer should be 0xffffffff')
       } else {
-        let result = parse(buf.slice(UInt32Len), s.t)
+        let result = decode(buf.slice(UInt32Len), s.t)
         let expected = s.v
 
         let results = [result]
@@ -66,7 +66,7 @@ describe('decode', () => {
           assert.equal(
             result,
             expected,
-            s.t + ': parsed value is incorrect for ' + s.t + ' expected ' + expected + ', got ' + result
+            s.t + ': decoded value is incorrect for ' + s.t + ' expected ' + expected + ', got ' + result
           )
         }
       }

test/deparse.js renamed to test/encode.js

@@ -2,15 +2,15 @@ const assert = require('assert')
 const util = require('util')
 
 const pgtypes = require('../lib/pg_types')
-const { deparse } = pgtypes
+const { encode } = pgtypes
 
 const BP = require('bufferput')
 const samples = require('./samples')
 
 describe('encode', () => {
   samples.forEach(function (s) {
     it(`encode type ${s.t}: ${util.inspect(s.v)}`, async () => {
-      const buf = deparse(new BP(), s.t, s.v).buffer()
+      const buf = encode(new BP(), s.t, s.v).buffer()
       const eq = buf.equals(s.r)
       assert(
         eq,

test/copy-out.js renamed to test/rowReader.js

@@ -1,6 +1,6 @@
 const assert = require('assert')
 const pg = require('pg')
-const { parser } = require('../')
+const { rowReader } = require('../')
 const { to: copyTo } = require('pg-copy-streams')
 const through2 = require('through2')
 const concat = require('concat-stream')
@@ -48,7 +48,7 @@ describe('integration test - copyOut', () => {
 
     const sql = 'COPY plug TO STDOUT BINARY'
     const copyOut = client.query(copyTo(sql))
-    const p = parser({ objectMode: true, mapping: mapping })
+    const p = rowReader({ objectMode: true, mapping: mapping })
 
     idx = 0
     const pipeline = copyOut.pipe(p).pipe(
@@ -113,7 +113,7 @@ describe('integration test - copyOut', () => {
       assert.deepEqual(arr[0].c1, Buffer.alloc(Math.pow(2, power), '-'))
       done()
     }
-    const p = parser({ objectMode: true, mapping: [{ key: 'c1', type: 'bytea' }] })
+    const p = rowReader({ objectMode: true, mapping: [{ key: 'c1', type: 'bytea' }] })
     p.on('error', (err) => {
       client.end()
       done(err)

test/copy-in.js renamed to test/rowWriter.js

@@ -1,7 +1,7 @@
 const assert = require('assert')
 const util = require('util')
 const pg = require('pg')
-const { deparser } = require('../')
+const { rowWriter } = require('../')
 const { from: copyFrom } = require('pg-copy-streams')
 
 const getClient = function () {
@@ -16,7 +16,7 @@ describe('integration test - copyIn', () => {
     client.query('CREATE TEMP TABLE plug (col1 text)')
     const sql = 'COPY plug FROM STDIN BINARY'
     const copyIn = client.query(copyFrom(sql))
-    const encoder = deparser({ objectMode: true })
+    const encoder = rowWriter({ objectMode: true })
     encoder.pipe(copyIn)
     const cleanup = (err) => {
       done(err)
@@ -74,7 +74,7 @@ describe('integration test - copyIn', () => {
       client.query('CREATE TEMP TABLE plug (col1 ' + coltype + ')')
       const sql = 'COPY plug FROM STDIN BINARY'
       const copyIn = client.query(copyFrom(sql))
-      const encoder = deparser({ objectMode: true })
+      const encoder = rowWriter({ objectMode: true })
       encoder.pipe(copyIn)
       copyIn.on('finish', () => {
         const sql = 'SELECT col1::text FROM plug'