Module types (0.6.0)

API documentation for bigquery_storage_v1beta1.types module.

Classes

ArrowRecordBatch

Arrow RecordBatch.

The count of rows in the returning block.

ArrowSchema

Arrow schema.

AvroRows

Avro rows.

The count of rows in the returning block.

AvroSchema

Avro schema.

BatchCreateReadSessionStreamsRequest

Information needed to request additional streams for an established read session.

Required. Number of new streams requested. Must be positive. Number of added streams may be less than this, see CreateReadSessionRequest for more information.

BatchCreateReadSessionStreamsResponse

The response from BatchCreateReadSessionStreams returns the stream identifiers for the newly created streams.

CreateReadSessionRequest

Creates a new read session, which may include additional options such as requested parallelism, projection filters and constraints.

Required. String of the form projects/{project_id} indicating the project this ReadSession is associated with. This is the project that will be billed for usage.

Optional. Initial number of streams. If unset or 0, we will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table and the maximum amount of parallelism allowed by the system. Streams must be read starting from offset 0.

Data output format. Currently default to Avro.

Empty

API documentation for bigquery_storage_v1beta1.types.Empty class.

FinalizeStreamRequest

Request information for invoking FinalizeStream.

ReadRowsRequest

Requesting row data via ReadRows must provide Stream position information.

ReadRowsResponse

Response from calling ReadRows may include row data, progress and throttling information.

Serialized row data in AVRO format.

Number of serialized rows in the rows block. This value is recorded here, in addition to the row_count values in the output-specific messages in rows, so that code which needs to record progress through the stream can do so in an output format-independent way.

Throttling status. If unset, the latest response still describes the current throttling status.

ReadSession

Information returned from a CreateReadSession request.

Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors.

Avro schema.

Streams associated with this session.

Any modifiers which are applied when reading from the specified table.

SplitReadStreamRequest

Request information for SplitReadStream.

A value in the range (0.0, 1.0) that specifies the fractional point at which the original stream should be split. The actual split point is evaluated on pre-filtered rows, so if a filter is provided, then there is no guarantee that the division of the rows between the new child streams will be proportional to this fractional value. Additionally, because the server-side unit for assigning data is collections of rows, this fraction will always map to to a data storage boundary on the server side.

SplitReadStreamResponse

Response from SplitReadStream.

Remainder stream, which contains the tail of |original_stream|. An empty value indicates that the original stream can no longer be split.

Stream

Information about a single data stream within a read session.

StreamPosition

Expresses a point within a given stream using an offset position.

Position in the stream.

StreamStatus

Progress information for a given Stream.

A value in the range [0.0, 1.0] that represents the fraction of rows assigned to this stream that have been processed by the server. In the presence of read filters, the server may process more rows than it returns, so this value reflects progress through the pre-filtering rows. This value is only populated for sessions created through the BALANCED sharding strategy.

TableModifiers

All fields in this message optional.

TableReadOptions

Options dictating how we read a table.

Optional. SQL text filtering statement, similar to a WHERE clause in a query. Currently, only a single predicate that is a comparison between a column and a constant value is supported. Aggregates are not supported. Examples: "int_field > 5" "date_field = CAST('2014-9-27' as DATE)" "nullable_field is not NULL" "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))" "numeric_field BETWEEN 1.0 AND 5.0"

TableReference

Table reference that includes just the 3 strings needed to identify a table.

The ID of the dataset in the above project.

ThrottleStatus

Information on if the current connection is being throttled.

Timestamp

API documentation for bigquery_storage_v1beta1.types.Timestamp class.