Class CommandGetCatalogs

Namespace

Arrow.Flight.Protocol.Sql

Assembly

Apache.Arrow.Flight.Sql.dll

Represents a request to retrieve the list of catalogs on a Flight SQL enabled backend. The definition of a catalog depends on vendor/implementation. It is usually the database itself Used in the command member of FlightDescriptor for the following RPC calls:

• GetSchema: return the Arrow schema of the query.
• GetFlightInfo: execute the catalog metadata request.

The returned Arrow schema will be: < catalog_name: utf8 not null

The returned data should be ordered by catalog_name.

public sealed class CommandGetCatalogs : IMessage<CommandGetCatalogs>, IEquatable<CommandGetCatalogs>, IDeepCloneable<CommandGetCatalogs>, IBufferMessage, IMessage

Inheritance

object

CommandGetCatalogs

Implements

IMessage<CommandGetCatalogs>

IEquatable<CommandGetCatalogs>

IDeepCloneable<CommandGetCatalogs>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

FlightSqlExtensions.Serialize(IBufferMessage)

Constructors

CommandGetCatalogs()

public CommandGetCatalogs()

CommandGetCatalogs(CommandGetCatalogs)

public CommandGetCatalogs(CommandGetCatalogs other)

Parameters

other CommandGetCatalogs

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<CommandGetCatalogs> Parser { get; }

Property Value

MessageParser<CommandGetCatalogs>

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 CommandGetCatalogs Clone()

Returns

CommandGetCatalogs

A deep clone of this object.

Equals(CommandGetCatalogs)

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

public bool Equals(CommandGetCatalogs other)

Parameters

other CommandGetCatalogs

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(CommandGetCatalogs)

Merges the given message into this one.

public void MergeFrom(CommandGetCatalogs other)

Parameters

other CommandGetCatalogs

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.