🔍 Code Extractor

function get_lims_parameters_by_id

Maturity: 41

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

File:
/tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py
Lines:
70 - 77
Complexity:
simple

Purpose

This function queries a Neo4j database to fetch a specific LIMS_Parameters node using its ID. It's designed for Laboratory Information Management System (LIMS) data retrieval, allowing users to access parameter configurations or settings stored in the graph database. The function returns the first matching node or None if no match is found.

Source Code

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

Parameters

Name Type Default Kind
id - - positional_or_keyword

Parameter Details

id: The unique identifier of the LIMS_Parameters node to retrieve. Expected to be a string or integer that matches the 'id' property of a LIMS_Parameters node in the Neo4j database. This parameter is used in the Cypher query to filter and locate the specific node.

Return Value

Returns a dictionary-like object representing the LIMS_Parameters 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_Parameters node in the database. The function returns the first element of the result list (result[0]) when a match is found.

Dependencies

  • neo4j

Required Imports

from neo4j import GraphDatabase

Usage Example

# Assuming run_query function is defined and Neo4j connection is configured
from neo4j import GraphDatabase

# Define run_query helper function (example implementation)
def run_query(query, parameters=None):
    driver = GraphDatabase.driver('bolt://localhost:7687', auth=('neo4j', 'password'))
    with driver.session() as session:
        result = session.run(query, parameters)
        return [record['n'] for record in result]
    driver.close()

# Use the function to retrieve a LIMS_Parameters node
lims_params = get_lims_parameters_by_id('PARAM_001')

if lims_params:
    print(f'Found LIMS Parameters: {lims_params}')
else:
    print('No LIMS Parameters found with that ID')

Best Practices

  • Ensure the run_query function is properly implemented with error handling and connection management
  • Validate the 'id' parameter before passing it to prevent injection attacks or invalid queries
  • Consider adding error handling for database connection failures or query execution errors
  • Close Neo4j driver connections properly to avoid resource leaks
  • Use connection pooling for better performance in production environments
  • Consider adding logging to track query execution and failures
  • Validate that the returned node has the expected structure before using its properties
  • Consider adding a timeout parameter for long-running queries

Tags

neo4j graph-database lims database-query cypher data-retrieval laboratory-information-management node-lookup id-based-query

Similar Components

AI-powered semantic similarity - components with related functionality:

  • function get_lims_testparameters_by_id 92.4% similar

    Retrieves a single LIMS_Testparameters 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_uid 89.7% similar

    Retrieves a LIMS_Parameters node from a Neo4j graph database by searching for a specific UID (unique identifier).

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

  • function get_lims_pathogens_by_id 85.2% similar

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

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

  • function get_all_lims_parameters 85.2% similar

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

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

  • function get_lims_requests_by_id 85.1% 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
← Back to Browse