pub struct AnalysisOptions { /* private fields */ }Expand description
What to analyze, and how, for a single profiling run.
Construct with AnalysisOptions::default (analyze everything) and narrow
with the builder methods.
Implementations§
Source§impl AnalysisOptions
impl AnalysisOptions
Sourcepub fn with_columns(self, columns: Option<Vec<String>>) -> Self
pub fn with_columns(self, columns: Option<Vec<String>>) -> Self
Select top-level columns to profile. None (the default) means every column.
Selection is by name and reports remain in source-schema order. An empty vector requests a schema with no profiled columns.
Sourcepub fn with_metric_packs(self, packs: Option<Vec<MetricPack>>) -> Self
pub fn with_metric_packs(self, packs: Option<Vec<MetricPack>>) -> Self
Select the metric packs to compute. None (the default) means all.
Sourcepub fn with_quality_dimensions(
self,
dimensions: Option<Vec<QualityDimension>>,
) -> Self
pub fn with_quality_dimensions( self, dimensions: Option<Vec<QualityDimension>>, ) -> Self
Select the quality dimensions to assess. None (the default) means all.
Sourcepub fn with_locale(self, locale: Option<Locale>) -> Self
pub fn with_locale(self, locale: Option<Locale>) -> Self
Set the locale used to rank detected patterns.
Parse a user-supplied tag with Locale::parse_optional first, so an
unrecognised tag is rejected where it is written rather than silently
suppressing every locale-specific pattern.
Sourcepub fn with_semantic_hints(self, hints: SemanticHints) -> Self
pub fn with_semantic_hints(self, hints: SemanticHints) -> Self
Set the user’s semantic hints.
Sourcepub fn with_reference_date(self, reference_date: Option<NaiveDate>) -> Self
pub fn with_reference_date(self, reference_date: Option<NaiveDate>) -> Self
Fix the date timeliness measures against. None (the default) reads
today’s UTC date when the run starts, so an unchanged file’s timeliness
moves as the calendar does; a fixed date makes it reproducible (#903).
The report records which one the score used.
Sourcepub fn with_duplicate_rows_exact_limit(self, limit: Option<usize>) -> Self
pub fn with_duplicate_rows_exact_limit(self, limit: Option<usize>) -> Self
Count duplicate rows exactly up to limit distinct rows (#1292).
None (the default) keeps the built-in limit of one million distinct
rows, past which the count is an estimate and the memory budget may
end the exact count earlier. A limit set here is a row count, so the
verdict does not depend on the machine: the row tracker keeps its exact
set up to the limit whatever memory_limit_mb says, at 10 to 20 bytes
per distinct row, and that set is not counted against the budget.
Sourcepub fn effective_metric_packs(&self) -> Option<Vec<MetricPack>>
pub fn effective_metric_packs(&self) -> Option<Vec<MetricPack>>
The packs to compute, with an empty quality-dimension selection folded in.
Resolved on read rather than in the setters so the outcome does not depend on the order the selections were made in.
Sourcepub fn selected_metric_packs(&self) -> Vec<MetricPack>
pub fn selected_metric_packs(&self) -> Vec<MetricPack>
Every pack the run computes, in MetricPack::all order: the
effective selection with the schema pack, which is always computed,
made explicit. Two requests that compute the same packs return the
same list, whatever order or repetition they were given in.
Sourcepub fn include_statistics(&self) -> bool
pub fn include_statistics(&self) -> bool
Whether per-column statistics should be computed.
Sourcepub fn include_patterns(&self) -> bool
pub fn include_patterns(&self) -> bool
Whether pattern detection should run.
Sourcepub fn include_quality(&self) -> bool
pub fn include_quality(&self) -> bool
Whether quality metrics should be computed.
false means the report carries no quality at all — absent, not an
empty assessment — because nothing was analyzed.
Sourcepub fn locale(&self) -> Option<Locale>
pub fn locale(&self) -> Option<Locale>
The locale used to rank detected patterns.
A locale only ranks patterns, so it has no effect of its own when
include_patterns is false and detection never
runs.
Sourcepub fn reference_date(&self) -> Option<NaiveDate>
pub fn reference_date(&self) -> Option<NaiveDate>
The fixed timeliness reference date, or None to read today’s.
Sourcepub fn duplicate_rows_exact_limit(&self) -> Option<usize>
pub fn duplicate_rows_exact_limit(&self) -> Option<usize>
The duplicate-row exact limit the caller set, or None for the default.
Sourcepub fn quality_dimensions(&self) -> Option<&[QualityDimension]>
pub fn quality_dimensions(&self) -> Option<&[QualityDimension]>
The requested quality dimensions, if the caller narrowed them.
Sourcepub fn semantic_hints(&self) -> &SemanticHints
pub fn semantic_hints(&self) -> &SemanticHints
The user’s semantic hints.
Sourcepub fn columns(&self) -> Option<&[String]>
pub fn columns(&self) -> Option<&[String]>
The requested top-level column names, or None when every column is selected.
Sourcepub fn has_column_projection(&self) -> bool
pub fn has_column_projection(&self) -> bool
Whether the caller selected a subset of the source columns.
Sourcepub fn column_indices(
&self,
available: &[String],
) -> Result<Option<Vec<usize>>, DataProfilerError>
pub fn column_indices( &self, available: &[String], ) -> Result<Option<Vec<usize>>, DataProfilerError>
Resolve the selected columns against a source schema.
Returned indices follow source order, not request order, so every input path preserves the same stable report ordering. Unknown and duplicate requests fail rather than producing a plausible partial profile.
Trait Implementations§
Source§impl Clone for AnalysisOptions
impl Clone for AnalysisOptions
Source§impl Debug for AnalysisOptions
impl Debug for AnalysisOptions
Source§impl Default for AnalysisOptions
impl Default for AnalysisOptions
impl Eq for AnalysisOptions
Source§impl PartialEq for AnalysisOptions
impl PartialEq for AnalysisOptions
impl StructuralPartialEq for AnalysisOptions
Auto Trait Implementations§
impl Forget for AnalysisOptions
impl Freeze for AnalysisOptions
impl Move for AnalysisOptions
impl RefUnwindSafe for AnalysisOptions
impl Send for AnalysisOptions
impl Sync for AnalysisOptions
impl Unpin for AnalysisOptions
impl UnsafeUnpin for AnalysisOptions
impl UnwindSafe for AnalysisOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.