DatasetClient

Sub-client for manipulating a single dataset.

Index

Methods

• delete
• download_items
• get
• get_items_as_bytes
• iterate_items
• list_items
• push_items
• stream_items
• update

Methods

delete

• delete(): None

• Delete the dataset.

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

  ---

  Returns None

download_items

• download_items(*, 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.

  Deprecated: this function is a deprecated alias of get_items_as_bytes. It will be removed in a future version.

  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

get

• get(): dict | None

• Retrieve the dataset.

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

  ---

  Returns dict | None

get_items_as_bytes

• 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

• iterate_items(*, offset, limit, clean, desc, fields, omit, unwind, skip_empty, skip_hidden): Iterator[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 Iterator[dict]

list_items

• 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

• push_items(items): None

• Push items to the dataset.

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

  ---

  Parameters

  • items: JSONSerializable

  Returns None

stream_items

• stream_items(*, item_format, offset, limit, desc, clean, bom, delimiter, fields, omit, unwind, skip_empty, skip_header_row, skip_hidden, xml_root, xml_row): Iterator[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 Iterator[httpx.Response]

update

• update(*, name): dict

• Update the dataset with specified fields.

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

  ---

  Parameters

  • keyword-onlyname: str | None = None

  Returns dict