Package org.elasticsearch.xpack.esql.core.util

Interface PlanStreamOutput

All Known Implementing Classes:
PlanStreamOutput
public interface PlanStreamOutput

  • Method Details

    • writeAttributeCacheHeader

      boolean writeAttributeCacheHeader(Attribute attribute) throws IOException
      Writes a cache header for an Attribute and caches it if it is not already in the cache. In that case, the attribute will have to serialize itself into this stream immediately after this method call.
      Parameters:
      attribute - The attribute to serialize
      Returns:
      true if the attribute needs to serialize itself, false otherwise (ie. if already cached)
      Throws:
      IOException

    • writeEsFieldCacheHeader

      boolean writeEsFieldCacheHeader(EsField field, TransportVersion transportVersion) throws IOException
      Writes a cache header for an EsField and caches it if it is not already in the cache. In that case, the field will have to serialize itself into this stream immediately after this method call.
      Parameters:
      field - The EsField to serialize
      transportVersion - The transport version to use for serialization, needed to get the correct field name in case of versioned fields.
      Returns:
      true if the attribute needs to serialize itself, false otherwise (ie. if already cached)
      Throws:
      IOException

    • writeCachedString

      void writeCachedString(String field) throws IOException
      Throws:
      IOException

    • writeOptionalCachedString

      void writeOptionalCachedString(String str) throws IOException
      Throws:
      IOException