comparative-parquet v1.0.0

Parquet Node.js bindings

Uses Apache Arrow to provide native bindings for parquet files in nodejs.

const parquet = require('comparative-parquet')
const reader = parquet.ParquetReader.openFile('file.parquet')

console.log(reader)
console.log(reader.getFilepath())
console.log(reader.getColumnNames())
console.log(reader.getColumnCount())
console.log(reader.getRowCount())

console.log(reader.readRow(0))

console.log(reader.readRowAsArray(0))
console.log(reader.readRowAsArray(1))
console.log(reader.readRowAsArray(2))
console.log(reader.readRowAsArray(3))

reader.close()

ParquetReader.openFile can also take as input a directory path, with files that are all parquet files with matching schemas, and will operate on them as if they were a single file.

const { ParquetWriter, type, timeUnit } = require('comparative-parquet')

const schema = {
  field_0: { type: type.INT32 },
  field_1: { type: type.STRING },
  field_2: { 
    type: type.TIMESTAMP,
    unit: timeUnit.MILLI,
  },
  field_3: {
    type:  type.FIXED_SIZE_BINARY,
    width: 8,
  }
}

const writer = new ParquetWriter(schema, 'example-out.parquet')
writer.open()
writer.appendRow([
  1,
  'As an array',
  2,
  Buffer.from('eightchr'),
])
writer.appendRowObject({
  field_0: 2,
  field_1: 'As a dict',
  field_2: 3,
  field_3: Buffer.from('eightchr'),
})
writer.close()

TIMESTAMP, TIME32, and TIME64 all take an additional unit argument from the timeUnit enum. TIMESTAMP supports MILLI, MICRO, and NANO. TIME32 supports only MILLI while TIME64 supports NANO and MICRO.

FIXED_SIZE_BINARY takes an additional width argument representing the byte width of the field. All inputs to this column must be exactly that wide or an exception will be thrown.

Development

To develop this module, after running npm install, node-gyp is the build tool used for nodejs native modules. The NPM scripts in package.json show how to run the command. For development, run npm run configure:debug once, then npm run build to rebuild the module after doing some changes.

NOTE: Before configuring & building, you may want to run npm run compile-commands that will generate a compile-commands.json file to provide correct auto-completion for most editors running an LSP/intellisense server.

The bindings.gyp file provides the build configuration for node-gyp. It needs to contain all files (compilation units) that are part of the module as well as any library or build flag required. Every time a new C++ file is added to the project, add it there and run again the configuration and compile-commands scripts.