ExArrow.Flight.FlightInfo (ex_arrow v0.4.0)

View Source

Metadata describing a named Arrow dataset served by a Flight server.

Returned by ExArrow.Flight.Client.list_flights/2 and ExArrow.Flight.Client.get_flight_info/2.

Fields:

  • schema_bytes — IPC-encoded Arrow schema (raw binary).
  • descriptor — how the dataset is identified: {:cmd, binary()} or {:path, [String.t()]}.
  • endpoints — one or more %{ticket: binary(), locations: [String.t()]} maps describing where and how to retrieve the data.
  • total_records — total row count across all endpoints, or -1 if unknown.
  • total_bytes — total byte size, or -1 if unknown.

Summary

Types

descriptor()
endpoint()
t()

Types

descriptor()

@type descriptor() :: {:cmd, binary()} | {:path, [String.t()]} | nil

endpoint()

@type endpoint() :: %{ticket: binary(), locations: [String.t()]}

t()

@type t() :: %ExArrow.Flight.FlightInfo{
  descriptor: descriptor(),
  endpoints: [endpoint()] | nil,
  schema_bytes: binary() | nil,
  total_bytes: integer() | nil,
  total_records: integer() | nil
}