Skip to main content
Version: 11 - TBD

RecordMetadata

class flow_api.record_metadata.RecordMetadata(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, commit=False, data=<class 'flow_api.system.NotSet'>, key=<class 'flow_api.system.NotSet'>, record_id=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Row

Use-case specific metadata attached to a record.

Parameters

NameTypeDescription
allow_deletedbool
allow_normalbool
bystr
clstyping.Union[ type, NoneType ]
commitbool
datatyping.Union[ flow_api.system.NotSet, typing.Any, NoneType ]Use-case specific metadata attached to a record.
debugboolif set, the content of the data being written will be logged.
inittyping.Union[ dict, NoneType ]
keytyping.Union[ flow_api.system.NotSet, str ]A key to identify the use-case specific metadata attached to a record.
record_idtyping.Union[ flow_api.system.NotSet, str ]Reference to the record.
selecttyping.Union[ str, NoneType ]

Constants

RESOURCE = record_metadata

Methods

clone

delete

exists

export

get

get_dict

record

restore

save