flytekit.types.structured.StructuredDataset

class flytekit.types.structured.StructuredDataset(dataframe=None, uri=None, metadata=None, **kwargs)

This is the user facing StructuredDataset class. Please don’t confuse it with the literals.StructuredDataset class (that is just a model, a Python class representation of the protobuf).

Methods

Parameters

• dataframe (Optional[Any]) –

• uri (Optional[str]) –

• metadata (Optional[literals.StructuredDatasetMetadata]) –

all()

Return type

flytekit.types.structured.structured_dataset.DF

classmethod column_names()

Return type

List[str]

classmethod columns()

Return type

Dict[str, Type]

classmethod from_dict(kvs, *, infer_missing=False)

Parameters

kvs (Optional[Union[dict, list, str, int, float, bool]]) –

Return type

dataclasses_json.api.A

classmethod from_json(s, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw)

Parameters

s (Union[str, bytes, bytearray]) –

Return type

dataclasses_json.api.A

iter()

Return type

Generator[flytekit.types.structured.structured_dataset.DF, None, None]

open(dataframe_type)

Parameters

dataframe_type (Type[flytekit.types.structured.structured_dataset.DF]) –

classmethod schema(*, infer_missing=False, only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Parameters

• infer_missing (bool) –

• many (bool) –

• partial (bool) –

Return type

dataclasses_json.mm.SchemaF[dataclasses_json.mm.A]

to_dict(encode_json=False)

Return type

Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, indent=None, separators=None, default=None, sort_keys=False, **kw)

Parameters

• skipkeys (bool) –

• ensure_ascii (bool) –

• check_circular (bool) –

• allow_nan (bool) –

• indent (Optional[Union[int, str]]) –

• separators (Optional[Tuple[str, str]]) –

• default (Optional[Callable]) –

• sort_keys (bool) –

Return type

str

Attributes

dataframe

file_format: Optional[str] = ''

literal

metadata

uri: Optional[str] = None