Class RowQueue (7.5.2)

Version 7.5.2

• 7.8.0 (latest)
• 7.7.0
• 7.6.1
• 7.5.2
• 7.4.0
• 7.3.0
• 7.2.0
• 7.1.1
• 7.0.0
• 6.2.1
• 6.0.3
• 5.12.0
• 5.11.0
• 5.10.0
• 5.9.3
• 5.8.0
• 5.7.1
• 5.6.0
• 5.5.0

Standard row queue used for inserting rows.

Package

@google-cloud/bigquery

Constructors

(constructor)(table, dup, options)

constructor(table: Table, dup: Stream, options?: InsertStreamOptions);

Constructs a new instance of the RowQueue class

Parameters
Name	Description
table	Table
dup	Stream
options	InsertStreamOptions

Properties

batch

batch: RowBatch;

batchOptions

batchOptions?: RowBatchOptions;

inFlight

inFlight: boolean;

insertRowsOptions

insertRowsOptions: InsertRowsOptions;

pending

pending?: ReturnType<typeof setTimeout>;

stream

stream: Stream;

table

table: Table;

Methods

_insert(rows, callbacks, cb)

_insert(rows: RowMetadata | RowMetadata[], callbacks: InsertRowsCallback[], cb?: InsertRowsCallback): void;

Accepts a batch of rows and inserts them into table.

Parameters
Name	Description
rows	RowMetadata | RowMetadata[] The rows to insert.
callbacks	InsertRowsCallback_2[] The corresponding callback functions.
cb	InsertRowsCallback

Returns
Type	Description
void

add(row, callback)

add(row: RowMetadata, callback: InsertRowsCallback): void;

Adds a row to the queue.

Parameters
Name	Description
row	RowMetadata The row to insert.
callback	InsertRowsCallback The insert callback.

Returns
Type	Description
void

getOptionDefaults()

getOptionDefaults(): RowBatchOptions;

Returns
Type	Description
RowBatchOptions

insert(callback)

insert(callback?: InsertRowsCallback): void;

Cancels any pending inserts and calls _insert immediately.

Parameter
Name	Description
callback	InsertRowsCallback

Returns
Type	Description
void

setOptions(options)

setOptions(options?: RowBatchOptions): void;

Sets the batching options.

Parameter
Name	Description
options	RowBatchOptions The batching options.

Returns
Type	Description
void