pixano.app.routers.datasets

get_dataset(id, settings) async

Load dataset from ID.

Parameters:

Name	Type	Description	Default
id	str	Dataset ID to load.	required
settings	Annotated[Settings, Depends(get_settings)]	App settings.	required

Returns:

Type	Description
DatasetModel	Dataset model.

Source code in pixano/app/routers/datasets.py

@router.get("/{id}", response_model=DatasetModel)
async def get_dataset(
    id: str,
    settings: Annotated[Settings, Depends(get_settings)],
) -> DatasetModel:
    """Load dataset from ID.

    Args:
        id: Dataset ID to load.
        settings: App settings.

    Returns:
        Dataset model.
    """
    return DatasetModel.from_dataset(get_dataset_utils(id, settings.library_dir, settings.media_dir))

get_dataset_info(id, settings) async

Load a single dataset information.

Parameters:

Name	Type	Description	Default
id	str	Dataset ID to load info from.	required
settings	Annotated[Settings, Depends(get_settings)]	App settings.	required

Returns:

Type	Description
DatasetInfoModel	The dataset info.

Source code in pixano/app/routers/datasets.py

@router.get("/info/{id}", response_model=DatasetInfoModel)
async def get_dataset_info(
    id: str,
    settings: Annotated[Settings, Depends(get_settings)],
) -> DatasetInfoModel:
    """Load a single dataset information.

    Args:
        id: Dataset ID to load info from.
        settings: App settings.

    Returns:
        The dataset info.
    """
    try:
        info, path = DatasetInfo.load_id(id, settings.library_dir, return_path=True)
    except FileNotFoundError:
        raise HTTPException(
            status_code=404,
            detail=f"Dataset {id} not found in {settings.library_dir.absolute()}.",
        )

    return DatasetInfoModel.from_dataset_info(info, path)

get_datasets_info(settings) async

Load a list of dataset information.

Parameters:

Name	Type	Description	Default
settings	Annotated[Settings, Depends(get_settings)]	App settings.	required

Returns:

Type	Description
list[DatasetInfoModel]	List of dataset info.

Source code in pixano/app/routers/datasets.py

@router.get("/info", response_model=list[DatasetInfoModel])
async def get_datasets_info(
    settings: Annotated[Settings, Depends(get_settings)],
) -> list[DatasetInfoModel]:
    """Load a list of dataset information.

    Args:
        settings: App settings.

    Returns:
        List of dataset info.
    """
    try:
        infos_and_paths: list[tuple[DatasetInfo, Path]] = DatasetInfo.load_directory(
            directory=settings.library_dir, return_path=True
        )
    except FileNotFoundError:
        raise HTTPException(
            status_code=404,
            detail=f"No datasets found in {settings.library_dir.absolute()}.",
        )

    if len(infos_and_paths) > 0:
        return [DatasetInfoModel.from_dataset_info(info, path) for info, path in infos_and_paths]
    raise HTTPException(
        status_code=404,
        detail=f"No datasets found in {settings.library_dir.absolute()}.",
    )

get_table_count(id, table, settings) async

Get the number of rows in a table.

Parameters:

Name	Type	Description	Default
id	str	Dataset ID containing the table.	required
table	str	Table name.	required
settings	Annotated[Settings, Depends(get_settings)]	App settings.	required

Returns:

Type	Description
int	The number of rows in the table.

Source code in pixano/app/routers/datasets.py

@router.get("/{id}/{table}/count", response_model=int)
async def get_table_count(
    id: str,
    table: str,
    settings: Annotated[Settings, Depends(get_settings)],
) -> int:
    """Get the number of rows in a table.

    Args:
        id: Dataset ID containing the table.
        table: Table name.
        settings: App settings.

    Returns:
        The number of rows in the table.
    """
    dataset = get_dataset_utils(id, settings.library_dir, settings.media_dir)
    try:
        db_table = dataset.open_table(table)
    except DatasetAccessError as e:
        raise HTTPException(
            status_code=404,
            detail=str(e),
        )
    return db_table.count_rows()