🔍 Code Extractor

Retrieves a single dbo_FlockTypes node from a Neo4j graph database by matching its unique identifier (UID).

Purpose

This function queries a Neo4j database to fetch a specific dbo_FlockTypes node using its UID property. It's designed for retrieving individual flock type records from the database, returning the first matching node or None if no match is found. This is useful in applications that need to look up specific flock type configurations or metadata by their unique identifier.

Source Code

def get_dbo_flocktypes_by_uid(uid):
    """Get a dbo_FlockTypes node by its UID"""
    query = """
    MATCH (n:dbo_FlockTypes {UID: $uid})
    RETURN n
    """
    result = run_query(query, {"uid": uid})
    return result[0] if result else None

Parameters

Parameter Details

uid: The unique identifier (UID) of the dbo_FlockTypes node to retrieve. Expected to be a string or integer value that matches the UID property of a node in the Neo4j database. This should be a valid, existing UID for successful retrieval.

Return Value

Returns the first dbo_FlockTypes node that matches the provided UID, or None if no matching node is found. The return value is typically a dictionary-like object representing the node's properties when a match exists. The function accesses the first element of the query result array (result[0]) if results exist, otherwise returns None.

Dependencies

• neo4j

Required Imports

from neo4j import GraphDatabase

Usage Example

# Assuming run_query function is defined and Neo4j is configured
# Example 1: Retrieve a flock type by UID
flock_type = get_dbo_flocktypes_by_uid("FT-12345")
if flock_type:
    print(f"Found flock type: {flock_type}")
else:
    print("Flock type not found")

# Example 2: Using with integer UID
flock_type = get_dbo_flocktypes_by_uid(12345)
if flock_type:
    # Access node properties
    print(f"Flock type name: {flock_type.get('name')}")

Best Practices

• Ensure the run_query function is properly implemented with error handling and connection management
• Validate the uid parameter before passing it to prevent injection attacks or invalid queries
• Consider adding type hints to the function signature for better code documentation
• Handle the None return value appropriately in calling code to avoid AttributeError
• Ensure proper Neo4j connection pooling and resource cleanup in the run_query implementation
• Consider adding logging for debugging purposes when nodes are not found
• The UID property should be indexed in Neo4j for optimal query performance

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function get_dbo_flocks_by_uid 91.3% similar

  Retrieves a single dbo_Flocks node from a Neo4j graph database by matching its unique identifier (UID).

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

• function get_dbo_flocktypes_by_id 90.5% similar

  Retrieves a single dbo_FlockTypes node from a Neo4j graph database by its unique ID using a Cypher query.

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

• function get_dbo_flocks_by_id 81.2% similar

  Retrieves a single dbo_Flocks node from a Neo4j graph database by its unique ID using a Cypher query.

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

• function get_all_dbo_flocktypes 80.6% similar

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

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

• function get_dbo_flocks_with_references_flocktypes_dbo_flocktypes 79.8% similar

  Queries a Neo4j graph database to retrieve dbo_FlockTypes nodes that are connected to a specific dbo_Flocks node via a REFERENCES_FLOCKTYPES relationship.

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