GetDataFunction

A function for retrieving data from a Dataset.

It simplifies the process of accessing data from a Dataset. It opens the specified one and retrieves data based on the provided parameters. It allows filtering and pagination.

Index

Methods

• __call__

Methods

__call__

• __call__(dataset_id, dataset_name, kwargs): Coroutine[None, None, DatasetItemsListPage]

• Call dunder method.

  ---

  Parameters

  • optionaldataset_id: str | None = None

    ID of the Dataset to get data from.

  • optionaldataset_name: str | None = None

    Name of the Dataset to get data from.

  • keyword-onlyoptionaloffset: int

    Skips the specified number of items at the start.

  • keyword-onlyoptionallimit: int

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

  • keyword-onlyoptionalclean: bool

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

  • keyword-onlyoptionaldesc: bool

    Set to True to sort results in descending order.

  • keyword-onlyoptionalfields: list[str]

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

  • keyword-onlyoptionalomit: list[str]

    Fields to exclude from each item.

  • keyword-onlyoptionalunwind: str

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

  • keyword-onlyoptionalskip_empty: bool

    Excludes empty items from the results if True.

  • keyword-onlyoptionalskip_hidden: bool

    Excludes fields starting with '#' if True.

  • keyword-onlyoptionalflatten: list[str]

    Fields to be flattened in returned items.

  • keyword-onlyoptionalview: str

    Specifies the dataset view to be used.

  Returns Coroutine[None, None, DatasetItemsListPage]