🔍 Code Extractor

Retrieves a single LIMS_ImportErrors node from a Neo4j graph database by its unique ID.

Purpose

This function queries a Neo4j database to fetch a specific LIMS_ImportErrors node using its ID property. It's designed for retrieving error records from a Laboratory Information Management System (LIMS) import process. The function returns the first matching node or None if no node is found with the given ID.

Source Code

def get_lims_importerrors_by_id(id):
    """Get a LIMS_ImportErrors node by its ID"""
    query = """
    MATCH (n:LIMS_ImportErrors {id: $id})
    RETURN n
    """
    result = run_query(query, {"id": id})
    return result[0] if result else None

Parameters

Parameter Details

id: The unique identifier of the LIMS_ImportErrors node to retrieve. Expected to be a string or integer value that matches the 'id' property of a node in the Neo4j database. This parameter is used in a parameterized Cypher query to prevent injection attacks.

Return Value

Returns a dictionary-like object representing the LIMS_ImportErrors node if found, containing all properties of the node. Returns None if no node with the specified ID exists. The exact structure depends on the properties stored in the LIMS_ImportErrors node in the database.

Dependencies

• neo4j

Required Imports

from neo4j import GraphDatabase

Usage Example

from neo4j import GraphDatabase

# Assuming run_query is defined elsewhere
def run_query(query, params):
    driver = GraphDatabase.driver('bolt://localhost:7687', auth=('neo4j', 'password'))
    with driver.session() as session:
        result = session.run(query, params)
        return [record['n'] for record in result]
    driver.close()

# Use the function
error_node = get_lims_importerrors_by_id('error_123')
if error_node:
    print(f'Found error: {error_node}')
else:
    print('No error found with that ID')

Best Practices

• Ensure the run_query function is properly defined and handles database connections securely
• Validate the id parameter before passing it to the function to ensure it matches expected format
• Handle the None return value appropriately in calling code to avoid NoneType errors
• Consider adding error handling for database connection failures
• Use parameterized queries (as done here with $id) to prevent Cypher injection attacks
• Close database connections properly in the run_query implementation
• Consider adding logging for debugging database queries
• Ensure proper indexing on the 'id' property in Neo4j for optimal query performance

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function get_lims_importerrors_by_uid 89.0% similar

  Retrieves a LIMS_ImportErrors node from a Neo4j graph database by its unique identifier (UID).

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

• function get_all_lims_importerrors 87.1% similar

  Queries a Neo4j graph database to retrieve all nodes labeled as LIMS_ImportErrors, with a configurable limit on the number of results returned.

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

• function create_lims_importerrors 82.7% similar

  Creates a new LIMS_ImportErrors node in a Neo4j graph database with the specified properties and returns the created node.

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

• function get_lims_requests_by_id 82.2% similar

  Retrieves a single LIMS_Requests node from a Neo4j graph database by matching its unique ID property.

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

• function get_lims_parameters_by_id 80.3% similar

  Retrieves a LIMS_Parameters node from a Neo4j graph database by its unique identifier.

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