🔍 Code Extractor

Creates a REFERENCES_SAMPLETYPES relationship in a Neo4j graph database between a LIMS_Samples node and a LIMS_SampleTypes node, with optional properties on the relationship.

Purpose

This function establishes a directed relationship in a Neo4j graph database from a source LIMS_Samples node to a target LIMS_SampleTypes node. It's designed for Laboratory Information Management Systems (LIMS) to link sample records to their corresponding sample type definitions. The function supports adding custom properties to the relationship and uses parameterized queries to prevent injection attacks.

Source Code

def create_references_sampletypes_relationship(source_id, target_id, properties=None):
    """Create a REFERENCES_SAMPLETYPES relationship from LIMS_Samples to LIMS_SampleTypes"""
    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_Samples {id: $source_id})
    MATCH (target:LIMS_SampleTypes {id: $target_id})
    CREATE (source)-[r:REFERENCES_SAMPLETYPES]->(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 LIMS_Samples node. This should match the 'id' property of an existing LIMS_Samples node in the Neo4j database. Expected type: string or integer depending on your database schema.

target_id: The unique identifier of the target LIMS_SampleTypes node. This should match the 'id' property of an existing LIMS_SampleTypes node in the Neo4j database. Expected type: string or integer depending on your database 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 will be 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 fails or no relationship is created (e.g., if source or target nodes don't exist). The return type is typically a Neo4j relationship record or None.

Dependencies

• neo4j

Required Imports

from neo4j import GraphDatabase

Usage Example

# Assuming run_query function is defined and Neo4j is connected
# Example 1: Create relationship without properties
result = create_references_sampletypes_relationship(
    source_id='SAMPLE_001',
    target_id='TYPE_BLOOD'
)

# Example 2: Create relationship with properties
properties = {
    'created_date': '2024-01-15',
    'created_by': 'lab_tech_123',
    'confidence': 0.95
}
result = create_references_sampletypes_relationship(
    source_id='SAMPLE_002',
    target_id='TYPE_TISSUE',
    properties=properties
)

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

Best Practices

• Always verify that both source_id and target_id exist in the database before calling this function to avoid silent failures
• Use parameterized queries (as implemented) to prevent Cypher injection attacks
• Validate the properties dictionary keys to ensure they are valid Neo4j property names (no special characters that could break the query)
• Consider wrapping this function call in a try-except block to handle potential Neo4j connection errors
• Ensure the run_query function properly handles database transactions and connection management
• Check the return value for None to determine if the relationship was successfully created
• Consider adding uniqueness constraints or checking for existing relationships before creating duplicates
• Be aware that the Cypher query uses string formatting for the SET clause, which requires careful validation of property names

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function create_references_sampletypes_relationship 96.1% similar

  Creates a directed REFERENCES_SAMPLETYPES relationship in a Neo4j graph database from a LIMS_SampleTypeTests node to a LIMS_SampleTypes node, with optional properties on the relationship.

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

• function create_references_samples_relationship_v1 93.8% similar

  Creates a REFERENCES_SAMPLES relationship in a Neo4j graph database between a LIMS_SampleTestResultDetails node and a LIMS_Samples node, with optional properties on the relationship.

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

• function create_references_samples_relationship 93.6% similar

  Creates a REFERENCES_SAMPLES relationship in a Neo4j graph database between a LIMS_SampleTestResults node and a LIMS_Samples node, with optional properties on the relationship.

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

• function create_references_tests_relationship 89.6% similar

  Creates a REFERENCES_TESTS relationship in a Neo4j graph database between a LIMS_SampleTypeTests node and a LIMS_Tests node, with optional properties on the relationship.

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

• function create_references_requests_relationship 87.2% similar

  Creates a REFERENCES_REQUESTS relationship in a Neo4j graph database between a LIMS_Samples node and a LIMS_Requests node, with optional properties on the relationship.

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