Module com.darkcollective.relix.plan

Package com.darkcollective.relix.plan

Record Class PhysicalNode.Scan

java.lang.Object

java.lang.Record

com.darkcollective.relix.plan.PhysicalNode.Scan

Record Components:

schema - the relation's heading

source - the relation read

produceBound - a generator production bound, if one was pushed

qualifier - the name the query referenced the relation by, when known

All Implemented Interfaces:

PhysicalNode

Enclosing interface:

PhysicalNode

public static record PhysicalNode.Scan(Schema schema, RelationSymbol source, Optional<ProduceBound> produceBound, Optional<String> qualifier)
extends Record
implements PhysicalNode

Reads a base relation: inline rows, or an external source/database via the connector.

qualifier is the name the query referenced the relation by, which is the qualifier its columns answer to. A declared heading carries it as column provenance; a schema-on-read row has no heading to carry it, so the executor anchors each document to it.

Nested Class Summary

Nested classes/interfaces inherited from interface com.darkcollective.relix.plan.PhysicalNode

PhysicalNode.Aggregate, PhysicalNode.AsOfJoin, PhysicalNode.BernoulliSample, PhysicalNode.BuildSide, PhysicalNode.Closure, PhysicalNode.Cluster, PhysicalNode.ConstructiveCover, PhysicalNode.Cover, PhysicalNode.Distinct, PhysicalNode.Division, PhysicalNode.Downsample, PhysicalNode.Empty, PhysicalNode.Fixpoint, PhysicalNode.IntervalJoin, PhysicalNode.Iterate, PhysicalNode.Join, PhysicalNode.JoinAlgorithm, PhysicalNode.JoinKeys, PhysicalNode.JoinKind, PhysicalNode.LateralJoin, PhysicalNode.Limit, PhysicalNode.Optimize, PhysicalNode.Path, PhysicalNode.Pivot, PhysicalNode.Project, PhysicalNode.PushedScan, PhysicalNode.RecursiveRef, PhysicalNode.Rename, PhysicalNode.ReservoirSample, PhysicalNode.Scan, PhysicalNode.Select, PhysicalNode.Sessionize, PhysicalNode.SetKind, PhysicalNode.SetOp, PhysicalNode.Solve, PhysicalNode.Sort, PhysicalNode.Spool, PhysicalNode.TopK, PhysicalNode.Trace, PhysicalNode.Tree, PhysicalNode.Universal, PhysicalNode.Unnest, PhysicalNode.Unpivot, PhysicalNode.Why, PhysicalNode.Window

Constructor Summary

Constructors

Constructor	Description
Scan(Schema schema, RelationSymbol source)	Scan without a generator production bound.
Scan(Schema schema, RelationSymbol source, Optional<ProduceBound> produceBound)	Scan under no particular qualifier.
Scan(Schema schema, RelationSymbol source, Optional<ProduceBound> produceBound, Optional<String> qualifier)	Creates an instance of a Scan record class.

Method Summary

Modifier and Type	Method	Description
List<PhysicalNode>	children()	Direct child plans, left-to-right; empty for a PhysicalNode.Scan.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Optional<ProduceBound>	produceBound()	Returns the value of the produceBound record component.
Optional<String>	qualifier()	Returns the value of the qualifier record component.
Schema	schema()	Returns the value of the schema record component.
RelationSymbol	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.darkcollective.relix.plan.PhysicalNode

deliveredOrdering, mapChildren

Constructor Details

Scan

public Scan(Schema schema,
 RelationSymbol source)

Scan without a generator production bound.

Scan

public Scan(Schema schema,
 RelationSymbol source,
 Optional<ProduceBound> produceBound)

Scan under no particular qualifier.

Scan

public Scan(Schema schema,
 RelationSymbol source,
 Optional<ProduceBound> produceBound,
 Optional<String> qualifier)

Creates an instance of a Scan record class.

Parameters:

schema - the value for the schema record component

source - the value for the source record component

produceBound - the value for the produceBound record component

qualifier - the value for the qualifier record component

Method Details

children

public List<PhysicalNode> children()

Description copied from interface: PhysicalNode

Direct child plans, left-to-right; empty for a PhysicalNode.Scan.

Specified by:

children in interface PhysicalNode

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

schema

public Schema schema()

Returns the value of the schema record component.

Specified by:

schema in interface PhysicalNode

Returns:

the value of the schema record component

source

public RelationSymbol source()

Returns the value of the source record component.

Returns:

the value of the source record component

produceBound

public Optional<ProduceBound> produceBound()

Returns the value of the produceBound record component.

Returns:

the value of the produceBound record component

qualifier

public Optional<String> qualifier()

Returns the value of the qualifier record component.

Returns:

the value of the qualifier record component