Skip to content

query

stac_fastapi.extensions.query.query

Query extension.

QueryConformanceClasses

Bases: StrEnum

Conformance classes for the Query extension.

See stac-api-extensions/query

Source code in stac_fastapi/extensions/stac_fastapi/extensions/query/query.py 
15
16
17
18
19
20
21
22
23
class QueryConformanceClasses(StrEnum):
    """Conformance classes for the Query extension.

    See https://github.com/stac-api-extensions/query
    """

    SEARCH = "https://api.stacspec.org/v1.0.0/item-search#query"
    ITEMS = "https://api.stacspec.org/v1.0.0/ogcapi-features#query"
    COLLECTIONS = "https://api.stacspec.org/v1.0.0-rc.1/collection-search#query"

QueryExtension

Bases: ApiExtension

Query Extension.

The Query extension adds an additional query parameter to /search requests which allows the caller to perform queries against item metadata (ex. find all images with cloud cover less than 15%). stac-api-extensions/query

Source code in stac_fastapi/extensions/stac_fastapi/extensions/query/query.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
@attr.s
class QueryExtension(ApiExtension):
    """Query Extension.

    The Query extension adds an additional `query` parameter to `/search` requests which
    allows the caller to perform queries against item metadata (ex. find all images with
    cloud cover less than 15%).
    https://github.com/stac-api-extensions/query
    """

    GET: type[APIRequest] = QueryExtensionGetRequest
    POST: type[BaseModel] = QueryExtensionPostRequest

    conformance_classes: list[str] = attr.ib(
        factory=lambda: [
            QueryConformanceClasses.SEARCH,
        ]
    )
    schema_href: str | None = attr.ib(default=None)

    def register(self, app: FastAPI) -> None:
        """Register the extension with a FastAPI application.

        Args:
            app: target FastAPI application.

        Returns:
            None
        """
        pass

register 

register(app: FastAPI) -> None

Register the extension with a FastAPI application.

Parameters:

  • app (FastAPI) –

    target FastAPI application.

Returns:

  • None –

    None

Source code in stac_fastapi/extensions/stac_fastapi/extensions/query/query.py 
46
47
48
49
50
51
52
53
54
55
def register(self, app: FastAPI) -> None:
    """Register the extension with a FastAPI application.

    Args:
        app: target FastAPI application.

    Returns:
        None
    """
    pass