docs: Documentation update for getting and deleting Data
Updated docs to functions related to getting and deleting Data model objects Docs #COG-334
This commit is contained in:
parent
801efeb1cb
commit
742540929c
4 changed files with 23 additions and 3 deletions
|
|
@ -77,7 +77,7 @@ def get_datasets_router() -> APIRouter:
|
||||||
detail=f"Dataset ({dataset_id}) not found."
|
detail=f"Dataset ({dataset_id}) not found."
|
||||||
)
|
)
|
||||||
|
|
||||||
data = await get_data(user.id, data_id)
|
data = await get_data(data_id)
|
||||||
|
|
||||||
if data is None:
|
if data is None:
|
||||||
raise HTTPException(
|
raise HTTPException(
|
||||||
|
|
|
||||||
|
|
@ -3,6 +3,17 @@ from cognee.infrastructure.databases.relational import get_relational_engine
|
||||||
|
|
||||||
|
|
||||||
async def delete_data(data: Data):
|
async def delete_data(data: Data):
|
||||||
|
"""Delete a data record from the database.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
data (Data): The data object to be deleted.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: If the data object is invalid.
|
||||||
|
"""
|
||||||
|
if not hasattr(data, '__tablename__'):
|
||||||
|
raise ValueError("The provided data object is missing the required '__tablename__' attribute.")
|
||||||
|
|
||||||
db_engine = get_relational_engine()
|
db_engine = get_relational_engine()
|
||||||
|
|
||||||
return await db_engine.delete_data_by_id(data.__tablename__, data.id)
|
return await db_engine.delete_data_by_id(data.__tablename__, data.id)
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,15 @@ from typing import Optional
|
||||||
from cognee.infrastructure.databases.relational import get_relational_engine
|
from cognee.infrastructure.databases.relational import get_relational_engine
|
||||||
from ..models import Data
|
from ..models import Data
|
||||||
|
|
||||||
async def get_data(user_id: UUID, data_id: UUID) -> Optional[Data]:
|
async def get_data(data_id: UUID) -> Optional[Data]:
|
||||||
|
"""Retrieve data by ID.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
data_id (UUID): ID of the data to retrieve
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Optional[Data]: The requested data object if found, None otherwise
|
||||||
|
"""
|
||||||
db_engine = get_relational_engine()
|
db_engine = get_relational_engine()
|
||||||
|
|
||||||
async with db_engine.get_async_session() as session:
|
async with db_engine.get_async_session() as session:
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,9 @@
|
||||||
|
from typing import Optional
|
||||||
from uuid import UUID
|
from uuid import UUID
|
||||||
from cognee.infrastructure.databases.relational import get_relational_engine
|
from cognee.infrastructure.databases.relational import get_relational_engine
|
||||||
from ..models import Dataset
|
from ..models import Dataset
|
||||||
|
|
||||||
async def get_dataset(user_id: UUID, dataset_id: UUID) -> Dataset:
|
async def get_dataset(user_id: UUID, dataset_id: UUID) -> Optional[Dataset]:
|
||||||
db_engine = get_relational_engine()
|
db_engine = get_relational_engine()
|
||||||
|
|
||||||
async with db_engine.get_async_session() as session:
|
async with db_engine.get_async_session() as session:
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue