Engine¶

class lsst.daf.relation.Engine¶

Bases: Hashable

An abstract interface for the systems that hold relation data and know how to process relation trees.

Notes

A key part of any concrete engine’s interface is not defined by the base class, because different engines can represent the content (or “payload”) of a relation in very different ways.

Engines can impose their own invariants on the structure of a relation tree, by implementing conform. They can also maintain these invariants when new operations are added to the tree by implementing append_unary and append_binary, though any derived implementations of base-class methods that accept relation arguments should always conform them.

Methods Summary

`append_binary`(operation, lhs, rhs)	Hook for maintaining the engine's `conform` invariants through `BinaryOperation.apply`.
`append_unary`(operation, target)	Hook for maintaining the engine's `conform` invariants through `UnaryOperation.apply`.
`backtrack_unary`(operation, tree, preferred)	Attempt to insert a unary operation in another engine upstream of this one by via operation commutators.
`conform`(relation)	Ensure a relation tree satisfies this engine's invariants.
`get_doomed_payload`(columns)	Return a `payload` for a leaf relation that has no rows.
`get_join_identity_payload`()	Return a `payload` for a leaf relation that is the `join identity`.
`get_relation_name`([prefix])	Return a name suitable for a new relation in this engine.
`make_doomed_relation`(columns, messages[, name])	Construct a leaf relation with no rows and one or more messages explaining why.
`make_join_identity_relation`([name])	Construct a leaf relation with no columns and exactly one row.
`materialize`(target[, name, name_prefix])	Mark that a target relation's payload should be cached.
`transfer`(target[, payload])	Mark that a relation's payload should be transferred from some other engine to this one.

Methods Documentation

append_binary(operation: BinaryOperation, lhs: Relation, rhs: Relation) → Relation¶

Hook for maintaining the engine’s conform invariants through BinaryOperation.apply.

This method should only be called by BinaryOperation.apply and the engine’s own methods and helper classes. External code should call BinaryOperation.apply or a Relation factory method instead.

Parameters:

operationBinaryOperation: Operation to apply; should already be filtered through BinaryOperation._begin_apply.
lhsRelation: One relation to apply the operation to directly.
rhsRelation: The other relation to apply the operation to directly.

Returns:

relationRelation: Relation that includes the given operation acting on lhs and rhs, or a simplified equivalent.

Notes

Implementations should delegate back to UnaryOperation._finish_apply to actually create a UnaryOperationRelation and perform final simplification and checks. This is all the default implementation does.

append_unary(operation: UnaryOperation, target: Relation) → Relation¶

Hook for maintaining the engine’s conform invariants through UnaryOperation.apply.

This method should only be called by UnaryOperation.apply and the engine’s own methods and helper classes. External code should call UnaryOperation.apply or a Relation factory method instead.

Parameters:

operationUnaryOperation: Operation to apply; should already be filtered through UnaryOperation._begin_apply.
targetRelation: Relation to apply the operation to directly.

Returns:

relationRelation: Relation that includes the given operation acting on target, or a simplified equivalent.

Notes

Implementations should delegate back to UnaryOperation._finish_apply to actually create a UnaryOperationRelation and perform final simplification and checks. This is all the default implementation does.

backtrack_unary(operation: UnaryOperation, tree: Relation, preferred: Engine) → tuple[Relation, bool, tuple[str, ...]]¶

Attempt to insert a unary operation in another engine upstream of this one by via operation commutators.

Parameters:

operationUnaryOperation: Unary operation to apply.
treeRelation: Relation tree the operation logically acts on; any upstream insertion of the given operation should be equivalent to applying it to the root of this tree. Caller guarantees that tree.engine == self.
preferredEngine: Engine in which the operation or its commuted equivalent should be performed.

Returns:

new_treeRelation: Possibly-updated relation tree.
donebool: If True, the operation has been fully inserted upstream in the preferred engine. If False, either tree was returned unmodified or only a part of the operation (e.g. a projection whose columns are superset of the given projection’s) was inserted upstream.
messagesSequence [ str ]: Messages explaining why backtracking insertion was unsuccessful or incomplete. Should be sentences with no trailing . and no capitalization; they will be joined with semicolons.

conform(relation: Relation) → Relation¶

Ensure a relation tree satisfies this engine’s invariants.

This can include reordering operations (in a way consistent with their commutators) and/or inserting MarkerRelation nodes.

Parameters:

relationRelation: Original relation tree.

Returns:

conformedRelation: Relation tree that satisfies this engine’s invariants.

Notes

The default implementation returns the given relation. Engines with a non-trivial conform implementation should always call it on any relations they are passed, as algorithms that process the relation tree are not guaranteed to maintain those invariants themselves. It is recommended to use a custom MarkerRelation to indicate trees that satisfy invariants, allowing the corresponding conform implementation to short-circuit quickly.

get_doomed_payload(columns: Set[ColumnTag]) → Any¶

Return a payload for a leaf relation that has no rows.

Parameters:

columnsSet [ ColumnTag ]: The columns the relation should have.

Returns:

payload: The engine-specific content for this relation.

get_join_identity_payload() → Any¶

Return a payload for a leaf relation that is the join identity.

Returns:

payload: The engine-specific content for this relation.

abstract get_relation_name(prefix: str = 'leaf') → str¶

Return a name suitable for a new relation in this engine.

Parameters:

prefixstr, optional: Prefix to include in the returned name.

Returns:

namestr: Name for the relation; guaranteed to be unique over all of the relations in this engine.

make_doomed_relation(columns: Set[ColumnTag], messages: Sequence[str], name: str = '0') → Relation¶

Construct a leaf relation with no rows and one or more messages explaining why.

Parameters:

columnsSet [ ColumnTag ]: The columns in this relation.
messagesSequence [ str ]: One or more messages explaining why the relation has no rows.
namestr, optional: Name used to identify and reconstruct this relation.

Returns:

relationRelation: Doomed relation.

Notes

This is simplify a convenience method that delegates to LeafRelation.make_doomed. Derived engines with a nontrivial conform should override this method to conform the return value.

make_join_identity_relation(name: str = 'I') → Relation¶

Construct a leaf relation with no columns and exactly one row.

Parameters:

engineEngine: The engine that is responsible for interpreting this relation.
namestr, optional: Name used to identify and reconstruct this relation.

Returns:

relationRelation: Relation with no columns and one row.

materialize(target: Relation, name: str | None = None, name_prefix: str = 'materialization_') → Relation¶

Mark that a target relation’s payload should be cached.

Parameters:

targetRelation: Relation to mark.
namestr, optional: Name to use for the cached payload within the engine.
name_prefixstr, optional: Prefix to pass to get_relation_name; ignored if name is provided.

Returns:

relationRelation: New relation that marks its upstream tree for caching, unless the materialization was simplified away.

Navigation

Engine¶