neat.pipe package

Module contents

Submodules

neat.pipe.mongodb module

class neat.pipe.mongodb.MongoDBPipe(ip: str, port: int, table: str, entry_delay: int = 600)[source]

Bases: neat.pipe._common.AbstractPipe

A record pipe for MongoDB.

Note

Records are always placed in the neat table.

accept(record: neat.models.record.Record) → None[source]

Accepts a record to be placed into the MongoDB instance.

Parameters:record (Record) – The record to be placed in the MongoDB instance
Returns:Does not return
Return type:None
client

The client attached to the MongoDB uri.

Warning

MongoDB driver connections are not fork safe

db

The database of the client to write to.

table

The table of the database to write to.

validate() → bool[source]

Self validates the MongoDB pipe.

Returns:True if the pipe is valid, otherwise False
Return type:bool

neat.pipe.rethinkdb module

class neat.pipe.rethinkdb.RethinkDBPipe(ip: str, port: int, table: str, clean_delay: int = 300)[source]

Bases: neat.pipe._common.AbstractPipe

A record pipe for RethinkDB.

Note

Records are always placed in the neat table.

accept(record: neat.models.record.Record) → None[source]

Accepts a record to be placed into the RethinkDB instance.

Parameters:record (Record) – The record to be placed into the RethinkDB instance
Returns:Does not return
Return type:None
clean() → None[source]

Cleans dead records from the RethinkDB instance.

Returns:Does not return
Return type:None
connection

The client attached to the RethinkDB uri.

Warning

RethinkDB driver connections are not thread safe

validate() → bool[source]

Self validates the RethinkDB pipe.

Returns:True if the pipe is valid, otherwise False
Return type:bool