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

Interface NoConfigFormatReader

All Superinterfaces:
AutoCloseable, Closeable, FormatReader
public interface NoConfigFormatReader extends FormatReader
Marker FormatReader for readers that recognise no per-query configuration keys. Supplies the standard "no keys claimed" override of withConfigTrackingConsumedKeys(java.util.Map<java.lang.String, java.lang.Object>) so the dozen-plus test fixtures and stateless production readers (ORC, JMH benchmark stubs) do not each repeat the same return Configured.empty(this) body.

Implement this in place of FormatReader when the reader genuinely has no per-query keys today. Readers that do claim keys must still implement FormatReader directly — the abstract contract there is the forcing function preventing silent acceptance of unknown configuration keys.

Symmetric to StorageProviderFactory.noConfigKeys(java.util.function.Supplier) on the storage side: both expose a single explicit opt-in point for the "no per-query options" case.

  • Method Details

    • withConfigTrackingConsumedKeys

      default Configured<FormatReader> withConfigTrackingConsumedKeys(Map<String,Object> config)
      Description copied from interface: FormatReader
      Returns a reader configured from the input config map, paired with the keys consumed from it.

      Required override. Every reader must explicitly declare which keys it claims, even if the answer is "none" (return Configured.empty(this)). The previous default silently dropped any unknown keys; that footgun is the reason this is no longer optional. Implementations that read configuration from the map should override this method (not FormatReader.withConfig(Map)); the consumed-keys set is required by ConfigKeyValidator for unknown-key rejection at planning time.

      Specified by:
      withConfigTrackingConsumedKeys in interface FormatReader