dbf-vfpro
v1.0.3
Published
dbf-parser for Visual FoxPro ========
Downloads
4
Readme
dbf-vfpro
This fork has been modified to work with Visual Foxpro and Integer values
This is an event-based dBase file parser for very efficiently reading data from Visual FoxPro *.dbf files.
Based on https://github.com/abstractvector/node-dbf but works without coffee and provides float and integer type of numbers, specifically for Visual Fox Pro *dbf files, based on the specification for DBF files here: http://www.independent-software.com/dbase-dbf-dbt-file-format.html
To get started, simply install the module using npm:
npm install dbf-vfpro
and then require
it:
const Parser = require('dbf-vfpro');
Classes
There are two classes - the Parser
and the Header
. The Parser
is the most interesting class.
Parser
This class is the main interface for reading data from dBase files. It extends EventEmitter
and its output is via events.
new Parser(path)
- path
String
The full path to the .dbf file to parse
Creates a new Parser and attaches it to the specified filename.
const Parser = require('dbf-vfpro');
let parser = new Parser('/path/to/my/dbase/file.dbf');
parser.on(event, listener)
- event
String
The event name to listen for (see below for details) - listener
Function
The callback to bind to the event
This method is inherited from the EventEmitter
class.
parser.parse()
Call this method once you have bound to the events you are interested in. Although it returns the parser object (for chaining), all the dBase data is outputted via events.
parser.parse();
Event: 'start'
- parser
Parser
The parser object
This event is emitted as soon as the parser.parse()
method has been invoked.
Event: 'header'
- header
Header
The header object as parsed from the dBase file
This event is emitted once the header has been parsed from the dBase file
Event: 'record'
- record
Object
An object representing the record that has been found
The record object will have a key for each field within the record, named after the field. It is trimmed (leading and trailing) of any blank characters (dBase files use \x20 for padding).
In addition to the fields, the object contains two special keys:
- @sequenceNumber
Number
indicates the order in which it was extracted - @deleted
Boolean
whether this record has been deleted or not
This object may look like:
{
"@sequenceNumber": 123,
"@deleted": false,
"firstName": "John",
"lastName": "Smith
}
Event: 'end'
- parser
Parser
The parser object
This event is fired once the dBase parsing is complete and there are no more records remaining.
Usage
The following code example illustrates a very simple usage for this module:
const Parser = require('dbf-vfpro');
let parser = new Parser('/path/to/my/dbase/file.dbf');
parser.on('start', function(p) {
console.log('dBase file parsing has started');
});
parser.on('header', function(h) {
console.log('dBase file header has been parsed');
});
parser.on('record', function(record) {
console.log('Name: ' + record.firstName + ' ' + record.lastName); // Name: John Smith
});
parser.on('end', function(p) {
console.log('Finished parsing the dBase file');
});
parser.parse();
TODO
- Write some tests
- Add support for field types other than Character and Numeric
- Use
fs.readStream
instead offs.readFile
for increased performance