snowflake.snowpark_checkpoints.check_input_schema

snowflake.snowpark_checkpoints.check_input_schema(pandera_schema: DataFrameSchema, checkpoint_name: str, sample_frac: float | None = 1.0, sample_number: int | None = None, sampling_strategy: SamplingStrategy | None = 1, job_context: SnowparkJobContext | None = None, output_path: str | None = None)

Decorate factory for validating input DataFrame schemas before function execution.

Parameters:

  • pandera_schema (DataFrameSchema) – The Pandera schema to validate against.

  • checkpoint_name (Optional[str], optional) – The name of the checkpoint to retrieve the schema.

  • sample_frac (Optional[float], optional) – Fraction of data to sample. Defaults to 0.1.

  • sample_number (Optional[int], optional) – Number of rows to sample. Defaults to None.

  • sampling_strategy (Optional[SamplingStrategy], optional) – Strategy for sampling data. Defaults to SamplingStrategy.RANDOM_SAMPLE.

  • job_context (SnowparkJobContext, optional) – Context for job-related operations. Defaults to None.

  • output_path (Optional[str], optional) – The output path for the validation results.

Language: English