flytekitplugins.dbt.schema

Class	Description
`BaseDBTInput`	Base class for DBT Task Input.
`BaseDBTOutput`	Base class for output of DBT task.
`DBTFreshnessInput`	Input to DBT Freshness task.
`DBTFreshnessOutput`	Output of DBT Freshness task.
`DBTRunInput`	Input to DBT Run task.
`DBTRunOutput`	Output of DBT run task.
`DBTTestInput`	Input to DBT Test task.
`DBTTestOutput`	Output of DBT test task.

flytekitplugins.dbt.schema.BaseDBTInput

Base class for DBT Task Input.

Attributes

project_dir : str Path to directory containing the DBT dbt_project.yml. profiles_dir : str Path to directory containing the DBT profiles.yml. profile : str Profile name to be used for the DBT task. It will override value in dbt_project.yml. target : str Target to load for the given profile (default=None). output_path : str Path to directory where compiled files (e.g. models) will be written when running the task (default=target). ignore_handled_error : bool Ignore handled error (exit code = 1) returned by DBT, see https://docs.getdbt.com/reference/exit-codes (default=False). flags : dict Dictionary containing CLI flags to be added to the dbt run command (default=False).

Parameters

        
    
class BaseDBTInput(
    project_dir: str,
    profiles_dir: str,
    profile: str,
    target: str,
    output_path: str,
    ignore_handled_error: bool,
    flags: dict,
)

Parameter	Type	Description
`project_dir`	`str`
`profiles_dir`	`str`
`profile`	`str`
`target`	`str`
`output_path`	`str`
`ignore_handled_error`	`bool`
`flags`	`dict`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_args()`	Convert the instance of BaseDBTInput into list of arguments.
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_args()

        
    
def to_args()

Convert the instance of BaseDBTInput into list of arguments.

Returns

List[str] List of arguments.

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`

flytekitplugins.dbt.schema.BaseDBTOutput

Base class for output of DBT task.

Attributes

command : str Complete CLI command and flags that was executed by DBT Task. exit_code : int Exit code returned by DBT CLI.

Parameters

        
    
class BaseDBTOutput(
    command: str,
    exit_code: int,
)

Parameter	Type	Description
`command`	`str`
`exit_code`	`int`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`

flytekitplugins.dbt.schema.DBTFreshnessInput

Input to DBT Freshness task.

Attributes

select : List[str] List of model to be executed (default : None). exclude : List[str] List of model to be excluded (default : None).

Parameters

        
    
class DBTFreshnessInput(
    project_dir: str,
    profiles_dir: str,
    profile: str,
    target: str,
    output_path: str,
    ignore_handled_error: bool,
    flags: dict,
    select: typing.Optional[typing.List[str]],
    exclude: typing.Optional[typing.List[str]],
)

Parameter	Type	Description
`project_dir`	`str`
`profiles_dir`	`str`
`profile`	`str`
`target`	`str`
`output_path`	`str`
`ignore_handled_error`	`bool`
`flags`	`dict`
`select`	`typing.Optional[typing.List[str]]`
`exclude`	`typing.Optional[typing.List[str]]`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_args()`	Convert the instance of DBTFreshnessInput into list of arguments.
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_args()

        
    
def to_args()

Convert the instance of DBTFreshnessInput into list of arguments.

Returns

List[str] List of arguments.

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`

flytekitplugins.dbt.schema.DBTFreshnessOutput

Output of DBT Freshness task.

Attributes

raw_sources : str Raw value of DBT’s sources.json.

Parameters

        
    
class DBTFreshnessOutput(
    command: str,
    exit_code: int,
    raw_sources: str,
)

Parameter	Type	Description
`command`	`str`
`exit_code`	`int`
`raw_sources`	`str`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`

flytekitplugins.dbt.schema.DBTRunInput

Input to DBT Run task.

Attributes

select : List[str] List of model to be executed (default=None). exclude : List[str] List of model to be excluded (default=None).

Parameters

        
    
class DBTRunInput(
    project_dir: str,
    profiles_dir: str,
    profile: str,
    target: str,
    output_path: str,
    ignore_handled_error: bool,
    flags: dict,
    select: typing.Optional[typing.List[str]],
    exclude: typing.Optional[typing.List[str]],
)

