arcticdb.version_store.library.WritePayload

class arcticdb.version_store.library.WritePayload(symbol: str, data: Any | DataFrame | Series | ndarray, metadata: Any | None = None)[source]

WritePayload is designed to enable batching of multiple operations with an API that mirrors the singular write API.

Construction of WritePayload objects is only required for batch write operations.

One instance of WritePayload refers to one unit that can be written through to ArcticDB.

__init__(symbol: str, data: Any | DataFrame | Series | ndarray, metadata: Any | None = None)[source]

Constructor.

Parameters:

  • symbol (str) – Symbol name. Limited to 255 characters. The following characters are not supported in symbols: "*", "&", "<", ">"

  • data (Any) – Data to be written. If data is not of NormalizableType then it will be pickled.

  • metadata (Any, default=None) – Optional metadata to persist along with the symbol.

See also

Library.write_pickle

For information on the implications of providing data that needs to be pickled.

Methods

__init__(symbol, data[, metadata])

Constructor.