Package org.elasticsearch.xpack.esql.datasources.spi

Record Class FormatSpec

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.datasources.spi.FormatSpec
Record Components:
format - logical format name (e.g. "csv", "tsv", "parquet")
extensions - file extensions with leading dot (e.g. ".csv", ".parquet")
configKeys - per-dataset configuration keys the format reader recognises
public record FormatSpec(String format, Set<String> extensions, Set<String> configKeys) extends Record
Describes a file format this plugin provides: a logical format name, the file extensions that select it, and the per-dataset configuration keys it recognises.

The format name must match a key in the map returned by DataSourcePlugin.formatReaders(org.elasticsearch.common.settings.Settings). Multiple extensions may map to the same format (e.g. .ndjson, .jsonl, .json all select "ndjson"), but each extension should map to exactly one format across all plugins.

configKeys declares the configuration keys the format reader accepts per dataset (e.g. "delimiter", "encoding" for CSV). These keys must stay in sync with the reader's RECOGNIZED_KEYS; each format plugin's test suite should verify the symmetry.

Example: 

Set.of(
    new FormatSpec("csv",  Set.of(".csv"), Set.of("delimiter", "quote")),
    new FormatSpec("tsv",  Set.of(".tsv"), Set.of("delimiter", "quote"))
)

  • Constructor Details

    • FormatSpec

      public FormatSpec(String format, Set<String> extensions, Set<String> configKeys)
      Creates an instance of a FormatSpec record class.
      Parameters:
      format - the value for the format record component
      extensions - the value for the extensions record component
      configKeys - the value for the configKeys record component

  • Method Details

    • of

      public static FormatSpec of(String format, String extension)
      Convenience factory for formats with no per-dataset configuration keys.

    • of

      public static FormatSpec of(String format, String extension, Set<String> configKeys)
      Convenience factory for the common single-extension case with config keys.

    • 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.

    • format

      public String format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • extensions

      public Set<String> extensions()
      Returns the value of the extensions record component.
      Returns:
      the value of the extensions record component

    • configKeys

      public Set<String> configKeys()
      Returns the value of the configKeys record component.
      Returns:
      the value of the configKeys record component