Skip to main content
Version: 2.5

DatasetClientAsync

Async sub-client for manipulating a single dataset.

Index

Methods

Methods

create_items_public_url

  • async create_items_public_url(*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden, flatten, view, expires_in_secs): str

  • Generate a URL that can be used to access dataset items.

    If the client has permission to access the dataset's URL signing key, the URL will include a signature to verify its authenticity.

    You can optionally control how long the signed URL should be valid using the expires_in_secs option. This value sets the expiration duration in seconds from the time the URL is generated. If not provided, the URL will not expire.

    Any other options (like limit or offset) will be included as query parameters in the URL.

    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: 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
    • keyword-onlyexpires_in_secs: int | None = None

    Returns str

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, signature): 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: 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
    • keyword-onlysignature: str | None = None

    Returns bytes

get_statistics

  • async get_statistics(): dict | None

iterate_items

  • async iterate_items(*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden, signature): 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: list[str] | None = None
    • keyword-onlyskip_empty: bool | None = None
    • keyword-onlyskip_hidden: bool | None = None
    • keyword-onlysignature: str | None = None

    Returns AsyncIterator[dict]

list_items

  • async list_items(*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden, flatten, view, signature): 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: 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
    • keyword-onlysignature: 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, signature): AsyncIterator[impit.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: 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-onlysignature: str | None = None

    Returns AsyncIterator[impit.Response]

update

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