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 (str | None)

• metadata (Optional[literals.StructuredDatasetMetadata])

all()

Return type:

DF

classmethod column_names()

Return type:

List[str]

classmethod columns()

Return type:

Dict[str, Type]

classmethod from_dict(d, *, dialect=None)

classmethod from_json(data, decoder=<function loads>, **from_dict_kwargs)

Parameters:

• data (str | bytes | bytearray)

• decoder (Callable[[str | bytes | bytearray], Dict[Any, Any]])

• from_dict_kwargs (Any)

Return type:

T

iter()

Return type:

Generator[DF, None, None]

open(dataframe_type)

Parameters:

dataframe_type (Type[DF])

to_dict()

to_json(encoder=<function dumps>, **to_dict_kwargs)

Parameters:

• self (T)

• encoder (Callable[[Any], str | bytes | bytearray])

• to_dict_kwargs (Any)

Return type:

str | bytes | bytearray

Attributes

dataframe

file_format: str | None = ''

literal

metadata

uri: str | None = None