Struct QueryJoinConfig 

pub struct QueryJoinConfig {
    pub id: String,
    pub keys: Vec<QueryJoinKeyConfig>,
}

Synthetic join configuration for queries

QueryJoinConfig defines a virtual relationship between node types from different sources. This allows queries to join data without requiring physical relationships in the source systems.

Join Semantics

Joins create synthetic edges by matching property values across nodes. The id field specifies the relationship type used in the query’s MATCH pattern, and keys define which properties to match.

Examples

Simple Join on Single Property

joins:
  - id: CUSTOMER              # Use in query: MATCH (o:Order)-[:CUSTOMER]->(c:Customer)
    keys:
      - label: Order
        property: customer_id  # Order.customer_id
      - label: Customer
        property: id           # Customer.id
      # Creates edge when Order.customer_id == Customer.id

Multi-Source Join

joins:
  - id: ASSIGNED_TO
    keys:
      - label: Task
        property: assignee_id
      - label: User
        property: user_id

Fields

id: String

Unique identifier for the join (should match relationship type in query)

keys: Vec<QueryJoinKeyConfig>

Keys defining the join relationship

Trait Implementations

impl Clone for QueryJoinConfig

fn clone(&self) -> QueryJoinConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryJoinConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryJoinConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<QueryJoinConfig> for QueryJoin

fn from(config: QueryJoinConfig) -> Self

Converts to this type from the input type.

impl Serialize for QueryJoinConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.