Skip to content
voiage

voiage.ingestion.cli.validate

validate

Section titled “validate”
validate([positional or keyword] descriptor: Path = typer.Argument(..., exists=True, readable=True), [positional or keyword] source_root: Path | None = typer.Option(None, '--source-root', file_okay=False, exists=True, readable=True, help='Explicit local root allowed for declared resources.'), [positional or keyword] offline: bool = typer.Option(False, '--offline', help='Require an offline replay.'), [positional or keyword] cache_dir: Path | None = typer.Option(None, '--cache-dir', help='Verified materialization cache directory.'), [positional or keyword] max_resource_bytes: int = typer.Option(512 * 1024 * 1024, '--max-resource-bytes', min=1, help='Maximum accepted local resource size.'), [positional or keyword] max_resource_rows: int = typer.Option(10000000, '--max-resource-rows', min=1, help='Maximum accepted parsed rows in each local resource.'), [positional or keyword] provider: str | None = typer.Option(None, '--provider', help='Require this registered provider ID for the descriptor.'), [positional or keyword] record_set: str | None = typer.Option(None, '--record-set', help='Explicit Croissant recordSet name.'), [positional or keyword] distribution: str | None = typer.Option(None, '--distribution', help='Explicit Croissant distribution @id.')) -> None

Validate a supported descriptor and its declared local resources.

Parameters:

  • descriptor Path (default: typer.Argument(..., exists=True, readable=True))
  • source_root Path | None (default: typer.Option(None, '--source-root', file_okay=False, exists=True, readable=True, help='Explicit local root allowed for declared resources.'))
  • offline bool (default: typer.Option(False, '--offline', help='Require an offline replay.'))
  • cache_dir Path | None (default: typer.Option(None, '--cache-dir', help='Verified materialization cache directory.'))
  • max_resource_bytes int (default: typer.Option(512 * 1024 * 1024, '--max-resource-bytes', min=1, help='Maximum accepted local resource size.'))
  • max_resource_rows int (default: typer.Option(10000000, '--max-resource-rows', min=1, help='Maximum accepted parsed rows in each local resource.'))
  • provider str | None (default: typer.Option(None, '--provider', help='Require this registered provider ID for the descriptor.'))
  • record_set str | None (default: typer.Option(None, '--record-set', help='Explicit Croissant recordSet name.'))
  • distribution str | None (default: typer.Option(None, '--distribution', help='Explicit Croissant distribution @id.'))

Returns: None