Method scan_with_args

datafusion/catalog/src/table.rs:209–221

Create an [`ExecutionPlan`] for scanning the table using structured arguments. This method uses [`ScanArgs`] to pass scan parameters in a structured way and returns a [`ScanResult`] containing the execution plan. Table providers can override this method to take advantage of additional parameters like the upcoming `preferred_ordering` that may not be available through other scan methods. # Argum

(
        &self,
        state: &dyn Session,
        args: ScanArgs<'a>,
    )

    ///
    /// See [`Self::scan`] for detailed documentation about projection, filters, and limits.
    async fn scan_with_args<'a>(
        &self,
        state: &dyn Session,
        args: ScanArgs<'a>,
    ) -> Result<ScanResult> {
        let filters = args.filters().unwrap_or(&[]);
        let projection = args.projection().map(|p| p.to_vec());
        let limit = args.limit();
        let plan = self
            .scan(state, projection.as_ref(), filters, limit)
            .await?;
        Ok(plan.into())
    }

    /// Specify if DataFusion should provide filter expressions to the
    /// TableProvider to apply *during* the scan.