Parameter	Type	Description
`project_dir`	`str`
`profiles_dir`	`str`
`profile`	`str`
`target`	`str`
`output_path`	`str`
`ignore_handled_error`	`bool`
`flags`	`dict`
`select`	`typing.Optional[typing.List[str]]`
`exclude`	`typing.Optional[typing.List[str]]`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_args()`	Convert the instance of BaseDBTInput into list of arguments.
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_args()

        
    
def to_args()

Convert the instance of BaseDBTInput into list of arguments.

Returns

List[str] List of arguments.

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`

flytekitplugins.dbt.schema.DBTRunOutput

Output of DBT run task.

Attributes

raw_run_result : str Raw value of DBT’s run_result.json. raw_manifest : str Raw value of DBT’s manifest.json.

Parameters

        
    
class DBTRunOutput(
    command: str,
    exit_code: int,
    raw_run_result: str,
    raw_manifest: str,
)

Parameter	Type	Description
`command`	`str`
`exit_code`	`int`
`raw_run_result`	`str`
`raw_manifest`	`str`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`

        
    
class DBTTestInput(
    project_dir: str,
    profiles_dir: str,
    profile: str,
    target: str,
    output_path: str,
    ignore_handled_error: bool,
    flags: dict,
    select: typing.Optional[typing.List[str]],
    exclude: typing.Optional[typing.List[str]],
)

Parameter	Type	Description
`project_dir`	`str`
`profiles_dir`	`str`
`profile`	`str`
`target`	`str`
`output_path`	`str`
`ignore_handled_error`	`bool`
`flags`	`dict`
`select`	`typing.Optional[typing.List[str]]`
`exclude`	`typing.Optional[typing.List[str]]`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_args()`	Convert the instance of DBTTestInput into list of arguments.
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_args()

        
    
def to_args()

Convert the instance of DBTTestInput into list of arguments.

Returns

List[str] List of arguments.

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`

        
    
class DBTTestOutput(
    command: str,
    exit_code: int,
    raw_run_result: str,
    raw_manifest: str,
)

Parameter	Type	Description
`command`	`str`
`exit_code`	`int`
`raw_run_result`	`str`
`raw_manifest`	`str`

Methods

Method	Description
`from_dict()`
`from_json()`
`schema()`
`to_dict()`
`to_json()`

from_dict()

        
    
def from_dict(
    kvs: typing.Union[dict, list, str, int, float, bool, NoneType],
    infer_missing,
) -> ~A

Parameter	Type	Description
`kvs`	`typing.Union[dict, list, str, int, float, bool, NoneType]`
`infer_missing`

from_json()

        
    
def from_json(
    s: typing.Union[str, bytes, bytearray],
    parse_float,
    parse_int,
    parse_constant,
    infer_missing,
    kw,
) -> ~A

Parameter	Type	Description
`s`	`typing.Union[str, bytes, bytearray]`
`parse_float`
`parse_int`
`parse_constant`
`infer_missing`
`kw`

schema()

        
    
def schema(
    infer_missing: bool,
    only,
    exclude,
    many: bool,
    context,
    load_only,
    dump_only,
    partial: bool,
    unknown,
) -> SchemaType[A]

Parameter	Type	Description
`infer_missing`	`bool`
`only`
`exclude`
`many`	`bool`
`context`
`load_only`
`dump_only`
`partial`	`bool`
`unknown`

to_dict()

        
    
def to_dict(
    encode_json,
) -> typing.Dict[str, typing.Union[dict, list, str, int, float, bool, NoneType]]

Parameter	Type	Description
`encode_json`

to_json()

        
    
def to_json(
    skipkeys: bool,
    ensure_ascii: bool,
    check_circular: bool,
    allow_nan: bool,
    indent: typing.Union[int, str, NoneType],
    separators: typing.Tuple[str, str],
    default: typing.Callable,
    sort_keys: bool,
    kw,
) -> str

Parameter	Type	Description
`skipkeys`	`bool`
`ensure_ascii`	`bool`
`check_circular`	`bool`
`allow_nan`	`bool`
`indent`	`typing.Union[int, str, NoneType]`
`separators`	`typing.Tuple[str, str]`
`default`	`typing.Callable`
`sort_keys`	`bool`
`kw`