Interface BigQueryStorageGrpc.AsyncService (2.36.0)

public static interface BigQueryStorageGrpc.AsyncService

BigQuery storage API. The BigQuery storage API can be used to read data stored in BigQuery.


batchCreateReadSessionStreams(Storage.BatchCreateReadSessionStreamsRequest request, StreamObserver<Storage.BatchCreateReadSessionStreamsResponse> responseObserver)

public default void batchCreateReadSessionStreams(Storage.BatchCreateReadSessionStreamsRequest request, StreamObserver<Storage.BatchCreateReadSessionStreamsResponse> responseObserver)

Creates additional streams for a ReadSession. This API can be used to dynamically adjust the parallelism of a batch processing task upwards by adding additional workers.


createReadSession(Storage.CreateReadSessionRequest request, StreamObserver<Storage.ReadSession> responseObserver)

public default void createReadSession(Storage.CreateReadSessionRequest request, StreamObserver<Storage.ReadSession> responseObserver)

Creates a new read session. A read session divides the contents of a BigQuery table into one or more streams, which can then be used to read data from the table. The read session also specifies properties of the data to be read, such as a list of columns or a push-down filter describing the rows to be returned. A particular row can be read by at most one stream. When the caller has reached the end of each stream in the session, then all the data in the table has been read. Read sessions automatically expire 24 hours after they are created and do not require manual clean-up by the caller.


finalizeStream(Storage.FinalizeStreamRequest request, StreamObserver<Empty> responseObserver)

public default void finalizeStream(Storage.FinalizeStreamRequest request, StreamObserver<Empty> responseObserver)

Triggers the graceful termination of a single stream in a ReadSession. This API can be used to dynamically adjust the parallelism of a batch processing task downwards without losing data. This API does not delete the stream -- it remains visible in the ReadSession, and any data processed by the stream is not released to other streams. However, no additional data will be assigned to the stream once this call completes. Callers must continue reading data on the stream until the end of the stream is reached so that data which has already been assigned to the stream will be processed. This method will return an error if there are no other live streams in the Session, or if SplitReadStream() has been called on the given Stream.


readRows(Storage.ReadRowsRequest request, StreamObserver<Storage.ReadRowsResponse> responseObserver)

public default void readRows(Storage.ReadRowsRequest request, StreamObserver<Storage.ReadRowsResponse> responseObserver)

Reads rows from the table in the format prescribed by the read session. Each response contains one or more table rows, up to a maximum of 10 MiB per response; read requests which attempt to read individual rows larger than this will fail. Each request also returns a set of stream statistics reflecting the estimated total number of rows in the read stream. This number is computed based on the total table size and the number of active streams in the read session, and may change as other streams continue to read data.


splitReadStream(Storage.SplitReadStreamRequest request, StreamObserver<Storage.SplitReadStreamResponse> responseObserver)

public default void splitReadStream(Storage.SplitReadStreamRequest request, StreamObserver<Storage.SplitReadStreamResponse> responseObserver)

Splits a given read stream into two Streams. These streams are referred to as the primary and the residual of the split. The original stream can still be read from in the same manner as before. Both of the returned streams can also be read from, and the total rows return by both child streams will be the same as the rows read from the original stream. Moreover, the two child streams will be allocated back to back in the original Stream. Concretely, it is guaranteed that for streams Original, Primary, and Residual, that Original[0-j] = Primary[0-j] and Original[j-n] = Residual[0-m] once the streams have been read to completion. This method is guaranteed to be idempotent.