paguro.validation.ValidRelations.validate(data: dict | Collection | LazyCollection, *, mode: ValidationMode = 'all', keep_columns: IntoKeepColumns = False, with_frame_index: bool | str = False, collect: bool | dict[str, Any] = True, on_success: OnSuccess = 'return_none', on_failure: OnFailureExtra = 'raise', cast: bool = False)

Validates relations against the provided data.

Parameters:
data: dict | Collection | LazyCollection

mode: ValidationMode = 'all'

  • "schema" : validate the schema

  • "data" : validate the data content

  • "all" : validate both schema and data content

  • "none"

keep_columns: IntoKeepColumns = False

The columns to keep along the validated column in the validation errors. It is useful to specify columns to inspect the rows of the target data tha do not satisfy the various constraints.

collect: bool | dict[str, Any] = True

on_success: OnSuccess = 'return_none'

on_failure: OnFailureExtra = 'raise'

cast: bool = False