`flow.record.adapter.mongo`¶

Module Contents¶

Classes¶

`MongoWriter`
`MongoReader`

Functions¶

Attributes¶

flow.record.adapter.mongo.__usage__ = Multiline-String¶

Show Value

"""
MongoDB adapter
---
Write usage: rdump -w mongo://[IP]:[PORT]/[DBNAME]/[COLLECTION]
Read usage: rdump mongo://[IP]:[PORT]/[DBNAME]/[COLLECTION]
[IP]:[PORT]: ip and port to a mongodb instance
[DBNAME]: database name to write to or read from
[COLLECTION]: collection to write to or read from
"""

flow.record.adapter.mongo.parse_path(path: str) → tuple[str, str, str]¶

class flow.record.adapter.mongo.MongoWriter(path: str, key: str | None = None, **kwargs)¶

Bases: flow.record.adapter.AbstractWriter

client = None¶

key = None¶

db¶

collection¶

coll_descriptors¶

descriptors¶

write(r: flow.record.base.Record) → None¶: Write a record.

flush() → None¶: Flush any buffered writes.

close() → None¶: Close the Writer, no more writes will be possible.

class flow.record.adapter.mongo.MongoReader(path: str, selector: str | None = None, **kwargs)¶

Bases: flow.record.adapter.AbstractReader

client = None¶

selector = None¶

db¶

collection¶

coll_descriptors¶

descriptors¶

close() → None¶: Close the Reader, can be overriden to properly free resources.

__iter__() → collections.abc.Iterator[flow.record.base.Record]¶: Return a record iterator.