DatasetClient

Subclient for manipulating a single dataset.

Index

Methods

• __init__
• delete
• get
• get_items_as_bytes
• get_start_and_end_indexes
• iterate_items
• list_items
• push_items
• stream_items
• update
• update_timestamps

Properties

• resource_directory
• resource_info

Methods

__init__

• __init__(*, memory_storage_client, id, name, created_at, accessed_at, modified_at, item_count): None

• Parameters

  • keyword-onlymemory_storage_client: MemoryStorageClient

  • optionalkeyword-onlyid: str | None = None

  • optionalkeyword-onlyname: str | None = None

  • optionalkeyword-onlycreated_at: datetime | None = None

  • optionalkeyword-onlyaccessed_at: datetime | None = None

  • optionalkeyword-onlymodified_at: datetime | None = None

  • optionalkeyword-onlyitem_count: int = 0

  Returns None

delete

• async delete(): None

• Returns None

get

• async get(): DatasetMetadata | None

• Returns DatasetMetadata | 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

• Parameters

  • optionalkeyword-onlyitem_format: str = 'json'

  • optionalkeyword-onlyoffset: int | None = None

  • optionalkeyword-onlylimit: int | None = None

  • optionalkeyword-onlydesc: bool = False

  • optionalkeyword-onlyclean: bool = False

  • optionalkeyword-onlybom: bool = False

  • optionalkeyword-onlydelimiter: str | None = None

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

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

  • optionalkeyword-onlyunwind: str | None = None

  • optionalkeyword-onlyskip_empty: bool = False

  • optionalkeyword-onlyskip_header_row: bool = False

  • optionalkeyword-onlyskip_hidden: bool = False

  • optionalkeyword-onlyxml_root: str | None = None

  • optionalkeyword-onlyxml_row: str | None = None

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

  Returns bytes

get_start_and_end_indexes

• get_start_and_end_indexes(offset, limit): tuple[int, int]

• Calculate the start and end indexes for listing items.

  ---

  Parameters

  • offset: int

  • optionallimit: int | None = None

  Returns tuple[int, int]

iterate_items

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

• Parameters

  • optionalkeyword-onlyoffset: int = 0

  • optionalkeyword-onlylimit: int | None = None

  • optionalkeyword-onlyclean: bool = False

  • optionalkeyword-onlydesc: bool = False

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

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

  • optionalkeyword-onlyunwind: str | None = None

  • optionalkeyword-onlyskip_empty: bool = False

  • optionalkeyword-onlyskip_hidden: bool = False

  Returns AsyncIterator[dict]

list_items

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

• Parameters

  • optionalkeyword-onlyoffset: int | None = 0

  • optionalkeyword-onlylimit: int | None = _LIST_ITEMS_LIMIT

  • optionalkeyword-onlyclean: bool = False

  • optionalkeyword-onlydesc: bool = False

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

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

  • optionalkeyword-onlyunwind: str | None = None

  • optionalkeyword-onlyskip_empty: bool = False

  • optionalkeyword-onlyskip_hidden: bool = False

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

  • optionalkeyword-onlyview: str | None = None

  Returns DatasetItemsListPage

push_items

• async push_items(items): None

• Parameters

  • items: JsonSerializable

  Returns 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): AbstractAsyncContextManager[Response | None]

• Parameters

  • optionalkeyword-onlyitem_format: str = 'json'

  • optionalkeyword-onlyoffset: int | None = None

  • optionalkeyword-onlylimit: int | None = None

  • optionalkeyword-onlydesc: bool = False

  • optionalkeyword-onlyclean: bool = False

  • optionalkeyword-onlybom: bool = False

  • optionalkeyword-onlydelimiter: str | None = None

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

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

  • optionalkeyword-onlyunwind: str | None = None

  • optionalkeyword-onlyskip_empty: bool = False

  • optionalkeyword-onlyskip_header_row: bool = False

  • optionalkeyword-onlyskip_hidden: bool = False

  • optionalkeyword-onlyxml_root: str | None = None

  • optionalkeyword-onlyxml_row: str | None = None

  Returns AbstractAsyncContextManager[Response | None]

update

• async update(*, name): DatasetMetadata

• Parameters

  • optionalkeyword-onlyname: str | None = None

  Returns DatasetMetadata

update_timestamps

• async update_timestamps(*, has_been_modified): None

• Update the timestamps of the dataset.

  ---

  Parameters

  • keyword-onlyhas_been_modified: bool

  Returns None

Properties

resource_directory

resource_directory: str

Get the resource directory for the client.

resource_info

resource_info: DatasetMetadata

Get the resource info for the dataset client.