Google Cloud BigQuery C++ Client  2.1.0
A C++ Client Library for Google Cloud BigQuery
Public Member Functions | Friends | List of all members
google::cloud::bigquery::BigQueryWriteClient Class Reference

BigQuery Write API. More...

#include <google/cloud/bigquery/bigquery_write_client.h>

Public Member Functions

 BigQueryWriteClient (std::shared_ptr< BigQueryWriteConnection > connection, Options opts={})
 
 ~BigQueryWriteClient ()
 
 BigQueryWriteClient (BigQueryWriteClient const &)=default
 
BigQueryWriteClientoperator= (BigQueryWriteClient const &)=default
 
 BigQueryWriteClient (BigQueryWriteClient &&)=default
 
BigQueryWriteClientoperator= (BigQueryWriteClient &&)=default
 
StatusOr< google::cloud::bigquery::storage::v1::WriteStream > CreateWriteStream (std::string const &parent, google::cloud::bigquery::storage::v1::WriteStream const &write_stream, Options opts={})
 Creates a write stream to the given table. More...
 
StatusOr< google::cloud::bigquery::storage::v1::WriteStream > CreateWriteStream (google::cloud::bigquery::storage::v1::CreateWriteStreamRequest const &request, Options opts={})
 Creates a write stream to the given table. More...
 
std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::bigquery::storage::v1::AppendRowsRequest, google::cloud::bigquery::storage::v1::AppendRowsResponse > > AsyncAppendRows (ExperimentalTag, Options opts={})
 Appends data to the given stream. More...
 
StatusOr< google::cloud::bigquery::storage::v1::WriteStream > GetWriteStream (std::string const &name, Options opts={})
 Gets information about a write stream. More...
 
StatusOr< google::cloud::bigquery::storage::v1::WriteStream > GetWriteStream (google::cloud::bigquery::storage::v1::GetWriteStreamRequest const &request, Options opts={})
 Gets information about a write stream. More...
 
StatusOr< google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse > FinalizeWriteStream (std::string const &name, Options opts={})
 Finalize a write stream so that no new data can be appended to the stream. More...
 
StatusOr< google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse > FinalizeWriteStream (google::cloud::bigquery::storage::v1::FinalizeWriteStreamRequest const &request, Options opts={})
 Finalize a write stream so that no new data can be appended to the stream. More...
 
StatusOr< google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse > BatchCommitWriteStreams (std::string const &parent, Options opts={})
 Atomically commits a group of PENDING streams that belong to the same parent table. More...
 
StatusOr< google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse > BatchCommitWriteStreams (google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsRequest const &request, Options opts={})
 Atomically commits a group of PENDING streams that belong to the same parent table. More...
 
StatusOr< google::cloud::bigquery::storage::v1::FlushRowsResponse > FlushRows (std::string const &write_stream, Options opts={})
 Flushes rows to a BUFFERED stream. More...
 
StatusOr< google::cloud::bigquery::storage::v1::FlushRowsResponse > FlushRows (google::cloud::bigquery::storage::v1::FlushRowsRequest const &request, Options opts={})
 Flushes rows to a BUFFERED stream. More...
 

Friends

bool operator== (BigQueryWriteClient const &a, BigQueryWriteClient const &b)
 
bool operator!= (BigQueryWriteClient const &a, BigQueryWriteClient const &b)
 

Detailed Description

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.

Definition at line 67 of file bigquery_write_client.h.

Constructor & Destructor Documentation

◆ BigQueryWriteClient() [1/3]

google::cloud::bigquery::BigQueryWriteClient::BigQueryWriteClient ( std::shared_ptr< BigQueryWriteConnection connection,
Options  opts = {} 
)
explicit

◆ ~BigQueryWriteClient()

google::cloud::bigquery::BigQueryWriteClient::~BigQueryWriteClient ( )

◆ BigQueryWriteClient() [2/3]

google::cloud::bigquery::BigQueryWriteClient::BigQueryWriteClient ( BigQueryWriteClient const &  )
default

◆ BigQueryWriteClient() [3/3]

google::cloud::bigquery::BigQueryWriteClient::BigQueryWriteClient ( BigQueryWriteClient &&  )
default

Member Function Documentation

◆ AsyncAppendRows()

std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::bigquery::storage::v1::AppendRowsRequest, google::cloud::bigquery::storage::v1::AppendRowsResponse> > google::cloud::bigquery::BigQueryWriteClient::AsyncAppendRows ( ExperimentalTag  ,
Options  opts = {} 
)

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.

Note: For users coding against the gRPC api directly, it may be necessary to supply the x-goog-request-params system parameter with write_stream=<full_write_stream_name>.

More information about system parameters: https://cloud.google.com/apis/docs/system-parameters

