Enum OutputFormat 

#[repr(i32)]
pub enum OutputFormat {
    Unspecified = 0,
    ArrowLegacy = 2,
    JsonLegacyDict = 3,
    ArrowLegacyIpc = 4,
    ArrowIpc = 5,
    JsonArray = 6,
}

The output formats currently supported by HyperService

Since Hyper’s protocol went through multiple iterations, we have a few deprecated, non-recommend formats.

Only ARROW_IPC and JSON_ARRAY should be used for new workloads. The other formats will likely be removed in the future. Many of the other formats only support the SYNC transfer mode and are not fully supported for all HyperService methods.

Variants

Unspecified = 0

Encode the result chunk in a text-based format intended for debugging gRPC on the command line. Currently, this format is the same as JSON_LEGACY_DICT, which encodes the result as a JSON array. However, this format might change in the future. JSON_ARRAY or ARROW_IPC is strictly preferable. Not supported by GetQueryResult

ArrowLegacy = 2

Encode the result chunk in a proprietary variant similar to the open-source “Arrow IPC” format.

Do not use this format when onboarding any new workloads. Not supported by GetQueryResult. ARROW_IPC is strictly preferable.

Each result chunk consists of a schema and a record batch message. This is the original format of the gRPC proxy. For the JDBC Tableau connector, this format is passed through directly to a public Data Cloud API endpoint. As such, we cannot just drop support.

JsonLegacyDict = 3

Encode the result chunk as a JSON array of objects using the Query Service V1 SQL API convention. Not supported by GetQueryResult.

Do not use this format when onboarding any new workloads. Not supported by GetQueryResult. ARROW_IPC and JSON_ARRAY are strictly preferable.

ArrowLegacyIpc = 4

Encode the result chunk as part of a single Arrow IPC stream that encompasses all result chunks of a query. The first returned message will be a QueryResultHeader describing the schema, or a successful command. Only the first result chunk will contain an ARROW schema message. The following result chunks contain one or more record batch messages.

Do not use this format when onboarding any new workloads. Not supported by GetQueryResult. ARROW_IPC is strictly preferable.

ArrowIpc = 5

The first message in the response stream is the QueryStatus with the query id. The result is encoded in multiple QueryResultPartString messages. In concatenation, these form one single Arrow IPC stream, with one Arrow schema message and one or more Arrow RecordBatches. Unlike ARROW_LEGACY_IPC, does not return QueryResultHeader.

JsonArray = 6

The first message in the response stream is the QueryStatus with the query id. Each following QueryResultPartString message is a JSON object. The first result message contains a columns array describing the column names and types. E.g. {"columns":\[{"name":"IntCol","type":"numeric","precision":38,"scale":18,"nullable":false},{"name":"TextCol","type":"varchar","nullable": true}\]} The following messages contain the result rows encoded as an array of array of JSON types. Each tuple is encoded as one array. E.g. {"data":\[[42, "Foo"\], \[1.4, null]\]}

Implementations

impl OutputFormat

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of OutputFormat.

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

👎Deprecated:

Use the TryFrom<i32> implementation instead

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

impl OutputFormat

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

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

Trait Implementations

impl Clone for OutputFormat

fn clone(&self) -> OutputFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputFormat

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

Formats the value using the given formatter.

impl Default for OutputFormat

fn default() -> OutputFormat

Returns the “default value” for a type.

impl From<OutputFormat> for i32

fn from(value: OutputFormat) -> i32

Converts to this type from the input type.

impl Hash for OutputFormat

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

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 OutputFormat

fn cmp(&self, other: &OutputFormat) -> 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 OutputFormat

fn eq(&self, other: &OutputFormat) -> 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 OutputFormat

fn partial_cmp(&self, other: &OutputFormat) -> 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 OutputFormat

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for OutputFormat

impl Eq for OutputFormat

impl StructuralPartialEq for OutputFormat