Orion Platform Ports

Record Ports

class orionplatform.ports.RecordInputPort(name=None, title=None, required=False, initializer=False, cube=None)

Input port for receiving Records

class orionplatform.ports.RecordOutputPort(name=None, title=None, required=False, initializer=False, cube=None)

Output port for emitting Records

class orionplatform.ports.RecordBytesInputPort(name=None, title=None, required=False, initializer=False, cube=None)

Input port that receives an OERecord or OEMolRecord as bytes and passes the bytes directly to the cube.

This should only be used when there is no need to interpret the records in the bytes. Most commonly it can be used to optimized the performance of writing bytes.

class orionplatform.ports.RecordBytesOutputPort(name=None, title=None, required=False, initializer=False, cube=None)

Output port that receives sends bytes that represent an OERecord or OEMolRecord.

This should only be used when generating records, but don’t need to deserialize them. Most commonly used to optimize performance when emitting records.

Collection Ports

class orionplatform.ports.CollectionInputPort(name=None, title=None, required=False, initializer=False, cube=None)

Input port for Collections. Can be connected to a CollectionOutputPort.

class orionplatform.ports.CollectionInputPortV2(name=None, title=None, required=False, initializer=False, cube=None)

Input port for Collections. Can be connected to a CollectionOutputPort or CollectionOutputPortV2.

Improved performance compared to CollectionInputPort when connected to CollectionOutputPortV2.

class orionplatform.ports.CollectionOutputPort(name=None, title=None, required=False, initializer=False, cube=None)

Output port for Collections. Can be connected to a CollectionInputPort.

class orionplatform.ports.CollectionOutputPortV2(name=None, title=None, required=False, initializer=False, cube=None)

Output port for Collections. Can be connected to a CollectionInputPortV2.

Improved performance compared to CollectionOutputPort.

Shard Ports

class orionplatform.ports.ShardInputPort(name=None, title=None, required=False, initializer=False, cube=None)

Input Shard Port for passing around references to Shards

class orionplatform.ports.ShardOutputPort(name=None, title=None, required=False, initializer=False, cube=None)

Output Shard Port for passing around references to Shards