ApifyDatasetClient

An Apify platform implementation of the dataset client.

Index

Methods

• __init__
• drop
• get_data
• get_metadata
• iterate_items
• open
• purge
• push_data

Methods

__init__

• __init__(*, api_client, api_public_base_url, lock): None

• Initialize a new instance.

  Preferably use the ApifyDatasetClient.open class method to create a new instance.

  ---

  Parameters

  • keyword-onlyapi_client: DatasetClientAsync

  • keyword-onlyapi_public_base_url: str

  • keyword-onlylock: asyncio.Lock

  Returns None

drop

• async drop(): None

• Returns None

get_data

• async get_data(*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden, flatten, view): DatasetItemsListPage

• Parameters

  • optionalkeyword-onlyoffset: int = 0

  • optionalkeyword-onlylimit: int | None = 999_999_999_999

  • optionalkeyword-onlyclean: bool = False

  • optionalkeyword-onlydesc: bool = False

  • optionalkeyword-onlyfields: list[str] | None = None

  • optionalkeyword-onlyomit: list[str] | None = None

  • optionalkeyword-onlyunwind: list[str] | None = None

  • optionalkeyword-onlyskip_empty: bool = False

  • optionalkeyword-onlyskip_hidden: bool = False

  • optionalkeyword-onlyflatten: list[str] | None = None

  • optionalkeyword-onlyview: str | None = None

  Returns DatasetItemsListPage

get_metadata

• async get_metadata(): DatasetMetadata

• Returns DatasetMetadata

iterate_items

• async iterate_items(*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden): AsyncIterator[dict]

• Parameters

  • optionalkeyword-onlyoffset: int = 0

  • optionalkeyword-onlylimit: int | None = None

  • optionalkeyword-onlyclean: bool = False

  • optionalkeyword-onlydesc: bool = False

  • optionalkeyword-onlyfields: list[str] | None = None

  • optionalkeyword-onlyomit: list[str] | None = None

  • optionalkeyword-onlyunwind: list[str] | None = None

  • optionalkeyword-onlyskip_empty: bool = False

  • optionalkeyword-onlyskip_hidden: bool = False

  Returns AsyncIterator[dict]

open

• async open(*, id, name, alias, configuration): ApifyDatasetClient

• Open an Apify dataset client.

  This method creates and initializes a new instance of the Apify dataset client. It handles authentication, storage lookup/creation, and metadata retrieval.

  ---

  Parameters

  • keyword-onlyid: str | None

    The ID of the dataset to open. If provided, searches for existing dataset by ID. Mutually exclusive with name and alias.

  • keyword-onlyname: str | None

    The name of the dataset to open (global scope, persists across runs). Mutually exclusive with id and alias.

  • keyword-onlyalias: str | None

    The alias of the dataset to open (run scope, creates unnamed storage). Mutually exclusive with id and name.

  • keyword-onlyconfiguration: Configuration

    The configuration object containing API credentials and settings. Must include a valid token and api_base_url. May also contain a default_dataset_id for fallback when neither id, name, nor alias is provided.

  Returns ApifyDatasetClient

purge

• async purge(): None

• Returns None

push_data

• async push_data(data): None

• Parameters

  • data: list[Any] | dict[str, Any]

  Returns None