Record Class Result

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.session.Result
Record Components:
schema - "Schema" of the Attributes that are produced by the LogicalPlan that was run. Each Page contains a Block of values for each attribute in this list.
pages - Actual values produced by running the ESQL.
profiles - DriverProfiles from all drivers that ran to produce the output. These are quite cheap to build, so we build them for all ESQL runs, regardless of if users have asked for them. But we only include them in the results if users ask for them.
executionInfo - Metadata about the execution of this query. Used for cross cluster queries.

public record Result(List<Attribute> schema, List<Page> pages, List<DriverProfile> profiles, EsqlExecutionInfo executionInfo) extends Record
Results from running a chunk of ESQL.
  • Constructor Details

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • schema

      public List<Attribute> schema()
      Returns the value of the schema record component.
      Returns:
      the value of the schema record component
    • pages

      public List<Page> pages()
      Returns the value of the pages record component.
      Returns:
      the value of the pages record component
    • profiles

      public List<DriverProfile> profiles()
      Returns the value of the profiles record component.
      Returns:
      the value of the profiles record component
    • executionInfo

      @Nullable public EsqlExecutionInfo executionInfo()
      Returns the value of the executionInfo record component.
      Returns:
      the value of the executionInfo record component