Struct SqlEndpointConfig 

pub struct SqlEndpointConfig {

    pub db_url: String,
    pub max_connections: Option<u32>,
    pub min_connections: Option<u32>,
    pub idle_timeout_secs: Option<u64>,
    pub max_lifetime_secs: Option<u64>,
    pub query: String,
    pub source_path: Option<String>,
    pub output_type: SqlOutputType,
    pub placeholder: char,
    pub use_placeholder: bool,
    pub noop: bool,
    pub in_separator: String,
    pub always_populate_statement: bool,
    pub allow_named_parameters: bool,
    pub fetch_size: Option<u32>,
    pub transaction_mode: TransactionMode,
    pub delay_ms: u64,
    pub initial_delay_ms: u64,
    pub max_messages_per_poll: Option<i32>,
    pub on_consume: Option<String>,
    pub on_consume_failed: Option<String>,
    pub on_consume_batch_complete: Option<String>,
    pub route_empty_result_set: bool,
    pub use_iterator: bool,
    pub expected_update_count: Option<i64>,
    pub break_batch_on_consume_fail: bool,
    pub bridge_error_handler: bool,
    pub repeat_count: Option<u32>,
    pub processing_strategy: ProcessingStrategy,
    pub poll_strategy: PollStrategy,
    pub batch: bool,
    pub use_message_body_for_sql: bool,
    pub ssl_mode: Option<String>,
    pub ssl_root_cert: Option<String>,
    pub ssl_cert: Option<String>,
    pub ssl_key: Option<String>,
    pub retry: NetworkRetryPolicy,
    /* private fields */
}

Configuration for SQL component endpoints.

URI format: sql:<query>?db_url=<url>&param1=val1&param2=val2

The query can be inline SQL or a file reference with file: prefix:

• sql:SELECT * FROM users?db_url=... - inline SQL
• sql:file:/path/to/query.sql?db_url=... - read SQL from file

Note on file-based queries (SQL-014): When the query path starts with file:, the file is NOT read synchronously during from_uri(). Instead, the file path is stored in source_path and the query is resolved asynchronously via resolve_file_query() during async initialization (producer pool init or consumer start). This avoids blocking I/O in the synchronous URI parsing path.

Security note: Debug implementation redacts the db_url (which may contain credentials) and ssl_key path. Use redact_db_url() for safe logging of database URLs.

Fields

db_url: String

Database connection URL (required).

max_connections: Option<u32>

Maximum connections in the pool. None = use global default.

min_connections: Option<u32>

Minimum connections in the pool. None = use global default.

idle_timeout_secs: Option<u64>

Idle timeout in seconds. None = use global default.

max_lifetime_secs: Option<u64>

Maximum connection lifetime in seconds. None = use global default.

query: String

The SQL query (from URI path or file).

source_path: Option<String>

Path to the file containing the SQL query (when using file: prefix).

output_type: SqlOutputType

Output type for query results. Default: SelectList.

placeholder: char

Placeholder character for parameters. Default: ‘#’.

use_placeholder: bool

If true, process parameter placeholders in queries. Default: true.

noop: bool

If true, don’t execute the query (dry run). Default: false.

in_separator: String

Separator for IN clause expansion. Default: “, “.

always_populate_statement: bool

If true, always bind parameters even if the exchange body is null/empty (uses empty defaults). Default: false.

allow_named_parameters: bool

If true, recognize :name style placeholders and map them from exchange headers or body fields. Default: true.

fetch_size: Option<u32>

Fetch size hint for query results. None = driver default.

transaction_mode: TransactionMode

Transaction mode for SQL operations. Default: Auto.

delay_ms: u64

Delay between polls in milliseconds. Default: 500.

initial_delay_ms: u64

Initial delay before first poll in milliseconds. Default: 1000.

max_messages_per_poll: Option<i32>

Maximum messages per poll.

on_consume: Option<String>

SQL to execute after consuming each message.

on_consume_failed: Option<String>

SQL to execute if consumption fails.

on_consume_batch_complete: Option<String>

SQL to execute after consuming a batch.

route_empty_result_set: bool

Route empty result sets. Default: false.

use_iterator: bool

Use iterator for results. Default: true.

expected_update_count: Option<i64>

Expected number of rows affected.

break_batch_on_consume_fail: bool

Break batch on consume failure. Default: false.

bridge_error_handler: bool

Bridge poll errors into route error handling. Default: false.

repeat_count: Option<u32>

When set, the consumer only polls up to repeat_count times before stopping. None = poll indefinitely (default).

processing_strategy: ProcessingStrategy

Processing strategy for consumer. Default: Direct.

poll_strategy: PollStrategy

Poll strategy for consumer. Default: Sequential.

batch: bool

Enable batch mode. Default: false.

use_message_body_for_sql: bool

Use message body for SQL. Default: false.

ssl_mode: Option<String>

SSL mode for the connection. None = use global default.

ssl_root_cert: Option<String>

Path to SSL root certificate. None = use global default.

ssl_cert: Option<String>

Path to SSL client certificate. None = use global default.

ssl_key: Option<String>

Path to SSL client key. None = use global default.

retry: NetworkRetryPolicy

Retry policy for transient database connection failures.

Implementations

impl SqlEndpointConfig

pub fn apply_defaults(&mut self, defaults: &SqlGlobalConfig)

Apply defaults from global config, filling None fields without overriding.

pub fn resolve_defaults(&mut self)

Resolve any remaining None fields with built-in defaults.

pub async fn resolve_file_query(&mut self) -> Result<(), CamelError>

Asynchronously read the SQL query from the file referenced by source_path.

This is the async replacement for the blocking std::fs::read_to_string that was previously called in from_uri(). Must be invoked during async init (producer pool init or consumer start) — never in a synchronous context.

After this call, self.query contains the file content (trimmed) and self.source_path is cleared to prevent re-reading.

Trait Implementations

impl Clone for SqlEndpointConfig

fn clone(&self) -> SqlEndpointConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlEndpointConfig

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

Formats the value using the given formatter.

impl UriConfig for SqlEndpointConfig

fn scheme() -> &'static str

Returns the URI scheme this config handles (e.g., “timer”, “http”).

fn from_uri(uri: &str) -> Result<Self, CamelError>

Parse a URI string into this configuration.

fn from_components(parts: UriComponents) -> Result<Self, CamelError>

Parse already-extracted URI components into this configuration.

fn validate(self) -> Result<Self, CamelError>

Override to add validation logic after parsing.