function get_dbo_tnv_by_id
Retrieves a single dbo_TNV node from a Neo4j graph database by matching its unique ID property.
/tf/active/vicechatdev/neo4j_schema/neo4j_python_snippets.py
1045 - 1052
simple
Purpose
This function queries a Neo4j database to fetch a specific dbo_TNV node using its ID. It's designed for retrieving individual records from a graph database where nodes are labeled as 'dbo_TNV'. The function returns the first matching node or None if no match is found, making it useful for lookup operations in graph-based data systems.
Source Code
def get_dbo_tnv_by_id(id):
"""Get a dbo_TNV node by its ID"""
query = """
MATCH (n:dbo_TNV {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 dbo_TNV node to retrieve. This should match the 'id' property stored on the node in the Neo4j database. The type is not explicitly constrained but typically would be a string or integer depending on how IDs are stored in the database.
Return Value
Returns the first dbo_TNV node object that matches the provided ID if found, or None if no matching node exists. The node object is returned as a Neo4j node record containing all properties of the matched node. The return type is either a Neo4j node object or None.
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
node = get_dbo_tnv_by_id('12345')
if node:
print(f'Found node: {node}')
else:
print('Node not found')
Best Practices
- Ensure the run_query function is properly defined and handles Neo4j 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
- The function assumes run_query returns a list; ensure this contract is maintained
- Consider adding type hints for better code documentation (e.g., def get_dbo_tnv_by_id(id: str) -> Optional[Node])
- Ensure proper indexing on the 'id' property in Neo4j for optimal query performance
- Always check if the return value is None before accessing node properties to avoid AttributeError
Similar Components
AI-powered semantic similarity - components with related functionality:
-
function get_dbo_tnv_by_uid 90.9% similar
-
function get_all_dbo_tnv 83.2% similar
-
function get_dbo_treatments_by_id 77.1% similar
-
function get_dbo_product_by_id 76.2% similar
-
function get_dbo_concepts_by_id 74.6% similar