Package org.elasticsearch.xpack.esql.datasources

Class DataSourceModule

java.lang.Object

org.elasticsearch.xpack.esql.datasources.DataSourceModule

All Implemented Interfaces:

Closeable, AutoCloseable

public final class DataSourceModule
extends Object
implements Closeable

Module that collects all data source implementations from plugins.

This module registers lazy delegating factories per-plugin so that heavy dependencies (AWS SDK, Parquet, Arrow) are only loaded when a query targets that backend. Capability declarations (DataSourceCapabilities) are used for cheap routing and early validation without triggering classloading.

Constructor Summary

Constructors

Constructor	Description
DataSourceModule(List<DataSourcePlugin> dataSourcePlugins, DataSourceCapabilities capabilities, Settings settings, BlockFactory blockFactory, ExecutorService executor, DataSourceCredentials credentials, BooleanSupplier managedIdentityEnabled)
DataSourceModule(List<DataSourcePlugin> dataSourcePlugins, DataSourceCapabilities capabilities, Settings settings, BlockFactory blockFactory, ExecutorService executor, DataSourceCredentials credentials, BooleanSupplier managedIdentityEnabled, ThreadPool threadPool, Environment environment, ResourceWatcherService resourceWatcherService, MeterRegistry meterRegistry)
DataSourceModule(List<DataSourcePlugin> dataSourcePlugins, DataSourceCapabilities capabilities, Settings settings, BlockFactory blockFactory, ExecutorService executor, DataSourceCredentials credentials, BooleanSupplier managedIdentityEnabled, ThreadPool threadPool, Environment environment, ResourceWatcherService resourceWatcherService, MeterRegistry meterRegistry, LocalFileAccess localFileAccess)

Method Summary

Modifier and Type	Method	Description
DataSourceCapabilities	capabilities()
void	close()
OperatorFactoryRegistry	createOperatorFactoryRegistry(Executor executor)	Convenience overload that backs BOTH registry roles with a single executor.
OperatorFactoryRegistry	createOperatorFactoryRegistry(Executor executor, Executor fileReadExecutor)
ExternalSourceMetrics	externalSourceMetrics()	The node-level external-source telemetry holder, or ExternalSourceMetrics.NOOP when no registry was supplied.
FormatReaderRegistry	formatReaderRegistry()
Map<String,ExternalSourceFactory>	sourceFactories()
StorageProviderRegistry	storageProviderRegistry()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DataSourceModule

public DataSourceModule(List<DataSourcePlugin> dataSourcePlugins,
 DataSourceCapabilities capabilities,
 Settings settings,
 BlockFactory blockFactory,
 ExecutorService executor,
 DataSourceCredentials credentials,
 BooleanSupplier managedIdentityEnabled)

DataSourceModule

public DataSourceModule(List<DataSourcePlugin> dataSourcePlugins,
 DataSourceCapabilities capabilities,
 Settings settings,
 BlockFactory blockFactory,
 ExecutorService executor,
 DataSourceCredentials credentials,
 BooleanSupplier managedIdentityEnabled,
 @Nullable
 ThreadPool threadPool,
 @Nullable
 Environment environment,
 @Nullable
 ResourceWatcherService resourceWatcherService,
 @Nullable
 MeterRegistry meterRegistry)

DataSourceModule

public DataSourceModule(List<DataSourcePlugin> dataSourcePlugins,
 DataSourceCapabilities capabilities,
 Settings settings,
 BlockFactory blockFactory,
 ExecutorService executor,
 DataSourceCredentials credentials,
 BooleanSupplier managedIdentityEnabled,
 @Nullable
 ThreadPool threadPool,
 @Nullable
 Environment environment,
 @Nullable
 ResourceWatcherService resourceWatcherService,
 @Nullable
 MeterRegistry meterRegistry,
 LocalFileAccess localFileAccess)

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

capabilities

public DataSourceCapabilities capabilities()

storageProviderRegistry

public StorageProviderRegistry storageProviderRegistry()

formatReaderRegistry

public FormatReaderRegistry formatReaderRegistry()

sourceFactories

public Map<String,ExternalSourceFactory> sourceFactories()

externalSourceMetrics

public ExternalSourceMetrics externalSourceMetrics()

The node-level external-source telemetry holder, or ExternalSourceMetrics.NOOP when no registry was supplied.

createOperatorFactoryRegistry

public OperatorFactoryRegistry createOperatorFactoryRegistry(Executor executor)

Convenience overload that backs BOTH registry roles with a single executor. This collapses the page-consumer/coordination role and the read/parse role onto one pool, which is the exact wiring that deadlocks multi-file text reads in production (a full pool of blocked parser workers with no free thread left to run the drain that consumes them). It is safe only for synchronous / single-threaded callers (e.g. Runnable::run in tests). Production wiring must use createOperatorFactoryRegistry(Executor, Executor) with two distinct pools — see TransportEsqlQueryAction.

createOperatorFactoryRegistry

public OperatorFactoryRegistry createOperatorFactoryRegistry(Executor executor,
 Executor fileReadExecutor)