Class ActionCancelQueryRequest

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

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.

[Obsolete]
public sealed class ActionCancelQueryRequest : IMessage<ActionCancelQueryRequest>, IEquatable<ActionCancelQueryRequest>, IDeepCloneable<ActionCancelQueryRequest>, IBufferMessage, IMessage

Inheritance

object

ActionCancelQueryRequest

Implements

IMessage<ActionCancelQueryRequest>

IEquatable<ActionCancelQueryRequest>

IDeepCloneable<ActionCancelQueryRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

ActionCancelQueryRequest()

public ActionCancelQueryRequest()

ActionCancelQueryRequest(ActionCancelQueryRequest)

public ActionCancelQueryRequest(ActionCancelQueryRequest other)

Parameters

other ActionCancelQueryRequest

Fields

InfoFieldNumber

Field number for the "info" field.

public const int InfoFieldNumber = 1

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Info

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.

public ByteString Info { get; set; }

Property Value

ByteString

Parser

public static MessageParser<ActionCancelQueryRequest> Parser { get; }

Property Value

MessageParser<ActionCancelQueryRequest>

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public ActionCancelQueryRequest Clone()

Returns

ActionCancelQueryRequest

A deep clone of this object.

Equals(ActionCancelQueryRequest)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ActionCancelQueryRequest other)

Parameters

other ActionCancelQueryRequest

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(ActionCancelQueryRequest)

Merges the given message into this one.

public void MergeFrom(ActionCancelQueryRequest other)

Parameters

other ActionCancelQueryRequest

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.