Struct ConnectorRegistry 

pub struct ConnectorRegistry { /* private fields */ }

Re-export the connector registry for custom connector registration. Registry of available connector implementations. Connectors register a factory per type string; the runtime looks up by the connector property in CREATE SOURCE/SINK DDL.

Implementations

impl ConnectorRegistry

pub fn new() -> ConnectorRegistry

Creates a new empty registry.

pub fn freeze(&self)

Permanently closes this registry to factory mutation.

The transition is idempotent. Once this call returns, every registration that began before it is visible and every later registration is rejected.

pub fn is_frozen(&self) -> bool

Returns whether factory registration has been permanently disabled.

pub fn register_source( &self, name: impl Into<String>, info: ConnectorInfo, factory: Arc<dyn Fn(Option<&Arc<Registry>>) -> Result<Box<dyn SourceConnector>, ConnectorError> + Send + Sync>, ) -> Result<(), ConnectorError>

Registers a source connector factory.

Errors

Returns an error if the source name is already registered or the registry is frozen.

pub fn register_sink( &self, name: impl Into<String>, info: ConnectorInfo, factory: Arc<dyn Fn(&ConnectorConfig, Option<&Arc<Registry>>) -> Result<Box<dyn SinkConnector>, ConnectorError> + Send + Sync>, ) -> Result<(), ConnectorError>

Registers a sink connector factory.

Errors

Returns an error if the sink name is already registered or the registry is frozen.

pub async fn default_source_schema( &self, connector_type: &str, properties: &HashMap<String, String>, ) -> Result<Option<Arc<Schema>>, ConnectorError>

Run a connector’s discover_schema against the given properties.

Three outcomes:

• Ok(Some(schema)) — discovery succeeded and produced fields.
• Ok(None) — connector type is unknown or does not support discovery.
• Err(_) — discovery was attempted and failed with a specific cause; callers should surface the message verbatim.

Errors

Returns the source factory’s construction error or the underlying ConnectorError from SourceConnector::discover_schema when discovery fails (bad config, unreachable network endpoint, timeout, etc.).

pub fn create_source( &self, config: &ConnectorConfig, registry: Option<&Arc<Registry>>, ) -> Result<Box<dyn SourceConnector>, ConnectorError>

Creates a new source connector instance.

The factory creates a default-configured connector. The caller must subsequently call open(config) to forward WITH clause properties.

If a prometheus::Registry is provided, the connector will register its metrics on it so they appear in the scrape output.

Errors

Returns ConnectorError::ConfigurationError if not registered, or the source factory’s construction error.

pub fn source_recovery_identity_options( &self, config: &ConnectorConfig, ) -> Result<Option<BTreeMap<String, String>>, ConnectorError>

Derive a registered source connector’s semantic recovery identity.

This constructs an unopened source instance and invokes its pure, configuration-only identity hook. None requests the runtime’s conservative sanitized-property fallback.

Errors

Returns an error when the source type is not registered or the connector rejects the supplied semantic configuration.

pub fn create_sink( &self, config: &ConnectorConfig, registry: Option<&Arc<Registry>>, ) -> Result<Box<dyn SinkConnector>, ConnectorError>

Creates a new sink connector instance.

The connector type is determined by config.connector_type().

If a prometheus::Registry is provided, the connector will register its metrics on it so they appear in the scrape output.

Errors

Returns ConnectorError::ConfigurationError if the connector type is not registered, or the selected sink configuration is invalid.

pub fn register_table_source( &self, name: impl Into<String>, info: ConnectorInfo, factory: Arc<dyn Fn(&ConnectorConfig, Arc<Schema>) -> Result<Box<dyn ReferenceTableSource>, ConnectorError> + Send + Sync>, ) -> Result<(), ConnectorError>

Registers a reference table source factory.

Errors

Returns an error if the table-source name is already registered or the registry is frozen.

pub fn create_table_source( &self, config: &ConnectorConfig, declared_schema: Arc<Schema>, ) -> Result<Box<dyn ReferenceTableSource>, ConnectorError>

Creates a new reference table source instance.

The connector type is determined by config.connector_type(). The declared schema is the authoritative field order, Arrow type, and nullability boundary for every returned batch.

Errors

Returns ConnectorError::ConfigurationError if the connector type is not registered as a table source.

pub fn list_table_sources(&self) -> Vec<String>

Lists all registered table source connector names.

pub fn has_table_source(&self, name: &str) -> bool

Returns whether a snapshot-capable table source is registered.

pub fn register_lookup_source( &self, name: impl Into<String>, info: ConnectorInfo, factory: Arc<dyn LookupSourceFactory>, ) -> Result<(), ConnectorError>

Registers a lookup source factory for on-demand/partial cache mode.

Errors

Returns an error if the lookup name is already registered or the registry is frozen.

pub fn has_lookup_source(&self, name: &str) -> bool

Returns whether an on-demand lookup source is registered.

pub async fn create_lookup_source( &self, config: ConnectorConfig, declared_schema: Option<Arc<Schema>>, ) -> Option<Result<Arc<dyn LookupSourceDyn>, ConnectorError>>

Creates a lookup source for on-demand cache-miss fallback.

Returns None if no lookup source factory is registered for the given connector type.

pub fn source_info(&self, name: &str) -> Option<ConnectorInfo>

Returns information about a registered source connector.

pub fn sink_info(&self, name: &str) -> Option<ConnectorInfo>

Returns information about a registered sink connector.

pub fn list_sources(&self) -> Vec<String>

Lists all registered source connector names.

pub fn list_sinks(&self) -> Vec<String>

Lists all registered sink connector names.

pub fn create_deserializer( &self, format: &str, ) -> Result<Box<dyn RecordDeserializer>, ConnectorError>

Creates a deserializer for the given format string.

Errors

Returns ConnectorError::Serde if the format is not supported.

pub fn create_serializer( &self, format: &str, ) -> Result<Box<dyn RecordSerializer>, ConnectorError>

Creates a serializer for the given format string.

Errors

Returns ConnectorError::Serde if the format is not supported.

Trait Implementations

impl Clone for ConnectorRegistry

fn clone(&self) -> ConnectorRegistry

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConnectorRegistry

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ConnectorRegistry

fn default() -> ConnectorRegistry

Returns the “default value” for a type.