Skip to content

Module stac_fastapi.sqlalchemy.extensions

sqlalchemy extensions modifications.

Sub-modules

Classes

Operator

class Operator(
    /,
    *args,
    **kwargs
)

Defines the set of operators supported by the API.

Ancestors (in MRO)

  • builtins.str
  • stac_pydantic.utils.AutoValueEnum
  • enum.Enum

Class variables

eq
gt
gte
lt
lte
ne

QueryExtension

class QueryExtension(
    conformance_classes: List[str] = NOTHING,
    schema_href: Optional[str] = None
)

Query Extenson.

Override the POST request model to add validation against supported fields

Ancestors (in MRO)

  • stac_fastapi.extensions.core.query.query.QueryExtension
  • stac_fastapi.types.extension.ApiExtension
  • abc.ABC

Class variables

GET
POST

Methods

get_request_model

def get_request_model(
    self,
    verb: Optional[str] = 'GET'
) -> Optional[pydantic.main.BaseModel]

Return the request model for the extension.method.

The model can differ based on HTTP verb

register

def register(
    self,
    app: fastapi.applications.FastAPI
) -> None

Register the extension with a FastAPI application.

Parameters:

Name Type Description Default
app None target FastAPI application. None

Returns:

Type Description
None None

QueryableTypes

class QueryableTypes(

)

Defines a set of queryable fields.

TODO: Let the user define these in a config file

TODO: There is a much better way of defining this field <> type mapping than two enums with same keys

Class variables

dtype
epsg
gsd
height
maxzoom
minzoom
orientation
width