Note
The presence of the ExperimentalTag means that this function is experimental. It is subject to change (including removal) without notice.
Parameters
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
A bidirectional streaming interface with request (write) type: google::cloud::bigquery::storage::v1::AppendRowsRequest and response (read) type: google::cloud::bigquery::storage::v1::AppendRowsResponse

◆ BatchCommitWriteStreams() [1/2]

StatusOr< google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse> google::cloud::bigquery::BigQueryWriteClient::BatchCommitWriteStreams ( google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::cloud::bigquery::storage::v1::BatchCommitWriteStreamsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse

◆ BatchCommitWriteStreams() [2/2]

StatusOr< google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse> google::cloud::bigquery::BigQueryWriteClient::BatchCommitWriteStreams ( std::string const &  parent,
Options  opts = {} 
)

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
parentRequired. Parent table that all the streams should belong to, in the form of projects/{project}/datasets/{dataset}/tables/{table}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::BatchCommitWriteStreamsResponse

◆ CreateWriteStream() [1/2]

StatusOr<google::cloud::bigquery::storage::v1::WriteStream> google::cloud::bigquery::BigQueryWriteClient::CreateWriteStream ( google::cloud::bigquery::storage::v1::CreateWriteStreamRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::cloud::bigquery::storage::v1::CreateWriteStreamRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::WriteStream

◆ CreateWriteStream() [2/2]

StatusOr<google::cloud::bigquery::storage::v1::WriteStream> google::cloud::bigquery::BigQueryWriteClient::CreateWriteStream ( std::string const &  parent,
google::cloud::bigquery::storage::v1::WriteStream const &  write_stream,
Options  opts = {} 
)

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
parentRequired. Reference to the table to which the stream belongs, in the format of projects/{project}/datasets/{dataset}/tables/{table}.
write_streamRequired. Stream to be created.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::WriteStream

◆ FinalizeWriteStream() [1/2]

StatusOr<google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse> google::cloud::bigquery::BigQueryWriteClient::FinalizeWriteStream ( google::cloud::bigquery::storage::v1::FinalizeWriteStreamRequest const &  request,
Options  opts = {} 
)

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

Finalize is not supported on the '_default' stream.

Parameters
requestgoogle::cloud::bigquery::storage::v1::FinalizeWriteStreamRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse

◆ FinalizeWriteStream() [2/2]

StatusOr<google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse> google::cloud::bigquery::BigQueryWriteClient::FinalizeWriteStream ( std::string const &  name,
Options  opts = {} 
)

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

Finalize is not supported on the '_default' stream.

Parameters
nameRequired. Name of the stream to finalize, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::FinalizeWriteStreamResponse

◆ FlushRows() [1/2]

StatusOr<google::cloud::bigquery::storage::v1::FlushRowsResponse> google::cloud::bigquery::BigQueryWriteClient::FlushRows ( google::cloud::bigquery::storage::v1::FlushRowsRequest const &  request,
Options  opts = {} 
)

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
requestgoogle::cloud::bigquery::storage::v1::FlushRowsRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::FlushRowsResponse

◆ FlushRows() [2/2]

StatusOr<google::cloud::bigquery::storage::v1::FlushRowsResponse> google::cloud::bigquery::BigQueryWriteClient::FlushRows ( std::string const &  write_stream,
Options  opts = {} 
)

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
write_streamRequired. The stream that is the target of the flush operation.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::FlushRowsResponse

◆ GetWriteStream() [1/2]

StatusOr<google::cloud::bigquery::storage::v1::WriteStream> google::cloud::bigquery::BigQueryWriteClient::GetWriteStream ( google::cloud::bigquery::storage::v1::GetWriteStreamRequest const &  request,
Options  opts = {} 
)

Gets information about a write stream.

Parameters
requestgoogle::cloud::bigquery::storage::v1::GetWriteStreamRequest
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::WriteStream

◆ GetWriteStream() [2/2]

StatusOr<google::cloud::bigquery::storage::v1::WriteStream> google::cloud::bigquery::BigQueryWriteClient::GetWriteStream ( std::string const &  name,
Options  opts = {} 
)

Gets information about a write stream.

Parameters
nameRequired. Name of the stream to get, in the form of projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.
optsOptional. Override the class-level options, such as retry and backoff policies.
Returns
google::cloud::bigquery::storage::v1::WriteStream

◆ operator=() [1/2]

BigQueryWriteClient& google::cloud::bigquery::BigQueryWriteClient::operator= ( BigQueryWriteClient &&  )
default

◆ operator=() [2/2]

BigQueryWriteClient& google::cloud::bigquery::BigQueryWriteClient::operator= ( BigQueryWriteClient const &  )
default

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( BigQueryWriteClient const &  a,
BigQueryWriteClient const &  b 
)
friend

Definition at line 87 of file bigquery_write_client.h.

◆ operator==

bool operator== ( BigQueryWriteClient const &  a,
BigQueryWriteClient const &  b 
)
friend

Definition at line 83 of file bigquery_write_client.h.