Summary of entries of Classes for bigquerystorage.
Classes
BigQueryReadClient
Client for interacting with BigQuery Storage API.
The BigQuery storage API can be used to read data stored in BigQuery.
BigQueryWriteClient
BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see:
ReadRowsIterable
An iterable of rows from a read session.
ReadRowsPage
An iterator of rows from a read session message.
ReadRowsStream
A stream of results from a read rows request.
This stream is an iterable of ReadRowsResponse. Iterate over it to fetch all row messages.
If the fastavro library is installed, use the rows() method to parse all messages into a stream of row dictionaries.
If the pandas and fastavro libraries are installed, use the
to_dataframe()
method to parse all messages into a pandas.DataFrame.
This object should not be created directly, but is returned by other methods in this library.
BigQueryReadAsyncClient
BigQuery Read API.
The Read API can be used to read data from BigQuery.
BigQueryReadClient
BigQuery Read API.
The Read API can be used to read data from BigQuery.
BigQueryWriteAsyncClient
BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see:
BigQueryWriteClient
BigQuery Write API.
The Write API can be used to write data to BigQuery.
For supplementary information about the Write API, see:
AppendRowsRequest
Request message for AppendRows.
Because AppendRows is a bidirectional streaming RPC, certain parts of the AppendRowsRequest need only be specified for the first request before switching table destinations. You can also switch table destinations within the same connection for the default stream.
The size of a single AppendRowsRequest must be less than 10 MB in
size. Requests larger than this return an error, typically
INVALID_ARGUMENT.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ArrowData
Arrow schema and data. Arrow format is an experimental feature only selected for allowlisted customers.
MissingValueInterpretation
An enum to indicate how to interpret missing values of fields that are present in user schema but missing in rows. A missing value can represent a NULL or a column default value defined in BigQuery table schema.
MissingValueInterpretationsEntry
The abstract base class for a message.
ProtoData
ProtoData contains the data rows and schema when constructing append requests.
AppendRowsResponse
Response message for AppendRows.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AppendResult
AppendResult is returned for successful append requests.
ArrowRecordBatch
Arrow RecordBatch.
ArrowSchema
Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC:
https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc
See code samples on how this message can be deserialized.
ArrowSerializationOptions
Contains options specific to Arrow Serialization.
CompressionCodec
Compression codec's supported by Arrow.
AvroRows
Avro rows.
AvroSchema
Avro schema.
AvroSerializationOptions
Contains options specific to Avro Serialization.
BatchCommitWriteStreamsRequest
Request message for BatchCommitWriteStreams.
BatchCommitWriteStreamsResponse
Response message for BatchCommitWriteStreams.
CreateReadSessionRequest
Request message for CreateReadSession.
CreateWriteStreamRequest
Request message for CreateWriteStream.
DataFormat
Data format for input or output data.
FinalizeWriteStreamRequest
Request message for invoking FinalizeWriteStream.
FinalizeWriteStreamResponse
Response message for FinalizeWriteStream.
FlushRowsRequest
Request message for FlushRows.
FlushRowsResponse
Respond message for FlushRows.
GetWriteStreamRequest
Request message for GetWriteStreamRequest.
ProtoRows
ProtoSchema
ProtoSchema describes the schema of the serialized protocol buffer data rows.
ReadRowsRequest
Request message for ReadRows.
ReadRowsResponse
Response from calling ReadRows may include row data, progress
and throttling information.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReadSession
Information about the ReadSession.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TableModifiers
Additional attributes when reading a table.
TableReadOptions
Options dictating how we read a table.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ResponseCompressionCodec
Specifies which compression codec to attempt on the entire serialized response payload (either Arrow record batch or Avro rows). This is not to be confused with the Apache Arrow native compression codecs specified in ArrowSerializationOptions. For performance reasons, when creating a read session requesting Arrow responses, setting both native Arrow compression and application-level response compression will not be allowed - choose, at most, one kind of compression.
ReadStream
Information about a single stream that gets data out of the storage
system. Most of the information about ReadStream instances is
aggregated, making ReadStream lightweight.
RowError
The message that presents row level error info in a request.
RowErrorCode
Error code for RowError.
SplitReadStreamRequest
Request message for SplitReadStream.
SplitReadStreamResponse
Response message for SplitReadStream.
StorageError
Structured custom BigQuery Storage error message. The error can be attached as error details in the returned rpc Status. In particular, the use of error codes allows more structured error handling, and reduces the need to evaluate unstructured error text strings.
StorageErrorCode
Error code for StorageError.
StreamStats
Estimated stream statistics for a given read Stream.
Progress
TableFieldSchema
TableFieldSchema defines a single field/column within a table schema.
FieldElementType
Represents the type of a field element.
Mode
Type
TableSchema
Schema of a table. This schema is a subset of google.cloud.bigquery.v2.TableSchema containing information necessary to generate valid message to write to BigQuery.
ThrottleState
Information on if the current connection is being throttled.
WriteStream
Information about a single stream that gets data inside the storage system.
Type
Type enum of the stream.
WriteMode
Mode enum of the stream.
WriteStreamView
WriteStreamView is a view enum that controls what details about a write stream should be returned.
MetastorePartitionServiceAsyncClient
BigQuery Metastore Partition Service API. This service is used for managing metastore partitions in BigQuery metastore. The service supports only batch operations for write.
MetastorePartitionServiceClient
BigQuery Metastore Partition Service API. This service is used for managing metastore partitions in BigQuery metastore. The service supports only batch operations for write.
BatchCreateMetastorePartitionsRequest
Request message for BatchCreateMetastorePartitions.
BatchCreateMetastorePartitionsResponse
Response message for BatchCreateMetastorePartitions.
BatchDeleteMetastorePartitionsRequest
Request message for BatchDeleteMetastorePartitions. The MetastorePartition is uniquely identified by values, which is an ordered list. Hence, there is no separate name or partition id field.
BatchSizeTooLargeError
Structured custom error message for batch size too large error. The error can be attached as error details in the returned rpc Status for more structured error handling in the client.
BatchUpdateMetastorePartitionsRequest
Request message for BatchUpdateMetastorePartitions.
BatchUpdateMetastorePartitionsResponse
Response message for BatchUpdateMetastorePartitions.
CreateMetastorePartitionRequest
Request message for CreateMetastorePartition. The MetastorePartition is uniquely identified by values, which is an ordered list. Hence, there is no separate name or partition id field.
FieldSchema
Schema description of a metastore partition column.
ListMetastorePartitionsRequest
Request message for ListMetastorePartitions.
ListMetastorePartitionsResponse
Response message for ListMetastorePartitions.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
MetastorePartition
Information about a Hive partition.
ParametersEntry
The abstract base class for a message.
MetastorePartitionList
List of metastore partitions.
MetastorePartitionValues
Represents the values of a metastore partition.
ReadStream
Information about a single stream that is used to read partitions.
SerDeInfo
Serializer and deserializer information.
ParametersEntry
The abstract base class for a message.
StorageDescriptor
Contains information about the physical storage of the data in the metastore partition.
StreamList
List of streams.
StreamMetastorePartitionsRequest
The top-level message sent by the client to the [Partitions.StreamMetastorePartitions][] method. Follows the default gRPC streaming maximum size of 4 MB.
StreamMetastorePartitionsResponse
This is the response message sent by the server to the client for the [Partitions.StreamMetastorePartitions][] method when the commit is successful. Server will close the stream after sending this message.
UpdateMetastorePartitionRequest
Request message for UpdateMetastorePartition.
BigQueryReadClient
Client for interacting with BigQuery Storage API.
The BigQuery storage API can be used to read data stored in BigQuery.
BigQueryWriteClient
BigQuery Write API.
The Write API can be used to write data to BigQuery.
The google.cloud.bigquery.storage.v1
API </bigquery/docs/reference/storage/rpc/google.cloud.bigquery.storage.v1>__
should be used instead of the v1beta2 API for BigQueryWrite
operations.
BigQueryReadAsyncClient
BigQuery Read API.
The Read API can be used to read data from BigQuery.
New code should use the v1 Read API going forward, if they don't use Write API at the same time.
BigQueryReadClient
BigQuery Read API.
The Read API can be used to read data from BigQuery.
New code should use the v1 Read API going forward, if they don't use Write API at the same time.
BigQueryWriteAsyncClient
BigQuery Write API.
The Write API can be used to write data to BigQuery.
The google.cloud.bigquery.storage.v1
API </bigquery/docs/reference/storage/rpc/google.cloud.bigquery.storage.v1>__
should be used instead of the v1beta2 API for BigQueryWrite
operations.
BigQueryWriteClient
BigQuery Write API.
The Write API can be used to write data to BigQuery.
The google.cloud.bigquery.storage.v1
API </bigquery/docs/reference/storage/rpc/google.cloud.bigquery.storage.v1>__
should be used instead of the v1beta2 API for BigQueryWrite
operations.
AppendRowsRequest
Request message for AppendRows.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ProtoData
Proto schema and data.
AppendRowsResponse
Response message for AppendRows.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AppendResult
AppendResult is returned for successful append requests.
ArrowRecordBatch
Arrow RecordBatch.
ArrowSchema
Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC:
https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc
See code samples on how this message can be deserialized.
ArrowSerializationOptions
Contains options specific to Arrow Serialization.
Format
The IPC format to use when serializing Arrow streams.
AvroRows
Avro rows.
AvroSchema
Avro schema.
BatchCommitWriteStreamsRequest
Request message for BatchCommitWriteStreams.
BatchCommitWriteStreamsResponse
Response message for BatchCommitWriteStreams.
CreateReadSessionRequest
Request message for CreateReadSession.
CreateWriteStreamRequest
Request message for CreateWriteStream.
DataFormat
Data format for input or output data.
FinalizeWriteStreamRequest
Request message for invoking FinalizeWriteStream.
FinalizeWriteStreamResponse
Response message for FinalizeWriteStream.
FlushRowsRequest
Request message for FlushRows.
FlushRowsResponse
Respond message for FlushRows.
GetWriteStreamRequest
Request message for GetWriteStreamRequest.
ProtoRows
ProtoSchema
ProtoSchema describes the schema of the serialized protocol buffer data rows.
ReadRowsRequest
Request message for ReadRows.
ReadRowsResponse
Response from calling ReadRows may include row data, progress
and throttling information.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ReadSession
Information about the ReadSession.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TableModifiers
Additional attributes when reading a table.
TableReadOptions
Options dictating how we read a table.
ReadStream
Information about a single stream that gets data out of the storage
system. Most of the information about ReadStream instances is
aggregated, making ReadStream lightweight.
SplitReadStreamRequest
Request message for SplitReadStream.
SplitReadStreamResponse
StorageError
Structured custom BigQuery Storage error message. The error can be attached as error details in the returned rpc Status. In particular, the use of error codes allows more structured error handling, and reduces the need to evaluate unstructured error text strings.
StorageErrorCode
Error code for StorageError.
StreamStats
Estimated stream statistics for a given Stream.
Progress
TableFieldSchema
A field in TableSchema
Mode
Type
TableSchema
Schema of a table
ThrottleState
Information on if the current connection is being throttled.
WriteStream
Information about a single stream that gets data inside the storage system.
Type
Type enum of the stream.
AppendRowsFuture
Encapsulation of the asynchronous execution of an action.
This object is returned from long-running BigQuery Storage API calls, and is the interface to determine the status of those calls.
This object should not be created directly, but is returned by other methods in this library.
AppendRowsStream
A manager object which can append rows to a stream.
Modules
client
Parent client for calling the Cloud BigQuery Storage API.
This is the base from which all interactions with the API occur.
reader
API documentation for bigquery_storage_v1.reader module.
client
Parent client for calling the Cloud BigQuery Storage API.
This is the base from which all interactions with the API occur.
writer
API documentation for bigquery_storage_v1beta2.writer module.