Struct arrow_flight::sql::ActionCancelQueryRequest

pub struct ActionCancelQueryRequest {
    pub info: Bytes,
}

Request message for the “CancelQuery” action.

Explicitly cancel a running query.

This lets a single client explicitly cancel work, no matter how many clients are involved/whether the query is distributed or not, given server support. The transaction/statement is not rolled back; it is the application’s job to commit or rollback as appropriate. This only indicates the client no longer wishes to read the remainder of the query results or continue submitting data.

This command is idempotent.

This command is deprecated since 13.0.0. Use the “CancelFlightInfo” action with DoAction instead.

Fields

info: Bytes

The result of the GetFlightInfo RPC that initiated the query. XXX(ARROW-16902): this must be a serialized FlightInfo, but is rendered as bytes because Protobuf does not really support one DLL using Protobuf definitions from another DLL.

Trait Implementations

impl Clone for ActionCancelQueryRequest

fn clone(&self) -> ActionCancelQueryRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActionCancelQueryRequest

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

Formats the value using the given formatter.

impl Default for ActionCancelQueryRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ActionCancelQueryRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ActionCancelQueryRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ProstMessageExt for ActionCancelQueryRequest

fn type_url() -> &'static str

type_url for this Message

fn as_any(&self) -> Any

Convert this Message to Any

impl StructuralPartialEq for ActionCancelQueryRequest