ReadStream is responsible for reading data from a GRPC read stream connection against the Storage Read API readRows method.
EventEmitter reader
Package
@google-cloud/bigquery-storageConstructors
(constructor)(streamName, session, readClient, options)
constructor(streamName: string, session: ReadSession, readClient: ReadClient, options?: gax.CallOptions);Constructs a new instance of the ReadStream class
| Parameters | |
|---|---|
| Name | Description |
streamName |
string
|
session |
ReadSession
|
readClient |
ReadClient
|
options |
CallOptions
|
Properties
getStreamName
getStreamName: () => string;Get the name of the read stream associated with this connection.
Methods
close()
close(): void;Close the read stream connection.
| Returns | |
|---|---|
| Type | Description |
void |
|
getReadSession()
getReadSession(): ReadSession;| Returns | |
|---|---|
| Type | Description |
ReadSession |
|
getRowsStream()
getRowsStream(): Readable;| Returns | |
|---|---|
| Type | Description |
Readable |
|
isOpen()
isOpen(): boolean;Check if connection is open and ready to read data.
| Returns | |
|---|---|
| Type | Description |
boolean |
|
open()
open(): void;| Returns | |
|---|---|
| Type | Description |
void |
|
reconnect()
reconnect(): void;Reconnect and re-open readRows channel.
| Returns | |
|---|---|
| Type | Description |
void |
|