Struct google_api_proto::google::cloud::bigquery::storage::v1::big_query_write_client::BigQueryWriteClient

pub struct BigQueryWriteClient<T> { /* private fields */ }

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

Implementations

impl<T> BigQueryWriteClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> BigQueryWriteClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn create_write_stream( &mut self, request: impl IntoRequest<CreateWriteStreamRequest> ) -> Result<Response<WriteStream>, Status>

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.

pub async fn append_rows( &mut self, request: impl IntoStreamingRequest<Message = AppendRowsRequest> ) -> Result<Response<Streaming<AppendRowsResponse>>, Status>

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.

pub async fn get_write_stream( &mut self, request: impl IntoRequest<GetWriteStreamRequest> ) -> Result<Response<WriteStream>, Status>

Gets information about a write stream.

pub async fn finalize_write_stream( &mut self, request: impl IntoRequest<FinalizeWriteStreamRequest> ) -> Result<Response<FinalizeWriteStreamResponse>, Status>

Finalize a write stream so that no new data can be appended to the stream. Finalize is not supported on the ‘_default’ stream.

pub async fn batch_commit_write_streams( &mut self, request: impl IntoRequest<BatchCommitWriteStreamsRequest> ) -> Result<Response<BatchCommitWriteStreamsResponse>, Status>

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.

pub async fn flush_rows( &mut self, request: impl IntoRequest<FlushRowsRequest> ) -> Result<Response<FlushRowsResponse>, Status>

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.

Trait Implementations

impl<T: Clone> Clone for BigQueryWriteClient<T>

fn clone(&self) -> BigQueryWriteClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for BigQueryWriteClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.