Enum TransferMode 

#[repr(i32)]
pub enum TransferMode {
    Unspecified = 0,
    Async = 1,
    Sync = 2,
    Adaptive = 3,
}

The requested result transfer mode. By default, we recommend using ADAPTIVE for most workloads.

ADAPTIVE and ASYNC are only supported for the ARROW_IPC and JSON_ARRAY output formats. All other output formats use SYNC mode.

Variants

Unspecified = 0

TRANSFER_MODE_UNSPECIFIED defaults to ADAPTIVE

Async = 1

Only returns the header including the schema and query id. Results need to be fetched via GetQueryResult. Only supported for JSON_ARRAY and ARROW_IPC output format.

Sync = 2

All results will be returned with the ExecuteQuery call Using this mode is discouraged, as there is a 100s timeout.

Adaptive = 3

Returns up to one result chunk synchronously. Subsequent result chunks may be retrieved via GetQueryResult. If the client does not retrieve the chunk in time, the server will close the connection. This does not imply that the query failed. It is the client’s obligation to query the status or refetch remaining rows from the first chunk in case of timeouts.

Implementations

impl TransferMode

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of TransferMode.

pub fn from_i32(value: i32) -> Option<TransferMode>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a TransferMode, or None if value is not a valid variant.

impl TransferMode

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<TransferMode>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for TransferMode

fn clone(&self) -> TransferMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransferMode

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

Formats the value using the given formatter.

impl Default for TransferMode

fn default() -> TransferMode

Returns the “default value” for a type.

impl Hash for TransferMode

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TransferMode

fn cmp(&self, other: &TransferMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TransferMode

fn eq(&self, other: &TransferMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TransferMode

fn partial_cmp(&self, other: &TransferMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for TransferMode

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<TransferMode, UnknownEnumValue>

Performs the conversion.

impl Copy for TransferMode

impl Eq for TransferMode

impl StructuralPartialEq for TransferMode