Skip to content

Entry collections

EntryCollection (Collection, Generic)

find(self, params)

Fetches results and indicates if more data is available.

Also gives the total number of data available in the absence of page_limit.

Parameters:

Name Type Description Default
params EntryListingQueryParams

entry listing URL query params

required

Returns:

Type Description
Tuple[List[Entry], int, bool, set]

(results, data_returned, more_data_available, fields)

Source code in optimade/server/entry_collections/entry_collections.py
@abstractmethod
def find(
    self, params: EntryListingQueryParams
) -> Tuple[List[EntryResource], int, bool, set]:
    """
    Fetches results and indicates if more data is available.

    Also gives the total number of data available in the absence of page_limit.

    Args:
        params (EntryListingQueryParams): entry listing URL query params

    Returns:
        Tuple[List[Entry], int, bool, set]: (results, data_returned, more_data_available, fields)

    """