GetDataKwargs

Keyword arguments for dataset's get_data method.

Index

Properties

• clean
• desc
• fields
• flatten
• limit
• offset
• omit
• skip_empty
• skip_hidden
• unwind
• view

Properties

keyword-onlyoptionalclean

clean: NotRequired[bool]

Return only non-empty items and excludes hidden fields. Shortcut for skip_hidden and skip_empty.

keyword-onlyoptionaldesc

desc: NotRequired[bool]

Set to True to sort results in descending order.

keyword-onlyoptionalfields

fields: NotRequired[list[str]]

Fields to include in each item. Sorts fields as specified if provided.

keyword-onlyoptionalflatten

flatten: NotRequired[list[str]]

Fields to be flattened in returned items.

keyword-onlyoptionallimit

limit: NotRequired[int | None]

The maximum number of items to retrieve. Unlimited if None.

keyword-onlyoptionaloffset

offset: NotRequired[int]

Skips the specified number of items at the start.

keyword-onlyoptionalomit

omit: NotRequired[list[str]]

Fields to exclude from each item.

keyword-onlyoptionalskip_empty

skip_empty: NotRequired[bool]

Excludes empty items from the results if True.

keyword-onlyoptionalskip_hidden

skip_hidden: NotRequired[bool]

Excludes fields starting with '#' if True.

keyword-onlyoptionalunwind

unwind: NotRequired[str]

Unwinds items by a specified array field, turning each element into a separate item.

keyword-onlyoptionalview

view: NotRequired[str]

Specifies the dataset view to be used.