Class BigQueryWriteClient (2.13.0)

Version 2.13.0

• 2.33.0-rc (latest)
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

BigQuery Write API.

The Write API can be used to write data to BigQuery.

For supplementary information about the Write API, see: https://cloud.google.com/bigquery/docs/write-api

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

BigQueryWriteClient(BigQueryWriteClient const &)

Copy and move support

Parameter
Name	Description
	BigQueryWriteClient const &

BigQueryWriteClient(BigQueryWriteClient &&)

Copy and move support

Parameter
Name	Description
	BigQueryWriteClient &&

BigQueryWriteClient(std::shared_ptr< BigQueryWriteConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< BigQueryWriteConnection >
opts	Options

Operators

operator=(BigQueryWriteClient const &)

Copy and move support

Parameter
Name	Description
	BigQueryWriteClient const &

Returns
Type	Description
BigQueryWriteClient &

operator=(BigQueryWriteClient &&)

Copy and move support

Parameter
Name	Description
	BigQueryWriteClient &&

Returns
Type	Description
BigQueryWriteClient &

Functions

CreateWriteStream(std::string const &, google::cloud::bigquery::storage::v1::WriteStream const &, Options)

Creates a write stream to the given table.

Additionally, every table has a special stream named '_default' to which data can be written. This stream doesn't need to be created using CreateWriteStream. It is a stream that can be used simultaneously by any number of clients. Data written to this stream is considered committed as soon as an acknowledgement is received.

Parameters
Name	Description
parent	std::string const & Required. Reference to the table to which the stream belongs, in the format of projects/{project}/datasets/{dataset}/tables/{table}.
write_stream	google::cloud::bigquery::storage::v1::WriteStream const & Required. Stream to be created.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::WriteStream >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.WriteStream) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateWriteStream(google::cloud::bigquery::storage::v1::CreateWriteStreamRequest const &, Options)

Creates a write stream to the given table.

Additionally, every table has a special stream named '_default' to which data can be written. This stream doesn't need to be created using CreateWriteStream. It is a stream that can be used simultaneously by any number of clients. Data written to this stream is considered committed as soon as an acknowledgement is received.

Parameters
Name	Description
request	google::cloud::bigquery::storage::v1::CreateWriteStreamRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.storage.v1.CreateWriteStreamRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::WriteStream >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.WriteStream) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

AsyncAppendRows(Options)

Appends data to the given stream.

If offset is specified, the offset is checked against the end of stream. The server returns OUT_OF_RANGE in AppendRowsResponse if an attempt is made to append to an offset beyond the current end of the stream or ALREADY_EXISTS if user provides an offset that has already been written to. User can retry with adjusted offset within the same RPC connection. If offset is not specified, append happens at the end of the stream.

The response contains an optional offset at which the append happened. No offset information will be returned for appends to a default stream.

Responses are received in the same order in which requests are sent. There will be one response for each successful inserted request. Responses may optionally embed error information if the originating AppendRequest was not successfully processed.

The specifics of when successfully appended data is made visible to the table are governed by the type of stream:

• For COMMITTED streams (which includes the default stream), data is visible immediately upon successful append.
• For BUFFERED streams, data is made visible via a subsequent FlushRows rpc which advances a cursor to a newer offset in the stream.
• For PENDING streams, data is not made visible until the stream itself is finalized (via the FinalizeWriteStream rpc), and the stream is explicitly committed via the BatchCommitWriteStreams rpc.

Parameter
Name	Description
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::bigquery::storage::v1::AppendRowsRequest, google::cloud::bigquery::storage::v1::AppendRowsResponse > >	An object representing the bidirectional streaming RPC. Applications can send multiple request messages and receive multiple response messages through this API. Bidirectional streaming RPCs can impose restrictions on the sequence of request and response messages. Please consult the service documentation for details. The request message type (google.cloud.bigquery.storage.v1.AppendRowsRequest) and response messages (google.cloud.bigquery.storage.v1.AppendRowsResponse) are mapped to C++ classes using the Protobuf mapping rules.

GetWriteStream(std::string const &, Options)

Gets information about a write stream.

Parameters
Name	Description
name	std::string const & Required. Name of the stream to get, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::WriteStream >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.WriteStream) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetWriteStream(google::cloud::bigquery::storage::v1::GetWriteStreamRequest const &, Options)

Gets information about a write stream.

Parameters
Name	Description
request	google::cloud::bigquery::storage::v1::GetWriteStreamRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.storage.v1.GetWriteStreamRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::WriteStream >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.WriteStream) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

FinalizeWriteStream(std::string const &, Options)

Finalize a write stream so that no new data can be appended to the stream.

Finalize is not supported on the '_default' stream.

Parameters
Name	Description
name	std::string const & Required. Name of the stream to finalize, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

FinalizeWriteStream(google::cloud::bigquery::storage::v1::FinalizeWriteStreamRequest const &, Options)

Finalize a write stream so that no new data can be appended to the stream.

Finalize is not supported on the '_default' stream.

Parameters
Name	Description
request	google::cloud::bigquery::storage::v1::FinalizeWriteStreamRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.storage.v1.FinalizeWriteStreamRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.FinalizeWriteStreamResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchCommitWriteStreams(std::string const &, Options)

Atomically commits a group of PENDING streams that belong to the same parent table.

Streams must be finalized before commit and cannot be committed multiple times. Once a stream is committed, data in the stream becomes available for read operations.

Parameters
Name	Description
parent	std::string const & Required. Parent table that all the streams should belong to, in the form of projects/{project}/datasets/{dataset}/tables/{table}.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

BatchCommitWriteStreams(google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsRequest const &, Options)

Atomically commits a group of PENDING streams that belong to the same parent table.

Streams must be finalized before commit and cannot be committed multiple times. Once a stream is committed, data in the stream becomes available for read operations.

Parameters
Name	Description
request	google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.BatchCommitWriteStreamsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

FlushRows(std::string const &, Options)

Flushes rows to a BUFFERED stream.

If users are appending rows to BUFFERED stream, flush operation is required in order for the rows to become available for reading. A Flush operation flushes up to any previously flushed offset in a BUFFERED stream, to the offset specified in the request.

Flush is not supported on the _default stream, since it is not BUFFERED.

Parameters
Name	Description
write_stream	std::string const & Required. The stream that is the target of the flush operation.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::FlushRowsResponse >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.FlushRowsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

FlushRows(google::cloud::bigquery::storage::v1::FlushRowsRequest const &, Options)

Flushes rows to a BUFFERED stream.

If users are appending rows to BUFFERED stream, flush operation is required in order for the rows to become available for reading. A Flush operation flushes up to any previously flushed offset in a BUFFERED stream, to the offset specified in the request.

Flush is not supported on the _default stream, since it is not BUFFERED.

Parameters
Name	Description
request	google::cloud::bigquery::storage::v1::FlushRowsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.storage.v1.FlushRowsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::bigquery::storage::v1::FlushRowsResponse >	the result of the RPC. The response message type (google.cloud.bigquery.storage.v1.FlushRowsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.