JoinNodeConfiguration

Namespace: Meshmakers.Octo.Sdk.Common.EtlDataPipeline.Nodes.Transforms

Configuration for a join node that attaches to each object selected by path the array of join records whose key matches the object's key (a nested left join: an object without a match keeps an empty array). Elements at path that are not objects are skipped.

public record JoinNodeConfiguration : PathNodeConfiguration, INodeConfiguration, IEquatable<NodeConfiguration>, IPathNodeConfiguration, IEquatable<PathNodeConfiguration>, IEquatable<JoinNodeConfiguration>

Inheritance Object → NodeConfiguration → PathNodeConfiguration → JoinNodeConfiguration
Implements INodeConfiguration, IEquatable<NodeConfiguration>, IPathNodeConfiguration, IEquatable<PathNodeConfiguration>, IEquatable<JoinNodeConfiguration>

Properties

KeyPath

Gets or sets the JSONPath to the key field in the source data that will be used for matching.

public string KeyPath { get; set; }

Property Value

String

JoinPath

Gets or sets the JSONPath to the array of items that will be used as the lookup/join source.

public string JoinPath { get; set; }

Property Value

String

JoinKeyPath

Gets or sets the JSONPath to the key field in the join array items that will be matched against the source key.

public string JoinKeyPath { get; set; }

Property Value

String

ItemPath

Gets or sets the JSONPath where the array of matched join records will be stored in the source data.

public string ItemPath { get; set; }

Property Value

String

AllowMissingKey

Gets or sets whether a source object without a usable key (key path missing, null or empty) is kept as a left-join row with an empty array at itemPath. Off (default), such a source object fails the run; only with an empty join array and noMatchHandling Ignore is the key not read and every source object receives an empty array. Source objects with a key are joined as before either way.

public bool AllowMissingKey { get; set; }

Property Value

Boolean

NoMatchHandling

Gets or sets how a source object whose key has no match in the join array is handled (Ignore, the default, or Fail). A source object without a key is governed by allowMissingKey, not by this option. Under Fail an empty join array fails the run at the first source object, whatever its key.

public JoinNoMatchHandlingDto NoMatchHandling { get; set; }

Property Value

JoinNoMatchHandlingDto

Path

Gets or sets the source path in json path format

public string Path { get; set; }

Property Value

String

Description

Gets or sets an optional description

public string Description { get; set; }

Property Value

String

Constructors