Struct WriterBuilder 

pub struct WriterBuilder<S> { /* private fields */ }

A builder to create a stream writer.

Implementations

impl WriterBuilder<DefaultStream>

pub fn with_multiplexing(self, enable: bool) -> Self

Enable multiplexing.

Set this option to use the client’s shared stream pool.

This option only applies to the default stream.

Example

let writer = client
    .open_default_stream("projects/my-project/datasets/my_dataset/tables/my_table")
    .with_multiplexing(true)
    .build_arrow(schema())
    .await?;

pub fn with_retry_policy<V: Into<RetryPolicyArg>>(self, v: V) -> Self

Configure the retry policy.

The client libraries can automatically retry operations that fail. The retry policy controls what errors are considered retryable, sets limits on the number of attempts or the time trying to make attempts.

Example

use google_cloud_bigquery::write::retry_policy::RetryableErrors;
use google_cloud_gax::retry_policy::RetryPolicyExt;
let writer = client
    .open_default_stream("projects/my-project/datasets/my_dataset/tables/my_table")
    .with_retry_policy(RetryableErrors.with_attempt_limit(3))
    .build_arrow(schema())
    .await?;

pub fn with_backoff_policy<V: Into<BackoffPolicyArg>>(self, v: V) -> Self

Configure the retry backoff policy.

The client libraries can automatically retry operations that fail. The backoff policy controls how long to wait in between retry attempts.

Example

use google_cloud_gax::exponential_backoff::ExponentialBackoff;
let policy = ExponentialBackoff::default();
let writer = client
    .open_default_stream("projects/my-project/datasets/my_dataset/tables/my_table")
    .with_backoff_policy(policy)
    .build_arrow(schema())
    .await?;

pub fn with_attempt_timeout(self, v: Duration) -> Self

Configure the timeout for a single write attempt.

Without this limit, a write can block forever if the service accepts the stream but never responds. On a timeout, the client abandons the stream and the retry policy decides whether to make another attempt.

Example

use std::time::Duration;
let writer = client
    .open_default_stream("projects/my-project/datasets/my_dataset/tables/my_table")
    .with_attempt_timeout(Duration::from_secs(10))
    .build_arrow(schema())
    .await?;

impl<S: Stream> WriterBuilder<S>

pub async fn build_arrow<W>( self, schema: ArrowSchema, ) -> Result<W, WriterBuilderError>

where S: Stream<Writer<Arrow> = W>, W: HasStream<Stream = S>,

Consumes the builder and creates a writer using Arrow as the data format.

Returns the writer W corresponding to the stream type S:

• DefaultStream -> DefaultWriter<Arrow>
• PendingStream -> PendingWriter<Arrow>
• CommittedStream -> CommittedWriter<Arrow>
• BufferedStream -> BufferedWriter<Arrow>

Example

let writer = client
    .open_default_stream("projects/my-project/datasets/my_dataset/tables/my_table")
    .build_arrow(ArrowSchema::new())
    .await?;

Trait Implementations

impl<S: Clone> Clone for WriterBuilder<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for WriterBuilder<S>

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

Formats the value using the given formatter.