function create_references_establishment_relationship
Creates a REFERENCES_ESTABLISHMENT relationship in a Neo4j graph database between a LIMS_Requests node and a dbo_Establishment node, with optional properties on the relationship.
/tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py
1234 - 1254
moderate
Purpose
This function establishes a directed relationship in Neo4j from a LIMS_Requests node to a dbo_Establishment node. It's designed for linking laboratory information management system (LIMS) requests to establishment records in a graph database. The function supports adding custom properties to the relationship and uses parameterized queries to prevent injection attacks.
Source Code
def create_references_establishment_relationship(source_id, target_id, properties=None):
"""Create a REFERENCES_ESTABLISHMENT relationship from LIMS_Requests 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:LIMS_Requests {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
| Name | Type | Default | Kind |
|---|---|---|---|
source_id |
- | - | positional_or_keyword |
target_id |
- | - | positional_or_keyword |
properties |
- | None | positional_or_keyword |
Parameter Details
source_id: The unique identifier of the source LIMS_Requests node. This should match the 'id' property of an existing LIMS_Requests node in the Neo4j database. Expected type: string or integer depending on your node ID schema.
target_id: The unique identifier of the target dbo_Establishment node. This should match the 'id' property of an existing dbo_Establishment node in the Neo4j database. Expected type: string or integer depending on your node ID schema.
properties: Optional dictionary of 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.). Default is None, meaning no additional properties are set.
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 fails or no relationship is created (e.g., if source or target nodes don't exist). The return type is typically a Neo4j Record object or None.
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="REQ-12345",
target_id="EST-67890"
)
# Example 2: Create relationship with properties
result = create_references_establishment_relationship(
source_id="REQ-12345",
target_id="EST-67890",
properties={
"created_date": "2024-01-15",
"reference_type": "primary",
"confidence_score": 0.95
}
)
if result:
print(f"Relationship created successfully: {result}")
else:
print("Failed to create relationship")
Best Practices
- Ensure both source and target nodes exist in the database before calling this function to avoid returning None
- Validate source_id and target_id before passing them to prevent query failures
- Use meaningful property names in the properties dictionary that follow your database schema conventions
- Handle the None return value appropriately in your code to detect failed relationship creation
- Consider wrapping this function call in try-except blocks to handle potential Neo4j connection errors
- Be aware that this function uses string interpolation for the SET clause, but parameters are properly used for values to prevent injection
- Ensure the run_query function properly manages database sessions and transactions
- Consider adding duplicate relationship checks if your use case requires unique relationships between nodes
Tags
Similar Components
AI-powered semantic similarity - components with related functionality:
-
function create_references_establishment_relationship_v1 95.6% similar
-
function create_references_establishment_relationship_v4 87.0% similar
-
function get_lims_requests_with_references_establishment_dbo_establishment 85.3% similar
-
function create_references_requests_relationship 84.7% similar
-
function create_references_establishment_relationship_v2 84.3% similar