DatasetCollectionClient

apify_client.clients.DatasetCollectionClient

Sub-client for manipulating datasets.

Index

Methods

• get_or_create
• list

Methods

get_or_create

• get_or_create(*, name, schema): Dict

• Retrieve a named dataset, or create a new one when it doesn’t exist.

  https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset

  ---

  Parameters

  • name: Optional[str] = Noneoptionalkeyword-only

    The name of the dataset to retrieve or create.

  • schema: Optional[Dict] = Noneoptionalkeyword-only

    The schema of the dataset

  Returns Dict

  The retrieved or newly-created dataset.

list

• list(*, unnamed, limit, offset, desc): ListPage[Dict]

• List the available datasets.

  https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets

  ---

  Parameters

  • unnamed: Optional[bool] = Noneoptionalkeyword-only

    Whether to include unnamed datasets in the list

  • limit: Optional[int] = Noneoptionalkeyword-only

    How many datasets to retrieve

  • offset: Optional[int] = Noneoptionalkeyword-only

    What dataset to include as first when retrieving the list

  • desc: Optional[bool] = Noneoptionalkeyword-only

    Whether to sort the datasets in descending order based on their modification date

  Returns ListPage[Dict]

  The list of available datasets matching the specified filters.