Struct SftpSourceConfig 

pub struct SftpSourceConfig {
    pub connection: SftpConnectionConfig,
    pub path: String,
    pub glob: Option<String>,
    pub format: SftpFormat,
    pub batch_size: usize,
}

Available on crate features source-rest and source-sftp only.

Configuration for the SFTP source connector.

Fields

connection: SftpConnectionConfig

Shared SFTP connection settings (host, port, username, auth, host-key policy). Flattened, so its fields sit at the top level of the config.

path: String

Remote path to read: a directory whose files are listed and streamed, or a single file.

glob: Option<String>

Optional filename glob (* / ?) applied to the basenames of files in a directory listing. Ignored when path points at a single file.

format: SftpFormat

Format of the files to read (default: jsonl).

batch_size: usize

Records per emitted StreamPage. For jsonl / raw_text, files are decoded incrementally and a page is yielded whenever the buffer reaches this size (bounded memory). For json_array, each file is buffered fully, then its records are chunked into pages of this size. Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “no batching” sentinel: one page is emitted per file.

Implementations

impl SftpSourceConfig

pub fn new( connection: SftpConnectionConfig, path: impl Into<String>, ) -> SftpSourceConfig

Build a source config from a connection and a remote path, with default format (jsonl) and batch size.

pub fn glob(self, glob: impl Into<String>) -> SftpSourceConfig

Set the filename glob filter.

pub fn format(self, format: SftpFormat) -> SftpSourceConfig

Set the file format.

pub fn with_batch_size(self, batch_size: usize) -> SftpSourceConfig

Set the per-page record count.

Trait Implementations

impl Clone for SftpSourceConfig

fn clone(&self) -> SftpSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SftpSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SftpSourceConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<SftpSourceConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SftpSourceConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for SftpSourceConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.