DatasetClient

Sub-client for manipulating a single dataset.

Index

Methods

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

Methods

create_items_public_url

• 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

• 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, signature): 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: 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

• 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, 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

• get_statistics(): dict | None

• Get the dataset statistics.

  https://docs.apify.com/api/v2#tag/DatasetsStatistics/operation/dataset_statistics_get

  ---

  Returns dict | None

iterate_items

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

  • keyword-onlyskip_empty: bool | None = None

  • keyword-onlyskip_hidden: bool | None = None

  • keyword-onlysignature: str | None = None

  Returns Iterator[dict]

list_items

• 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

• 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, signature): Iterator[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 Iterator[impit.Response]

update

• update(*, name, general_access): dict

• Update the dataset with specified fields.

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

  ---

  Parameters

  • keyword-onlyname: str | None = None

  • keyword-onlygeneral_access: StorageGeneralAccess | None = None

  Returns dict