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'

    Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json.

  • keyword-onlyoffset: int | None = None

    Number of items that should be skipped at the start. The default value is 0

  • keyword-onlylimit: int | None = None

    Maximum number of items to return. By default there is no limit.

  • keyword-onlydesc: bool | None = None

    By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.

  • keyword-onlyclean: bool | None = None

    If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.

  • keyword-onlybom: bool | None = None

    All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want to override this default behavior, specify bom=True query parameter to include the BOM or bom=False to skip it.

  • keyword-onlydelimiter: str | None = None

    A delimiter character for CSV files. The default delimiter is a simple comma (,).

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

    A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.

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

    A list of fields which should be omitted from the items.

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

    A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.

  • keyword-onlyskip_empty: bool | None = None

    If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.

  • keyword-onlyskip_header_row: bool | None = None

    If True, then header row in the csv format is skipped.

  • keyword-onlyskip_hidden: bool | None = None

    If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.

  • keyword-onlyxml_root: str | None = None

    Overrides default root element name of xml output. By default the root element is items.

  • keyword-onlyxml_row: str | None = None

    Overrides default element name that wraps each page or page function result object in xml output. By default the element name is item.

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

    A list of fields that should be flattened

  Returns bytes

  The dataset items as raw bytes

get

• get(): dict | None

• Retrieve the dataset.

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

  ---

  Returns dict | None

  The retrieved dataset, or None, if it does not exist

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'

    Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json.

  • keyword-onlyoffset: int | None = None

    Number of items that should be skipped at the start. The default value is 0

  • keyword-onlylimit: int | None = None

    Maximum number of items to return. By default there is no limit.

  • keyword-onlydesc: bool | None = None

    By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.

  • keyword-onlyclean: bool | None = None

    If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.

  • keyword-onlybom: bool | None = None

    All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want to override this default behavior, specify bom=True query parameter to include the BOM or bom=False to skip it.

  • keyword-onlydelimiter: str | None = None

    A delimiter character for CSV files. The default delimiter is a simple comma (,).

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

    A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.

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

    A list of fields which should be omitted from the items.

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

    A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.

  • keyword-onlyskip_empty: bool | None = None

    If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.

  • keyword-onlyskip_header_row: bool | None = None

    If True, then header row in the csv format is skipped.

  • keyword-onlyskip_hidden: bool | None = None

    If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.

  • keyword-onlyxml_root: str | None = None

    Overrides default root element name of xml output. By default the root element is items.

  • keyword-onlyxml_row: str | None = None

    Overrides default element name that wraps each page or page function result object in xml output. By default the element name is item.

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

    A list of fields that should be flattened

  Returns bytes

  The dataset items as raw 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

    Number of items that should be skipped at the start. The default value is 0

  • keyword-onlylimit: int | None = None

    Maximum number of items to return. By default there is no limit.

  • keyword-onlyclean: bool | None = None

    If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.

  • keyword-onlydesc: bool | None = None

    By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.

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

    A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.

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

    A list of fields which should be omitted from the items.

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

    A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.

  • keyword-onlyskip_empty: bool | None = None

    If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.

  • keyword-onlyskip_hidden: bool | None = None

    If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.

    Yields: dict: An item from the dataset

  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

    Number of items that should be skipped at the start. The default value is 0

  • keyword-onlylimit: int | None = None

    Maximum number of items to return. By default there is no limit.

  • keyword-onlyclean: bool | None = None

    If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.

  • keyword-onlydesc: bool | None = None

    By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.

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

    A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.

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

    A list of fields which should be omitted from the items.

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

    A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.

  • keyword-onlyskip_empty: bool | None = None

    If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.

  • keyword-onlyskip_hidden: bool | None = None

    If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.

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

    A list of fields that should be flattened

  • keyword-onlyview: str | None = None

    Name of the dataset view to be used

  Returns ListPage

  A page of the list of dataset items according to the specified filters.

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'

    Format of the results, possible values are: json, jsonl, csv, html, xlsx, xml and rss. The default value is json.

  • keyword-onlyoffset: int | None = None

    Number of items that should be skipped at the start. The default value is 0

  • keyword-onlylimit: int | None = None

    Maximum number of items to return. By default there is no limit.

  • keyword-onlydesc: bool | None = None

    By default, results are returned in the same order as they were stored. To reverse the order, set this parameter to True.

  • keyword-onlyclean: bool | None = None

    If True, returns only non-empty items and skips hidden fields (i.e. fields starting with the # character). The clean parameter is just a shortcut for skip_hidden=True and skip_empty=True parameters. Note that since some objects might be skipped from the output, that the result might contain less items than the limit value.

  • keyword-onlybom: bool | None = None

    All text responses are encoded in UTF-8 encoding. By default, csv files are prefixed with the UTF-8 Byte Order Mark (BOM), while json, jsonl, xml, html and rss files are not. If you want to override this default behavior, specify bom=True query parameter to include the BOM or bom=False to skip it.

  • keyword-onlydelimiter: str | None = None

    A delimiter character for CSV files. The default delimiter is a simple comma (,).

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

    A list of fields which should be picked from the items, only these fields will remain in the resulting record objects. Note that the fields in the outputted items are sorted the same way as they are specified in the fields parameter. You can use this feature to effectively fix the output format.

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

    A list of fields which should be omitted from the items.

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

    A list of fields which should be unwound, in order which they should be processed. Each field should be either an array or an object. If the field is an array then every element of the array will become a separate record and merged with parent object. If the unwound field is an object then it is merged with the parent object. If the unwound field is missing or its value is neither an array nor an object and therefore cannot be merged with a parent object, then the item gets preserved as it is. Note that the unwound items ignore the desc parameter.

  • keyword-onlyskip_empty: bool | None = None

    If True, then empty items are skipped from the output. Note that if used, the results might contain less items than the limit value.

  • keyword-onlyskip_header_row: bool | None = None

    If True, then header row in the csv format is skipped.

  • keyword-onlyskip_hidden: bool | None = None

    If True, then hidden fields are skipped from the output, i.e. fields starting with the # character.

  • keyword-onlyxml_root: str | None = None

    Overrides default root element name of xml output. By default the root element is items.

  • keyword-onlyxml_row: str | None = None

    Overrides default element name that wraps each page or page function result object in xml output. By default the element name is item.

  Returns Iterator[httpx.Response]

  The dataset items as a context-managed streaming 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

    The new name for the dataset

  Returns dict

  The updated dataset