flow.record

Subpackages

• flow.record.adapter
  • flow.record.adapter.archive
  • flow.record.adapter.avro
  • flow.record.adapter.broker
  • flow.record.adapter.csvfile
  • flow.record.adapter.duckdb
  • flow.record.adapter.elastic
  • flow.record.adapter.jsonfile
  • flow.record.adapter.line
  • flow.record.adapter.mongo
  • flow.record.adapter.split
  • flow.record.adapter.splunk
  • flow.record.adapter.sqlite
  • flow.record.adapter.stream
  • flow.record.adapter.text
  • flow.record.adapter.xlsx
• flow.record.fieldtypes
  • flow.record.fieldtypes.net
    • flow.record.fieldtypes.net.ip
    • flow.record.fieldtypes.net.ipv4
    • flow.record.fieldtypes.net.tcp
    • flow.record.fieldtypes.net.udp
  • flow.record.fieldtypes.credential
• flow.record.tools
  • flow.record.tools.geoip
  • flow.record.tools.rdump

Submodules

• flow.record.base
• flow.record.context
• flow.record.exceptions
• flow.record.jsonpacker
• flow.record.packer
• flow.record.selector
• flow.record.stream
• flow.record.utils
• flow.record.whitelist

Re-Exports

IGNORE_FIELDS_FOR_COMPARISON
RECORD_VERSION
RECORDSTREAM_MAGIC
DynamicDescriptor(→ RecordDescriptor)
FieldType
GroupedRecord	GroupedRecord acts like a normal Record, but can contain multiple records.
Record
RecordAdapter(...)
RecordDescriptor	Record Descriptor class for defining a Record type and its fields.
RecordDescriptorError	Raised when there is an error constructing a record descriptor
RecordField
RecordReader(→ flow.record.adapter.AbstractReader)
RecordWriter(→ flow.record.adapter.AbstractWriter)
dynamic_fieldtype
extend_record(→ Record)	Extend record with fields and values from other_records.
ignore_fields_for_comparison(...)	Context manager to temporarily ignore fields for comparison.
iter_timestamped_records(...)	Yields timestamped annotated records for each datetime fieldtype in record.
open_path(→ IO)	Open path using mode and returns a file object.
open_path_or_stream(→ IO)
open_stream(→ BinaryIO)
set_ignored_fields_for_comparison(→ None)	Can be used to update the IGNORE_FIELDS_FOR_COMPARISON from outside the flow.record package scope
stream(→ None)
JsonRecordPacker