185 lines
5.0 KiB
Python
185 lines
5.0 KiB
Python
"""Postgres API configuration."""
|
|
|
|
import warnings
|
|
from typing import Annotated, Any, List, Optional, Type
|
|
from urllib.parse import quote_plus as quote
|
|
|
|
from pydantic import BaseModel, Field, field_validator, model_validator
|
|
from pydantic_settings import BaseSettings, SettingsConfigDict
|
|
from stac_fastapi.types.config import ApiSettings
|
|
|
|
from stac_fastapi.pgstac.types.base_item_cache import (
|
|
BaseItemCache,
|
|
DefaultBaseItemCache,
|
|
)
|
|
|
|
DEFAULT_INVALID_ID_CHARS = [
|
|
":",
|
|
"/",
|
|
"?",
|
|
"#",
|
|
"[",
|
|
"]",
|
|
"@",
|
|
"!",
|
|
"$",
|
|
"&",
|
|
"'",
|
|
"(",
|
|
")",
|
|
"*",
|
|
"+",
|
|
",",
|
|
";",
|
|
"=",
|
|
]
|
|
|
|
|
|
class ServerSettings(BaseModel):
|
|
"""Server runtime parameters.
|
|
|
|
Attributes:
|
|
search_path: Postgres search path. Defaults to "pgstac,public".
|
|
application_name: PgSTAC Application name. Defaults to 'pgstac'.
|
|
"""
|
|
|
|
search_path: str = "pgstac,public"
|
|
application_name: str = "pgstac"
|
|
|
|
model_config = SettingsConfigDict(extra="allow")
|
|
|
|
|
|
class PostgresSettings(BaseSettings):
|
|
"""Postgres-specific API settings.
|
|
|
|
Attributes:
|
|
pguser: postgres username.
|
|
pgpassword: postgres password.
|
|
pghost: hostname for the connection.
|
|
pgport: database port.
|
|
pgdatabase: database name.
|
|
|
|
"""
|
|
|
|
postgres_user: Annotated[
|
|
Optional[str],
|
|
Field(
|
|
deprecated="`postgres_user` is deprecated, please use `pguser`", default=None
|
|
),
|
|
]
|
|
postgres_pass: Annotated[
|
|
Optional[str],
|
|
Field(
|
|
deprecated="`postgres_pass` is deprecated, please use `pgpassword`",
|
|
default=None,
|
|
),
|
|
]
|
|
postgres_host_reader: Annotated[
|
|
Optional[str],
|
|
Field(
|
|
deprecated="`postgres_host_reader` is deprecated, please use `pghost`",
|
|
default=None,
|
|
),
|
|
]
|
|
postgres_host_writer: Annotated[
|
|
Optional[str],
|
|
Field(
|
|
deprecated="`postgres_host_writer` is deprecated, please use `pghost`",
|
|
default=None,
|
|
),
|
|
]
|
|
postgres_port: Annotated[
|
|
Optional[int],
|
|
Field(
|
|
deprecated="`postgres_port` is deprecated, please use `pgport`", default=None
|
|
),
|
|
]
|
|
postgres_dbname: Annotated[
|
|
Optional[str],
|
|
Field(
|
|
deprecated="`postgres_dbname` is deprecated, please use `pgdatabase`",
|
|
default=None,
|
|
),
|
|
]
|
|
|
|
pguser: str
|
|
pgpassword: str
|
|
pghost: str
|
|
pgport: int
|
|
pgdatabase: str
|
|
|
|
db_min_conn_size: int = 1
|
|
db_max_conn_size: int = 10
|
|
db_max_queries: int = 50000
|
|
db_max_inactive_conn_lifetime: float = 300
|
|
|
|
server_settings: ServerSettings = ServerSettings()
|
|
|
|
model_config = {"env_file": ".env", "extra": "ignore"}
|
|
|
|
@model_validator(mode="before")
|
|
@classmethod
|
|
def _pg_settings_compat(cls, data: Any) -> Any:
|
|
if isinstance(data, dict):
|
|
compat = {
|
|
"postgres_user": "pguser",
|
|
"postgres_pass": "pgpassword",
|
|
"postgres_host_reader": "pghost",
|
|
"postgres_host_writer": "pghost",
|
|
"postgres_port": "pgport",
|
|
"postgres_dbname": "pgdatabase",
|
|
}
|
|
for old_key, new_key in compat.items():
|
|
if val := data.get(old_key, None):
|
|
warnings.warn(
|
|
f"`{old_key}` is deprecated, please use `{new_key}`",
|
|
DeprecationWarning,
|
|
stacklevel=1,
|
|
)
|
|
data[new_key] = val
|
|
|
|
if (pgh_reader := data.get("postgres_host_reader")) and (
|
|
pgh_writer := data.get("postgres_host_writer")
|
|
):
|
|
if pgh_reader != pgh_writer:
|
|
raise ValueError(
|
|
"In order to use different host values for reading and writing "
|
|
"you must explicitly provide write_postgres_settings to the connect_to_db function"
|
|
)
|
|
|
|
return data
|
|
|
|
@property
|
|
def connection_string(self):
|
|
"""Create reader psql connection string."""
|
|
return f"postgresql://{self.pguser}:{quote(self.pgpassword)}@{self.pghost}:{self.pgport}/{self.pgdatabase}"
|
|
|
|
|
|
class Settings(ApiSettings):
|
|
"""API settings.
|
|
|
|
Attributes:
|
|
use_api_hydrate: perform hydration of stac items within stac-fastapi.
|
|
invalid_id_chars: list of characters that are not allowed in item or collection ids.
|
|
|
|
"""
|
|
|
|
use_api_hydrate: bool = False
|
|
invalid_id_chars: List[str] = DEFAULT_INVALID_ID_CHARS
|
|
base_item_cache: Type[BaseItemCache] = DefaultBaseItemCache
|
|
|
|
cors_origins: str = "*"
|
|
cors_methods: str = "GET,POST,OPTIONS"
|
|
|
|
testing: bool = False
|
|
|
|
@field_validator("cors_origins")
|
|
def parse_cors_origin(cls, v):
|
|
"""Parse CORS origins."""
|
|
return [origin.strip() for origin in v.split(",")]
|
|
|
|
@field_validator("cors_methods")
|
|
def parse_cors_methods(cls, v):
|
|
"""Parse CORS methods."""
|
|
return [method.strip() for method in v.split(",")]
|