Google BigQuery Storage v1 API - Class BigQueryRead.BigQueryReadBase (3.13.0)

[BindServiceMethod(typeof(BigQueryRead), "BindService")]
public abstract class BigQueryRead.BigQueryReadBase

Reference documentation and code samples for the Google BigQuery Storage v1 API class BigQueryRead.BigQueryReadBase.

Base class for server-side implementations of BigQueryRead

Inheritance

object > BigQueryRead.BigQueryReadBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Methods

CreateReadSession(CreateReadSessionRequest, ServerCallContext)

public virtual Task<ReadSession> CreateReadSession(CreateReadSessionRequest request, ServerCallContext context)

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.

Data is assigned to each stream such that roughly the same number of rows can be read from each stream. Because the server-side unit for assigning data is collections of rows, the API does not guarantee that each stream will return the same number or rows. Additionally, the limits are enforced based on the number of pre-filtered rows, so some filters can lead to lopsided assignments.

Read sessions automatically expire 6 hours after they are created and do not require manual clean-up by the caller.

Parameters
Name	Description
`request`	`CreateReadSessionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskReadSession`	The response to send back to the client (wrapped by a task).

ReadRows(ReadRowsRequest, IServerStreamWriter<ReadRowsResponse>, ServerCallContext)

public virtual Task ReadRows(ReadRowsRequest request, IServerStreamWriter<ReadRowsResponse> responseStream, ServerCallContext context)

Reads rows from the stream in the format prescribed by the ReadSession. Each response contains one or more table rows, up to a maximum of 100 MiB per response; read requests which attempt to read individual rows larger than 100 MiB will fail.

Each request also returns a set of stream statistics reflecting the current state of the stream.

Parameters
Name	Description
`request`	`ReadRowsRequest` The request received from the client.
`responseStream`	`IServerStreamWriterReadRowsResponse` Used for sending responses back to the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task`	A task indicating completion of the handler.

SplitReadStream(SplitReadStreamRequest, ServerCallContext)

public virtual Task<SplitReadStreamResponse> SplitReadStream(SplitReadStreamRequest request, ServerCallContext context)

Splits a given ReadStream into two ReadStream objects. These ReadStream objects are referred to as the primary and the residual streams of the split. The original ReadStream can still be read from in the same manner as before. Both of the returned ReadStream objects can also be read from, and the rows returned 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 ReadStream. 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.

Parameters
Name	Description
`request`	`SplitReadStreamRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSplitReadStreamResponse`	The response to send back to the client (wrapped by a task).