🔍 Code Extractor

Creates a REFERENCES_ESTABLISHMENT relationship in a Neo4j graph database between a dbo_Houses node and a dbo_Establishment node, with optional properties on the relationship.

Purpose

This function establishes a directed relationship in Neo4j from a Houses entity to an Establishment entity. It's used to model references or connections between residential properties and establishments (likely businesses or institutions). The function supports adding custom properties to the relationship edge, making it flexible for storing metadata about the reference connection. It relies on an external run_query function to execute the Cypher query against the Neo4j database.

Source Code

def create_references_establishment_relationship(source_id, target_id, properties=None):
    """Create a REFERENCES_ESTABLISHMENT relationship from dbo_Houses to dbo_Establishment"""
    props = ""
    if properties:
        props_list = ', '.join([f"r.{prop} = ${prop}" for prop in properties.keys()])
        props = f"SET {props_list}"
    
    query = f"""
    MATCH (source:dbo_Houses {id: $source_id})
    MATCH (target:dbo_Establishment {id: $target_id})
    CREATE (source)-[r:REFERENCES_ESTABLISHMENT]->(target)
    {props}
    RETURN r
    """
    
    params = {"source_id": source_id, "target_id": target_id}
    if properties:
        params.update(properties)
    
    result = run_query(query, params)
    return result[0] if result else None

Parameters

Parameter Details

source_id: The unique identifier of the source node (dbo_Houses). This value is used to match the Houses node in the Neo4j database. Expected to be a string or integer that corresponds to the 'id' property of a dbo_Houses node.

target_id: The unique identifier of the target node (dbo_Establishment). This value is used to match the Establishment node in the Neo4j database. Expected to be a string or integer that corresponds to the 'id' property of a dbo_Establishment node.

properties: Optional dictionary containing key-value pairs to set as properties on the created relationship. Keys should be valid property names (strings), and values can be any Neo4j-compatible data type (strings, numbers, booleans, etc.). If None or not provided, no additional properties are set on the relationship.

Return Value

Returns the created relationship object (r) from Neo4j if successful, containing the relationship details and any properties set. Returns None if the query execution fails or returns no results. The relationship object typically includes metadata like relationship type, properties, and node references.

Dependencies

• neo4j

Required Imports

from neo4j import GraphDatabase

Usage Example

# Assuming run_query function is defined and Neo4j is configured
# Example 1: Create relationship without properties
result = create_references_establishment_relationship(
    source_id="house_123",
    target_id="establishment_456"
)

# Example 2: Create relationship with properties
result = create_references_establishment_relationship(
    source_id="house_123",
    target_id="establishment_456",
    properties={
        "reference_type": "nearby",
        "distance_meters": 500,
        "created_date": "2024-01-15"
    }
)

if result:
    print(f"Relationship created successfully: {result}")
else:
    print("Failed to create relationship")

Best Practices

• Ensure both source_id and target_id exist in the database before calling this function to avoid failed matches
• Validate the properties dictionary keys to ensure they follow Neo4j property naming conventions (no spaces, special characters)
• Handle the None return value to detect when relationship creation fails
• Consider wrapping this function in a try-except block to handle Neo4j connection errors or query execution failures
• Be aware of potential Cypher injection if source_id or target_id come from untrusted sources (though parameterized queries provide some protection)
• The function assumes the run_query function is properly implemented and handles database connections, transactions, and error handling
• Consider adding validation to check if a relationship already exists before creating a duplicate
• Property values should be Neo4j-compatible types; complex objects may need serialization

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function create_references_establishment_relationship_v4 92.0% similar

  Creates a REFERENCES_ESTABLISHMENT relationship in a Neo4j graph database between a dbo_EstablishmentCycles node and a dbo_Establishment node, with optional properties on the relationship.

  From: /tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py

• function create_references_establishment_relationship_v3 88.7% similar

  Creates a REFERENCES_ESTABLISHMENT relationship in a Neo4j graph database between a dbo_TNV node and a dbo_Establishment node, with optional properties on the relationship.

  From: /tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py

• function create_references_houses_relationship_v1 86.5% similar

  Creates a REFERENCES_HOUSES relationship in a Neo4j graph database between a dbo_ConceptHouses node and a dbo_Houses node, with optional properties on the relationship.

  From: /tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py

• function create_references_establishment_relationship_v6 86.5% similar

  Creates a REFERENCES_ESTABLISHMENT relationship in a Neo4j graph database between a dbo_Treatments node (source) and a dbo_Establishment node (target), with optional properties on the relationship.

  From: /tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py

• function create_references_establishment_relationship_v5 86.0% similar

  Creates a REFERENCES_ESTABLISHMENT relationship in a Neo4j graph database between a dbo_Flocks node (source) and a dbo_Establishment node (target), with optional properties on the relationship.

  From: /tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py