# SodaSQL Tasks


This module contains a collection of tasks to run Data Quality tests using soda-sql library

# SodaSQLScan

class

prefect.tasks.sodasql.sodasql_tasks.SodaSQLScan

(scan_def=None, warehouse_def=None, **kwargs)[source]

Task for running a SodaSQL scan given a scan definition and a warehouse definition.

Args:

  • scan_def (dict, str, optional): scan definition. Can be either a path a SodaSQL Scan YAML file or a dictionary. For more information regarding SodaSQL Scan YAML files refer to https://docs.soda.io/soda-sql/documentation/scan.html
  • warehouse_def (dict, str, optional): warehouse definition. Can be either a path to a SodaSQL Warehouse YAML file or a dictionary. For more information regarding SodaSQL Warehouse YAML files refer to https://docs.soda.io/soda-sql/documentation/warehouse.html
  • **kwargs (dict, optional): additional keyword arguments to pass to the Task constructor

methods:                                                                                                                                                       

prefect.tasks.sodasql.sodasql_tasks.SodaSQLScan.run

(scan_def=None, warehouse_def=None)[source]

Task run method. Execute a Scan against a Scan definition using a Warehouse definition.

Args:

  • scan_def (dict, str, optional): scan definition. Can be either a path a SodaSQL Scan YAML file or a dictionary. For more information regarding SodaSQL Scan YAML files refer to https://docs.soda.io/soda-sql/documentation/scan.html
  • warehouse_def (dict, str, optional): warehouse definition. Can be either a path to a SodaSQL Warehouse YAML file or a dictionary. For more information regarding SodaSQL Warehouse YAML files refer to https://docs.soda.io/soda-sql/documentation/warehouse.html
Returns:
    Raises:
    • ValueError: if either scan_def or warehouse_def are None



    This documentation was auto-generated from commit 0464042
    on November 15, 2021 at 16:57 UTC