Skip to content

databases

/databases/*

This file describes the router for:

/databases/{id}

where, id may be left out.

Database resources represent the available databases that may be used for the gateways.

One can register a new database (by using POST /databases) or look through the available databases (by using GET /databases) using standard OPTIMADE filtering.

get_database(request, database_id, params=Depends(NoneType)) async

GET /databases/{database ID}

Return a single LinksResource representing the database resource object with id={database ID}.

Source code in optimade_gateway/routers/databases.py 
@ROUTER.get(
    "/databases/{database_id:path}",
    response_model=DatabasesResponseSingle,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    response_model_exclude_unset=True,
    tags=["Databases"],
    responses=ERROR_RESPONSES,
)
async def get_database(
    request: Request,
    database_id: str,
    params: SingleEntryQueryParams = Depends(),
) -> DatabasesResponseSingle:
    """`GET /databases/{database ID}`

    Return a single
    [`LinksResource`](https://www.optimade.org/optimade-python-tools/api_reference/models/links/#optimade.models.links.LinksResource)
    representing the database resource object with `id={database ID}`.
    """
    collection = await collection_factory(CONFIG.databases_collection)

    params.filter = f'id="{database_id}"'
    (
        result,
        data_returned,
        more_data_available,
        fields,
        include_fields,
    ) = await collection.afind(params=params)

    if fields or include_fields and result is not None:
        result = handle_response_fields(result, fields, include_fields)

    result = result[0] if isinstance(result, list) and data_returned else None

    return DatabasesResponseSingle(
        links=ToplevelLinks(next=None),
        data=result,
        meta=meta_values(
            url=request.url,
            data_returned=data_returned,
            data_available=await collection.acount(),
            more_data_available=more_data_available,
        ),
    )

get_databases(request, params=Depends(NoneType)) async

GET /databases

Return overview of all (active) databases.

Source code in optimade_gateway/routers/databases.py 
@ROUTER.get(
    "/databases",
    response_model=DatabasesResponse,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    response_model_exclude_unset=True,
    tags=["Databases"],
    responses=ERROR_RESPONSES,
)
async def get_databases(
    request: Request,
    params: EntryListingQueryParams = Depends(),
) -> DatabasesResponse:
    """`GET /databases`

    Return overview of all (active) databases.
    """
    return await get_entries(
        collection=await collection_factory(CONFIG.databases_collection),
        response_cls=DatabasesResponse,
        request=request,
        params=params,
    )

post_databases(request, database) async

POST /databases

Create/Register or return an existing LinksResource, representing a database resource object, according to database.

Source code in optimade_gateway/routers/databases.py 
@ROUTER.post(
    "/databases",
    response_model=DatabasesResponseSingle,
    response_model_exclude_defaults=False,
    response_model_exclude_none=False,
    response_model_exclude_unset=True,
    tags=["Databases"],
    responses=ERROR_RESPONSES,
)
async def post_databases(
    request: Request, database: DatabaseCreate
) -> DatabasesResponseSingle:
    """`POST /databases`

    Create/Register or return an existing
    [`LinksResource`](https://www.optimade.org/optimade-python-tools/api_reference/models/links/#optimade.models.links.LinksResource),
    representing a database resource object, according to `database`.
    """
    result, created = await resource_factory(database)
    collection = await collection_factory(CONFIG.databases_collection)

    return DatabasesResponseSingle(
        links=ToplevelLinks(next=None),
        data=result,
        meta=meta_values(
            url=request.url,
            data_returned=1,
            data_available=await collection.acount(),
            more_data_available=False,
            **{f"_{CONFIG.provider.prefix}_created": created},
        ),
    )
Back to top