Struct gapi_grpc::google::cloud::bigquery::storage::v1beta2::big_query_write_client::BigQueryWriteClient

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

BigQuery Write API.

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

Implementations

impl BigQueryWriteClient<Channel>

pub async fn connect<D>(dst: D) -> Result<Self, Error> where
    D: TryInto<Endpoint>,
    D::Error: Into<StdError>, 

Attempt to create a new client by connecting to a given endpoint.

impl<T> BigQueryWriteClient<T> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    T::Error: Into<StdError>,
    <T::ResponseBody as HttpBody>::Error: Into<StdError> + Send, 

pub fn new(inner: T) -> Self

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

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 COMMITTED 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 provids an offset that has already been written to. User can retry with adjusted offset within the same RPC stream. If offset is not specified, append happens at the end of the stream.

The response contains the offset at which the append happened. Responses are received in the same order in which requests are sent. There will be one response for each successful request. If the offset is not set in response, it means append didn’t happen due to some errors. If one request fails, all the subsequent requests will also fail until a success request is made again.

If the stream is of PENDING type, data will only be available for read operations after the stream is committed.

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

Gets 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) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BigQueryWriteClient<T>

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

Formats the value using the given formatter.