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

Interface ConnectorFactory

All Superinterfaces:

ExternalSourceFactory

public interface ConnectorFactory
extends ExternalSourceFactory

Factory for creating connectors to external data sources. Each factory handles a specific protocol or source type (e.g. "flight", "jdbc"). Schema resolution lives here to avoid creating throwaway Connector instances.

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String location)
Connector	open(Map<String,Object> config)
SourceMetadata	resolveMetadata(String location, Map<String,Object> config)
String	type()

Methods inherited from interface org.elasticsearch.xpack.esql.datasources.spi.ExternalSourceFactory

canHandle, filterPushdownSupport, operatorFactory, resolveMetadataAsync, splitProvider, validateConfig

Method Details

type

String type()

Specified by:

type in interface ExternalSourceFactory

canHandle

boolean canHandle(String location)

Specified by:

canHandle in interface ExternalSourceFactory

resolveMetadata

SourceMetadata resolveMetadata(String location,
 Map<String,Object> config)

Specified by:

resolveMetadata in interface ExternalSourceFactory

Parameters:

config - configuration map. Values are typed as Object: secret values may arrive as SecureString, non-secrets retain their underlying type (String, Integer, Long, Boolean). Use Objects.toString(config.get(key), null) or pattern-match on type — casting directly to String will throw ClassCastException on non-String values.

open

Connector open(Map<String,Object> config)

Parameters:

config - configuration map; see resolveMetadata(String, Map) for typing rules.