Skip to main content

DatasetClientAsync

Async sub-client for manipulating a single dataset.

Index

Methods

Methods

delete

  • async delete(): None

get

  • async get(): dict | None

get_items_as_bytes

  • async get_items_as_bytes(*, item_format, offset, limit, desc, clean, bom, delimiter, fields, omit, unwind, skip_empty, skip_header_row, skip_hidden, xml_root, xml_row, flatten): bytes

  • Get the items in the dataset as raw bytes.

    https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items

    Parameters

    • keyword-onlyitem_format: str = 'json'
    • keyword-onlyoffset: int | None = None
    • keyword-onlylimit: int | None = None
    • keyword-onlydesc: bool | None = None
    • keyword-onlyclean: bool | None = None
    • keyword-onlybom: bool | None = None
    • keyword-onlydelimiter: str | None = None
    • keyword-onlyfields: list[str] | None = None
    • keyword-onlyomit: list[str] | None = None
    • keyword-onlyunwind: str | list[str] | None = None
    • keyword-onlyskip_empty: bool | None = None
    • keyword-onlyskip_header_row: bool | None = None
    • keyword-onlyskip_hidden: bool | None = None
    • keyword-onlyxml_root: str | None = None
    • keyword-onlyxml_row: str | None = None
    • keyword-onlyflatten: list[str] | None = None

    Returns bytes

iterate_items

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

  • Iterate over the items in the dataset.

    https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items

    Parameters

    • keyword-onlyoffset: int = 0
    • keyword-onlylimit: int | None = None
    • keyword-onlyclean: bool | None = None
    • keyword-onlydesc: bool | None = None
    • keyword-onlyfields: list[str] | None = None
    • keyword-onlyomit: list[str] | None = None
    • keyword-onlyunwind: str | list[str] | None = None
    • keyword-onlyskip_empty: bool | None = None
    • keyword-onlyskip_hidden: bool | None = None

    Returns AsyncIterator[dict]

list_items

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

  • List the items of the dataset.

    https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items

    Parameters

    • keyword-onlyoffset: int | None = None
    • keyword-onlylimit: int | None = None
    • keyword-onlyclean: bool | None = None
    • keyword-onlydesc: bool | None = None
    • keyword-onlyfields: list[str] | None = None
    • keyword-onlyomit: list[str] | None = None
    • keyword-onlyunwind: str | list[str] | None = None
    • keyword-onlyskip_empty: bool | None = None
    • keyword-onlyskip_hidden: bool | None = None
    • keyword-onlyflatten: list[str] | None = None
    • keyword-onlyview: str | None = None

    Returns ListPage

push_items

  • async push_items(items): None

stream_items

  • async stream_items(*, item_format, offset, limit, desc, clean, bom, delimiter, fields, omit, unwind, skip_empty, skip_header_row, skip_hidden, xml_root, xml_row): AsyncIterator[httpx.Response]

  • Retrieve the items in the dataset as a stream.

    https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-items

    Parameters

    • keyword-onlyitem_format: str = 'json'
    • keyword-onlyoffset: int | None = None
    • keyword-onlylimit: int | None = None
    • keyword-onlydesc: bool | None = None
    • keyword-onlyclean: bool | None = None
    • keyword-onlybom: bool | None = None
    • keyword-onlydelimiter: str | None = None
    • keyword-onlyfields: list[str] | None = None
    • keyword-onlyomit: list[str] | None = None
    • keyword-onlyunwind: str | list[str] | None = None
    • keyword-onlyskip_empty: bool | None = None
    • keyword-onlyskip_header_row: bool | None = None
    • keyword-onlyskip_hidden: bool | None = None
    • keyword-onlyxml_root: str | None = None
    • keyword-onlyxml_row: str | None = None

    Returns AsyncIterator[httpx.Response]

update

  • async update(*, name): dict
Page Options