databay.record

class databay.record.Record(payload, metadata: dict = None)[source]

databay.record.Record

Data structure representing the data passed between inlets and outlets.

Warning

You should prefer Inlet.new_record() function over instantiating this class directly.

Parameters

  • payload (Any) – Data contained by this record.

  • metadata (dict) – Metadata attached to this record

    Default:
    None (Set to empty dict if not provided)

payload(self) → dict[source]

property

Returns

Data stored in this record.

Return type

Any

metadata(self) → dict[source]

property

Returns

Metadata attached to this record.

Return type

dict