Class: RecordStream

RecordStream

<abstract> new RecordStream()

Class for Record Stream
Source:

Extends

  • events.EventEmitter

Classes

CSVStream

Methods

<static> filter(fn) → {RecordStream}

Create a record stream which filters records and pass them to downstream
Parameters:
Name Type Description
fn RecordFilterFunction Record filtering function
Source:
Returns:
Type
RecordStream

<static> map(fn) → {RecordStream}

Create a record stream which maps records and pass them to downstream
Parameters:
Name Type Description
fn RecordMapFunction Record mapping function
Source:
Returns:
Type
RecordStream

<static> recordMapStream(record, noeval) → {RecordStream}

Create mapping stream using given record template
Parameters:
Name Type Argument Description
record Record Mapping record object. In mapping field value, temlate notation can be used to refer field value in source record, if noeval param is not true.
noeval Boolean <optional>
 Disable template evaluation in mapping record.
Source:
Returns:
Type
RecordStream

destroy()

Destroy record stream;
Source:

destroySoon()

Destroy record stream after all record submission in the queue;
Source:

end()

End sending records into stream.
Source:

filter(fn) → {RecordStream}

Filtering incoming record from upstream, and pass to downstream
Parameters:
Name Type Description
fn RecordFilterFunction Record filtering function
Source:
Returns:
Type
RecordStream

map(fn) → {RecordStream}

Mapping incoming record from upstream, and pass to downstream
Parameters:
Name Type Description
fn RecordMapFunction Record mapping function
Source:
Returns:
Type
RecordStream

pipe(dest, options) → {RecordStream}

Streaming pipe for record manipulation Originally from Node.js's Stream#pipe https://github.com/joyent/node/blob/master/lib/stream.js
Parameters:
Name Type Argument Description
dest RecordStream Destination output stream for records
options Object <optional>
Source:
Returns:
Type
RecordStream

<abstract> resume()

Resume record fetch and query execution
Source:

send(record)

Output record into stream.
Parameters:
Name Type Description
record Record Record object
Source:

stream() → {stream.Stream}

Create Node.js stream instance for serializing/deserialize records
Source:
Returns:
Type
stream.Stream