ChunkTransformer formats all incoming chunks in to row keeps all intermediate state until end of stream. Should use new instance for each request.
Inheritance
Transform > ChunkTransformerPackage
@google-cloud/bigtableConstructors
(constructor)(options)
constructor
(
options
?:
TransformOptions
);
Constructs a new instance of the ChunkTransformer
class
options
TransformOptions
Properties
_destroyed
_destroyed
:
boolean
;
family
family
?:
Family
;
lastRowKey
lastRowKey
?:
Value
;
options
options
:
TransformOptions
;
qualifier
qualifier
?:
Qualifier
;
qualifiers
qualifiers
?:
Qualifier
[];
row
row
?:
Row
;
state
state
?:
number
;
Methods
_flush(cb)
_flush
(
cb
:
Function
)
:
void
;
called at end of the stream.
cb
Function
callback will be called with error if there is any uncommitted row
void
_transform(data, enc, next)
_transform
(
data
:
Data
,
enc
:
string
,
next
:
Function
)
:
void
;
transform the readrowsresponse chunks into friendly format. Chunks contain 3 properties:
rowContents
The row contents, this essentially is all data pertaining to a single family.
commitRow
This is a boolean telling us the all previous chunks for this row are ok to consume.
resetRow
This is a boolean telling us that all the previous chunks are to be discarded.
data
enc
string
encoding options.
next
Function
callback will be called once data is processed, with error if any error in processing
void
commit()
commit
()
:
void
;
sets lastRowkey and calls reset when row is committed.
void
destroy(err)
destroy
(
err
?:
Error
)
:
this
;
called when stream is destroyed.
err
Error
error if any
this
moveToNextState(chunk)
moveToNextState
(
chunk
:
Chunk
)
:
void
;
Moves to next state in processing.
void
processCellInProgress(chunk)
processCellInProgress
(
chunk
:
Chunk
)
:
void
;
Process chunk when in CELl_IN_PROGRESS state.
void
processNewRow(chunk)
processNewRow
(
chunk
:
Chunk
)
:
void
;
Process chunk when in NEW_ROW state.
void
processRowInProgress(chunk)
processRowInProgress
(
chunk
:
Chunk
)
:
void
;
Process chunk when in ROW_IN_PROGRESS state.
void
reset()
reset
()
:
void
;
Resets state of formatter
void
validateCellInProgress(chunk)
validateCellInProgress
(
chunk
:
Chunk
)
:
void
;
Validates chunk for cellInProgress state.
void
validateNewRow(chunk, newRowKey)
validateNewRow
(
chunk
:
Chunk
,
newRowKey
:
string
|
Buffer
)
:
void
;
Validates state for new row.
chunk
newRowKey
string | __global.Buffer
newRowKey of the new row
void
validateResetRow(chunk)
validateResetRow
(
chunk
:
Chunk
)
:
void
;
Validates resetRow condition for chunk
void
validateRowInProgress(chunk)
validateRowInProgress
(
chunk
:
Chunk
)
:
void
;
Validates state for rowInProgress
void
validateValueSizeAndCommitRow(chunk)
validateValueSizeAndCommitRow
(
chunk
:
Chunk
)
:
void
;
Validates valuesize and commitrow in a chunk
void